Spring til indhold

SDK

Styr OpenCode fra dine egne scripts, CI-jobs og værktøjer. SDK'et kører OpenCode i din egen proces med din konfiguration og dine modeller, og dets typede klient opretter sessioner, sender prompts og streamer alle events.

Funktioner

Ret CI fra kode

Et kort script beder OpenCode rette fejlende tests og kører dem så igen.

Følg hvert trin

Stream events for at se hvert værktøj, agenten kalder, mens det sker.

Byg egne værktøjer

Kobl OpenCode på bots, dashboards og workflows med få linjer.

I din proces

Kører OpenCode i din proces med din konfiguration og dine modeller.

  • TypeScript-klientTypede requests og events med de samme værdier som @opencode/client.
  • Sessioner fra kodeOpret sessioner og send prompts fra ethvert script.
  • Enhver modelBruger de modeller, din OpenCode-opsætning har.
  • npm eller bunInstaller det med npm i @opencode/sdk eller bun add @opencode/sdk.
  • In-process-hostKører OpenCode i hukommelsen uden netværkshop.
  • Dine pluginsGiv dine egne plugins med, når du opretter in-process-hosten.
  • Promise eller EffectEn Promise-API og en Effect-API med de samme værdier.
  • Cloudflare WorkersKør OpenCode i et Cloudflare Durable Object på Workers.

  • npmnpm i @opencode/sdk
  • bunbun add @opencode/sdk
Læs SDK-dokumentationen

Changelog

  1. v2.2.4

    Publish Interactive Artifacts

    Enable "experimental": { "artifacts": true } in opencode.json to let agents publish, update, and serve HTML or static artifacts through the built-in local provider or plugin-provided storage.#60351

    Forbedringer

    • SDKExtended client.experimental.persistentPty.update to rename terminals or clear a user title, and exposed userTitle plus persistent-pty.updated events.#60329
  2. v2.2.3

    Added lazy loading for stored image references when experimental.media_blob is enabled

    Added lazy loading for stored image references when experimental.media_blob is enabled. Images are downloaded only for previews, while undo, revert, fork, and prompt recall restore referenced attachments safely.#60116

    Forbedringer

    • SDKPreserved partial LLMResponse output on AIError.partial when generation, object generation, or a tool loop fails.#60477
    • SDKUnified Effect and Promise tool declarations around tool(...), with optional output schemas and executable or declaration-only tools.#60407
    • SDKAdded typed OpenRouter debug, models, plugins, provider, and user options to the Responses route.#60044

    Rettelser

    • SDKMatched the Promise AI client more closely to the Effect API and accepted typed tools in loops.#60465#60390
    • SDKKept tools whose execute handler can throw available to the AI client.#60431
    • SDKContinued polling queued media generations when providers return unknown intermediate statuses.#59988
    • SDKStopped sending an incompatible filename alongside file_url on OpenAI Responses requests.#60382
  3. v2.2.2

    Exposed SessionInfo.time.busy for the latest execution’s start time

    Forbedringer

    • SDKAdded if and until inputs for client.experimental.schedule.create, plus schedule check results and output fields.#60137
    • SDKAdded optional source metadata to prompt file attachments.
Se alle opdateringer