Dropstone SDK
Ein typisierter TypeScript- und JavaScript-Client für den Dropstone-Agenten mit zwei Einstiegspunkten: einer für Headless-API-Aufrufe aus CI oder einer Serverless-Funktion, einer, der den Agenten lokal mit demselben Kontospeicher wie CLI und Chat ausführt.
Das Dropstone SDK ist ein typisierter TypeScript- und JavaScript-Client für die Dropstone-Agentenlaufzeit. Es gibt Ihrem Code programmatischen Zugriff auf denselben Agenten, der in Dropstone Chat und der CLI läuft: Sitzungen, Tools, Streaming-Antworten und strukturierte Ausgaben.
npm install @blankline/dropstone-sdk
Die Methodenreferenz finden Sie unter docs.dropstone.io/cli/sdk. Diese Seite ist die Übersicht, und Installieren und Ausführen Ihrer ersten Sitzung ist die Schritt-für-Schritt-Anleitung.
Zwei Einstiegspunkte
Das SDK enthält zwei Clients, und welchen Sie benötigen, hängt davon ab, wo Ihr Code ausgeführt wird.
| Headless-API-Client | Lokaler Agenten-Client | |
|---|---|---|
| Import | createDropstoneApi | createDropstone |
| Kommuniziert mit | api.dropstone.io/api/v1 | einem dropstone serve-Prozess, den es für Sie startet |
| Authentifiziert sich mit | einem API-Schlüssel | der CLI-Anmeldung auf derselben Maschine |
| Abrechnung | nutzungsbasiert von Ihrem Guthaben | Ihr wöchentliches Kontingent, wie bei der CLI |
| Ihr Speicher | Nein. Es ist ein zustandsloser Completions-Endpunkt | Ja, der Kontospeicher, den Chat und CLI verwenden |
| Verwenden Sie es für | CI, Jobs, Serverless, jeden Host ohne CLI | die Einbettung des interaktiven Agenten in eine Node-App |
Zwei weitere Einstiegspunkte sind enthalten: createDropstoneClient richtet denselben typisierten Client an einen Server, den Sie bereits ausführen, und createDropstoneTui startet die interaktive Terminal-UI aus einem Node-Prozess.
Ein Speicher, überall
Eine lokale Sitzung läuft als Ihr Konto, sodass sie mit allem beginnt, was Dropstone auf Ihren anderen Oberflächen gelernt hat. Eine Regel, die Sie in Chat festlegen, gilt auch für Code, der über das SDK ausgeführt wird, und was eine Sitzung aufzeichnet, ist beim nächsten Öffnen der CLI vorhanden. Siehe Ein Speicher auf jeder Oberfläche.
Der Headless-Client ist bewusst das Gegenteil: ein zustandsloser, OpenAI-kompatibler Completions-Endpunkt ohne angeschlossenen Speicher, sodass eine Pipeline vorhersehbare Eingaben und Ausgaben erhält. Siehe Verwenden der API mit Ihrem Plan.
Durchgängig typisiert
Anfragen, Antworten, Streaming-Ereignisse und Tool-Aufrufe werden aus der OpenAPI-Spezifikation des Servers generiert, sodass ein Editor sie vervollständigt und ein Compiler sie prüft. Zwei Oberflächen sind im selben Paket enthalten: ein stabiler v1-Client und ein v2-Client unter @blankline/dropstone-sdk/v2 mit einem umfangreicheren Ressourcenmodell für Dateien und Arbeitsbereiche. Neue Endpunkte erscheinen auf v2.
Voraussetzungen
- Node.js
- Für den lokalen Agenten-Client: die Dropstone CLI auf derselben Maschine, angemeldet mit
dropstone login - Für den Headless-Client: einen API-Schlüssel und ein aufgeladenes Guthaben
Hilfe erhalten
Die CLI-Referenz ist die erste Anlaufstelle für Fragen auf Methodenebene. Bei Konto-, Abrechnungs- oder Zugriffsproblemen siehe So erhalten Sie Support.
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.