Visão geral do SDK da Dropstone
Um cliente TypeScript e JavaScript tipado para o agente da Dropstone, com dois pontos de entrada: um para chamadas de API headless a partir de CI ou uma função serverless, e outro que executa o agente localmente com a mesma memória de conta do CLI e do Chat.
O SDK da Dropstone é um cliente TypeScript e JavaScript tipado para o runtime do agente da Dropstone. Ele dá ao seu código acesso programático ao mesmo agente que roda no Chat da Dropstone e no CLI: sessões, ferramentas, respostas em streaming e saída estruturada.
npm install @blankline/dropstone-sdk
A referência de métodos está em docs.dropstone.io/cli/sdk. Esta página é a visão geral, e Instale e execute sua primeira sessão é o passo a passo.
Dois pontos de entrada
O SDK traz dois clientes, e qual você vai usar é decidido por onde seu código roda.
| Cliente de API headless | Cliente de agente local | |
|---|---|---|
| Importação | createDropstoneApi | createDropstone |
| Fala com | api.dropstone.io/api/v1 | um processo dropstone serve que ele inicia para você |
| Autentica com | uma chave de API | o login do CLI na mesma máquina |
| Cobrança | pagamento por uso do seu saldo de créditos | sua cota semanal, como no CLI |
| Sua memória | Não. É um endpoint de completions sem estado | Sim, a memória de conta que o Chat e o CLI usam |
| Use para | CI, jobs, serverless, qualquer host sem o CLI | incorporar o agente interativo em um app Node |
Dois outros pontos de entrada vêm junto: createDropstoneClient aponta o mesmo cliente tipado para um servidor que você já está rodando, e createDropstoneTui inicia a interface de terminal interativa a partir de um processo Node.
Uma memória, em todos os lugares
Uma sessão local roda como sua conta, então ela começa com tudo o que a Dropstone aprendeu em suas outras superfícies. Uma regra que você define no Chat vale no código que roda pelo SDK, e o que uma sessão registra está lá na próxima vez que você abrir o CLI. Veja Uma memória em todas as superfícies.
O cliente headless é deliberadamente o oposto: um endpoint de completions sem estado e compatível com OpenAI, sem memória anexada, para que um pipeline tenha entrada e saída previsíveis. Veja Usando a API com seu plano.
Tipado de ponta a ponta
Requisições, respostas, eventos de streaming e chamadas de ferramentas são gerados a partir da especificação OpenAPI do servidor, então um editor os completa e um compilador os verifica. Duas superfícies vêm no mesmo pacote: um cliente v1 estável, e um cliente v2 em @blankline/dropstone-sdk/v2 com um modelo de recursos mais rico para arquivos e workspaces. Novos endpoints chegam na v2.
Requisitos
- Node.js
- Para o cliente de agente local, o CLI da Dropstone na mesma máquina, com login feito via
dropstone login - Para o cliente headless, uma chave de API e um saldo de créditos com fundos
Obtendo ajuda
A referência do CLI é o primeiro lugar para dúvidas sobre métodos. Para problemas de conta, cobrança ou acesso, veja Como obter suporte.
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.