Developer docs, OpenAPI operation ids and machine-readable twins
New /docs site generated from the OpenAPI spec, operationIds on every operation, x-scopes and x-webhooks in the spec, markdown twins and llms.txt.
What changed
- A docs site at
/docs. Concepts, guides, compliance notes and a reference page per endpoint, all rendered fromdocs/**and the OpenAPI spec. Signed-in readers see their own sandbox key in every sample and can run requests from the page. - Every operation has an
operationId(triggerWorkflow,getExecution, …). The id is the slug of the operation's reference page and the name the MCP manifest and code samples use. - Scopes, idempotency and polling are declared in the spec as
x-scopes,x-idempotentandx-async, and rendered as badges. The nine operations the MCP server wraps carryx-mcpwith the tool definition. - Webhook events are in the spec under a root
x-webhookskey shaped like OpenAPI 3.1webhooks, one entry per event with its payload schema and an example. They render under /docs/api/webhooks. - The spec documents what the API does today: the previously missing
POST /workflows,PATCH/DELETE /workflows/{id},POST /workflows/generateandGET /workflows/{id}/test_cases;422 missing_idempotency_key;429with the JSON envelope andRetry-After;adverse_action.retry_scheduled; the split betweenExecutionandExecutionFull. - Machine-readable twins. Append
.mdto any docs URL or sendAccept: text/markdownfor clean markdown;/openapi.jsonand/openapi.yamlserve the spec;/llms.txtindexes the site for agents. - Error responses carry
doc_urlpointing at/docs/api/errors/<code>.
What you may need to do
Nothing changes in request or response bodies. If you generate a client from the spec, regenerate it to pick up the operation ids — method names will change from generated defaults to the documented ids.