Skip to main content
The REST API is for your own code: an agent you build, a workflow, a service. Each tool is one HTTP call under your API key.

The tool list is JSON Schema

GET /api/v1/tools returns every tool with its description and JSON Schema input, the shape a model accepts as tool definitions. An agent built on any model SDK can pass it that list and route each call the model makes to POST /tools/{name}. Adding ?instructions=cloud includes the operating instructions an MCP agent receives, so an agent without an MCP client reads the same rules. The OpenAPI document behind the API reference describes every route, and you can generate a client from it. Beside the tools, the API has routes for keys, workspaces, uploads, webhooks, models, cost estimates and the balance. The balance and cost-estimate routes return the same as get_balance and estimate_cost. GET /models lists image and video models only, and list_models adds voices and the account default. Routes outside /tools return the object itself, and an error as { error: { code, message, status } }. Two tools exist only on the MCP server: get_api_session and show_media. Every other tool is available on every interface with one schema.

Pages

  • Authentication: keys, OAuth tokens, script sessions, choosing a workspace.
  • Calling tools: the request and response envelope, response types, errors, retries, idempotency.
  • Uploads: files in by presigned upload or by URL.
  • Webhooks: job results posted to your URL.
  • Limits: sizes, counts, windows and rates.
  • CLI: the same API from a shell.
  • Examples: three complete exchanges.

Cost

The API itself is free. What a tool costs is charged to the user’s balances, the same on every interface. See Costs.