Operio Docs
API reference

API Reference

HTTP API for projects, tests, runs, and the rest of the Operio workspace

The Operio HTTP API is the same surface the web app, CLI, and agents use. This reference covers projects and the resources hanging off them: tests, environments, test accounts, mobile builds, runs, and bugs.

Auth, billing, the current account, teams, organizations, invitations, integrations, tags, assets, OAuth, and the hosted MCP server stay in the full spec. They are not duplicated as pages here. For connecting an AI client over MCP, see MCP Server.

Base URL

EnvironmentOrigin
Productionhttps://api.operio.run
Localhttp://localhost:4000

These routes live under /v1. Example: GET https://api.operio.run/v1/projects.

Authentication

Send a bearer token on every route in this reference:

Authorization: Bearer <token>

<token> is either:

  • a session JWT from POST /v1/auth/login, OTP login, or POST /v1/auth/refresh
  • a personal API token from POST /v1/me/api-tokens (the plaintext token starts with op_ and is shown once)

Both use the same header. Create personal tokens from a signed-in session, then use op_... in CI or scripts.

Successful JSON responses wrap the result as { "payload": ... }. Server-sent events for a live run are not wrapped.

OpenAPI spec

The API serves the complete OpenAPI 3 document (every HTTP route, not only this reference):

Each endpoint page includes the method, path, auth, request and response shapes, a curl example, and an interactive playground.

On this page