Skip to content
LogoLogo

APIs & SDKs

Which surface do I need?

SurfaceUse it toDocs
Studio APIManage things: agents, knowledge bases, skills, tools, connections, roles, audit, traces.Studio APIs
Public APIRun published agents from any backend over plain REST with an API key: sync, async or streamed.Public API, API keys
MCP serverLet Claude, Cursor or any MCP client find, run and configure your agents, signed in with OAuth.MCP server
Sandbox / runtime APIThe session gateway the Studio chat uses: start a turn, stream the answer, answer an input request, cancel.Sandbox SDK
Loading diagram...

Interactive reference

A live, browsable OpenAPI reference is served by every Studio deployment:

GET  {STUDIO_URL}/api/rpc/api-reference
GET  {STUDIO_URL}/api/rpc/api-reference/spec.json

It is generated from the same schemas the server validates against, so it is never out of date.

Authentication at a glance

CallerCredential
Browser / first-party appSession cookie from sign-in
Server-to-serverStudio API key (studio_...), scoped to one organization. Acts as the person who created it.
MCP clientOAuth 2.1 sign-in, scoped to one organization and the permissions you consent to

Every call is checked twice: your role decides what you may create, and a per-object permission decides what you may reach.

Rules that apply everywhere

  • IDs are UUID v7. Time-ordered, so they also sort chronologically.
  • Lists are cursor-paginated. Pass the last id as cursor; limit is 1 to 100 (default 50).
  • Nothing is hard-deleted. Deletes are soft; the object disappears from reads.
  • Secrets never come back. API keys, OAuth tokens and vault contents are write-only.
  • Sensitive calls are audited, including the ones that are refused.

In this section