Platform REST API overview
Beyond the conversational surfaces (OpenAI-compatible API
and MCP servers), Octo’s dashboard itself runs on a full REST
API under /api/*. This is the same API the web dashboard calls — it’s
available for advanced integrations that need direct, structured access to
workspace resources rather than a conversational interface.
What’s in it
Section titled “What’s in it”The platform API covers the full range of dashboard resources, including:
- Agents — configuration and deployment of your workspace’s agents.
- Campaigns — creating, running, and inspecting outbound campaigns.
- Contacts & contact lists — the workspace’s contact data.
- Conversations — chat/email/voice conversation history and detail.
- Voice — call records, voice campaigns, and related resources.
- Phone numbers — search available inventory, provision managed numbers (priced in credits), and manage per-number sending limits.
- Billing — spend, usage, and workspace plan information.
This is intentionally the “advanced” surface: if you just want to have Octo do something in natural language, the OpenAI-compatible API or an MCP server is almost always the simpler integration point. Reach for the platform API when you need to read or write a specific resource directly — for example, syncing contact lists from an external CRM, or building a custom reporting dashboard over conversation data.
Authentication
Section titled “Authentication”The platform API accepts either of the following, same as the rest of the dashboard:
- An authenticated workspace dashboard session (cookie-based, for browser-driven use).
- A workspace API key (
Authorization: Bearer sk-octo_...) — the same kind of key used by the OpenAI-compatible API and MCP servers. See Get an API key and Authentication for how a key’s role scopes what it can do.
Reference
Section titled “Reference”For the full list of resources and operations, use the interactive reference: Platform API reference.