Dropstone SDK
Типизированный TypeScript и JavaScript клиент для агента Dropstone, с двумя точками входа: одна для headless API-вызовов из CI или серверной функции, другая запускает агента локально с той же памятью аккаунта, что и CLI и Chat.
Dropstone SDK — это типизированный TypeScript и JavaScript клиент для среды выполнения агента Dropstone. Он предоставляет вашему коду программный доступ к тому же агенту, который работает в Dropstone Chat и CLI: сессии, инструменты, потоковые ответы и структурированный вывод.
npm install @blankline/dropstone-sdk
Справочник методов находится на docs.dropstone.io/cli/sdk. Эта страница — обзор, а Установка и запуск первой сессии — пошаговое руководство.
Две точки входа
SDK поставляется с двумя клиентами, и выбор зависит от того, где выполняется ваш код.
| Headless API клиент | Локальный клиент агента | |
|---|---|---|
| Импорт | createDropstoneApi | createDropstone |
| Взаимодействует с | api.dropstone.io/api/v1 | процессом dropstone serve, который он запускает для вас |
| Аутентификация | API-ключ | вход через CLI на той же машине |
| Оплата | оплата по мере использования с вашего кредитного баланса | ваша недельная квота, как в CLI |
| Ваша память | Нет. Это stateless endpoint для завершений | Да, память аккаунта, которую используют Chat и CLI |
| Используйте для | CI, задачи, serverless, любой хост без CLI | встраивания интерактивного агента в Node-приложение |
В комплекте идут ещё две точки входа: createDropstoneClient направляет тот же типизированный клиент на уже запущенный вами сервер, а createDropstoneTui запускает интерактивный терминальный интерфейс из Node-процесса.
Одна память — везде
Локальная сессия работает от имени вашего аккаунта, поэтому она начинается со всего, что Dropstone узнал на других ваших поверхностях. Правило, заданное в Chat, действует и в коде, работающем через SDK, а то, что записала сессия, будет доступно при следующем открытии CLI. См. Одна память на всех поверхностях.
Headless клиент намеренно противоположен: это stateless, OpenAI-совместимый endpoint для завершений без привязанной памяти, поэтому конвейер получает предсказуемый ввод и вывод. См. Использование API с вашим тарифом.
Типизация от начала до конца
Запросы, ответы, потоковые события и вызовы инструментов генерируются из OpenAPI-спецификации сервера, поэтому редактор дополняет их, а компилятор проверяет. В одном пакете поставляются две поверхности: стабильный v1 клиент и v2 клиент на @blankline/dropstone-sdk/v2 с более богатой моделью ресурсов для файлов и рабочих пространств. Новые endpoint'ы появляются на v2.
Требования
- Node.js
- Для локального клиента агента — Dropstone CLI на той же машине, авторизованный через
dropstone login - Для headless клиента — API-ключ и пополненный кредитный баланс
Получение помощи
Справочник CLI — первая остановка для вопросов на уровне методов. По вопросам аккаунта, оплаты или доступа см. Как получить поддержку.
Related articles
- Install and run your first sessionInstall the Dropstone SDK, make a headless API call with an API key, and run a local agent session that carries your account memory. Includes streaming, structured output, and using the OpenAI SDK against Dropstone.
- Using the API with your planCall Dropstone over HTTP with an API key. The endpoint is OpenAI-compatible, billed pay-per-use from your credit balance, and works from any language. Keys, errors, rate limits, and what the API does not carry.
- One memory across every surfaceThe account memory that follows you across Dropstone Chat, the CLI, and the SDK, what shares it and what does not, and how to keep an integration's learning out of your own memory.
- Install the CLIInstall the Dropstone CLI on macOS, Linux, or Windows with one command, sign in, and check it works. Upgrading and uninstalling.
- Memory across chat, CLI, and SDKDropstone memory belongs to your account, not to one app. A rule you set in the CLI applies in chat, and something learned in chat is available to the SDK. One memory, every surface.