Optima developer documentation
Record audio, read events, manage endpoints, and connect an MCP client.
Optima turns recorded audio into a searchable timeline of transcript turns. These docs cover two ways to work with an account's data:
- REST API. An authenticated account can upload audio, read its turns, conversations, memories, suggestions, sources, and events, manage memory context, contacts, devices, event endpoints, private files, and workspaces, and report source activity.
- Remote MCP server. Compatible MCP clients can read authorized turns, conversations, memories, suggestions, contacts, sources, and context. Separate write scopes cover feedback, protected suggestion edits, grouping, context changes, and endpoint management.
Base URL and version
| Setting | Value |
|---|---|
| REST base URL | https://api.getoptima.com |
| Version header | X-API-Version: 1 |
| MCP endpoint | https://api.getoptima.com/mcp |
Account routes have no /user or /v1 path prefix. Send X-API-Version: 1 on REST requests to pin this contract.
Where to start
| If you want to | Read |
|---|---|
| Sign in and make a first account request | Quickstart |
| Add Optima to Claude Code or Codex | Claude Code · Codex |
| Understand sessions, refresh, and sign-out | Authentication |
| Learn the response envelope, errors, and pagination | API conventions |
| See how sources, streams, turns, speakers, and contacts relate | Data model |
| Create and share workspaces, manage members, and invite people | Workspaces |
| Bind a device to an account and connect its firmware | Devices |
| Upload audio through sources, streams, chunks, and confirmation | Audio uploads |
| Store and download small private files | Private files |
| Report and read which sources are online or listening | Source activity |
| Read turns and control attribution and assignment | Turns and contacts |
| Browse episodes, suggestions, and memory context | Conversations and suggestions |
| Connect an MCP client and review its permissions and tools | MCP |
References
- The API reference lists request and response schemas for every public route.
- The MCP tool reference lists the input and output schemas for each MCP tool.