API reference
The TeamMate public API is a REST API for building against your workspace programmatically. Create and manage agents, build and query knowledge bases, and discover the models and tools available in your workspace — all with a workspace API key.
Base URL
https://tmmate.ai/api/v1All requests are authenticated with a workspace API key sent as a Bearer token, and all responses are JSON wrapped in a { "data": ... } envelope. See Authentication and Requests, responses & errors.
Start here
| Page | What it covers |
|---|---|
| Overview | What the API does, the base URL, and your first request. |
| Authentication & API keys | Create a key, send the Bearer token, admin vs member access. |
| Requests, responses & errors | The { data } envelope, error format, status codes, pagination. |
| Agents API | Create, read, update, and delete agents. |
| Capabilities API | Discover models, tools, knowledge bases, and the embedding model. |
| Knowledge bases API | Manage knowledge bases, then search and query them with RAG. |
| Connect Claude, Codex & MCP | Point AI tools at these docs and the API. |
Interactive explorer
The API ships a live, auto-generated reference you can call from the browser:
- Interactive docs (Scalar):
https://tmmate.ai/api/v1/docs - OpenAPI 3.1 spec:
https://tmmate.ai/api/v1/openapi.json
Both are public — no key required to read the spec. (The explorer covers the agent, capability, and knowledge-base search/query endpoints; the full knowledge-base management surface is documented in these reference pages.)