Developers / Registry
API Registry.
The machine-readable descriptions of the Dyadic API, the Anthropic-compatible API and the platform API (runs, plans and the Agent Black Box): versions, endpoints, schemas and models.
Loading the API description...
Import
Use the OpenAPI URL in Postman, Insomnia, Bruno, Scalar or any OpenAPI tool, or to generate a client.
https://dyadic.app/api/openai/v1/openapi.jsonCompatibility Contract
What each endpoint applies, limits and refuses, and the OpenAI SDK versions it is tested with, as JSON. Each OpenAPI operation carries the same lists as x-dyadic-* extensions.
Endpoints
| Method | Path | Summary | Operation | Tag |
|---|
Models
Schemas
Versions
| Version | Changes |
|---|---|
1.4.0 | Hosted tools in the Responses API (code_interpreter, shell, file_search, image_generation and remote MCP servers with approvals), each behind its own key switch; containers, vector stores and skills; Iris names for the embedding, speech, transcription and moderation models (iris-embed, iris-voice, iris-transcribe, iris-moderation); speech and transcription tools for runs (contract 1.1.0). |
1.3.0 | An OpenAI-compatible subset with a published contract (/capabilities, contract 1.0.0): fields an endpoint can't honor are refused with unsupported_parameter instead of dropped, and the Response object echoes what ran. Conversations, stored chat completions, background responses with cancel, input token counts, compaction and the Responses WebSocket. Request ids on every response, client request ids, and rate-limit headers. |
1.2.0 | More of OpenAI's API: the Responses API (streaming, stored responses, previous_response_id), embeddings, speech, transcription and translation, moderations, image edits and variations, files with file_id references, and batches. Unsupported families return a clear 404. |
1.1.0 | Every generation setting is applied (sampling, penalties, seed, logit bias, JSON output, logprobs, reasoning effort); tool calls and reasoning stream fragment by fragment; whole conversations are sent; credits settle to the provider's reported cost; OpenAPI description and developer portal. |
1.0.0 | Models, chat completions with streaming and function calling, completions, image generation; API keys with permissions and limits; activity log. |
Platform API
Dyadic's own endpoints, beside the OpenAI-compatible ones: runs of your agents (/runs), plans that wait for approval and are carried out step by step (/plans), and the Agent Black Box (/blackbox). The same key, at https://dyadic.app/api/v1, described in an OpenAPI document of their own. Each capability is a switch on the key, off until you turn it on in the Workspace: plans, blackbox_record, blackbox_write, blackbox_read, blackbox_content and blackbox_manage.
Loading the platform API description...
Import
The platform API's OpenAPI URL, for the same tools. The SDKs cover it too: runs, plans and blackbox.
https://dyadic.app/api/v1/openapi.jsonPlatform Endpoints
| Method | Path | Summary | Operation | Tag |
|---|
Platform Schemas
Platform Versions
| Version | Changes |
|---|---|
1.7.0 | The Black Box as an execution record: a run's actor beside its owner, its costs from the usage ledger (charged, held, reported or estimated) and its links (a batch, plans and steps, re-runs, simulations, each observed); GET /blackbox/runs/{id}/lineage, the file versions a run made with the plan steps under way; the outcome is verification alone (verified, contradicted, unverified, blocked, not_applicable), apart from how the run ended (its status). |
1.6.0 | One trace per turn: every endpoint joins the caller's W3C traceparent, and requests and Black Box runs sharing it are shown as one turn; the SDKs' use_trace() / useTrace() send it with every request. |
1.5.0 | Plans: /plans to make, revise, approve, cancel and follow plans (their history as JSON, or Server-Sent Events that resume from Last-Event-ID) and move steps by hand; runs with plan_mode (investigate and propose; nothing changes) or plan_id (carry out an approved plan), plan.updated run events and plans on the completed run. The key's plans switch. |
1.4.0 | The platform API's own OpenAPI document: runs (POST /runs, naming their Black Box record) and the Agent Black Box (recording, OTLP, runs, live streams, investigation, findings, evidence, privacy, sinks, MCP). |
Anthropic-Compatible API
Anthropic's Messages API on Dyadic: the Anthropic SDKs and Claude Code point at https://dyadic.app/api/anthropic with a Dyadic key. Messages with streaming, tools, thinking and caching; server tools on Dyadic's own; Files and Message Batches.
Loading the Anthropic-compatible API description...
Import
Its OpenAPI URL, for the same tools.
https://dyadic.app/api/anthropic/v1/openapi.jsonAnthropic-Compatible Endpoints
| Method | Path | Summary | Operation | Tag |
|---|
Anthropic-Compatible Schemas
Anthropic-Compatible Versions
| Version | Changes |
|---|---|
1.0.0 | Anthropic's Messages API: streaming, tools, thinking with signatures, prompt caching, structured output, count tokens and models; server tools on Dyadic's own (web search and fetch, code execution, MCP servers); Anthropic's client tools; Files and Message Batches; Anthropic's errors. |
OpenRouter-Compatible Gateway
OpenRouter's API through Dyadic, forwarded unchanged under the key's limits and billing; /key and /credits answered by Dyadic.
Loading the gateway description...
Import
Its OpenAPI URL, for the same tools.
https://dyadic.app/api/openrouter/v1/openapi.jsonGateway Endpoints
| Method | Path | Summary | Operation | Tag |
|---|
Gateway Versions
| Version | Changes |
|---|---|
1.0.0 | At OpenRouter's own address (/api/openrouter/v1, beside /api/gateway/v1), with /key and /credits answered by Dyadic for the key and its account. |
SDKs
Official clients generated around these descriptions: Python and TypeScript. The OpenAI SDKs work for the endpoints and fields in the compatibility contract (tested: Python 3.26.0).