Overview

The TeamMate public API lets you manage your workspace programmatically — the same agents, knowledge bases, and models you use in the app, exposed as a REST API.

Base URL

https://tmmate.ai/api/v1

The API is versioned in the path (/v1). Everything below is relative to that base.

What you can do

• Agents — create, read, update, and delete agents (model, instructions, tools, knowledge, features, triggers). See Agents API.
• Knowledge bases — create knowledge bases from text, websites, or files; then run semantic search and RAG question-answering. See Knowledge bases API.
• Capabilities — discover the models, tools, knowledge bases, and embedding model available in your workspace, so you can pass valid IDs when creating agents. See Capabilities API.

Authentication in one line

Send a workspace API key (sk_prod_…) as a Bearer token:

Authorization: Bearer sk_prod_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Creating a key requires the admin role. Full details: Authentication & API keys.

Your first request

List the models available in your workspace — a quick way to confirm your key works:

curl https://tmmate.ai/api/v1/capabilities/models \
  -H "Authorization: Bearer sk_prod_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

A successful response is JSON wrapped in a data envelope:

{
  "data": [
    {
      "id": "openai/gpt-4.1-mini",
      "name": "GPT-4.1 mini",
      "provider": "OPENAI",
      "providerConnected": true,
      "hasReasoning": false,
      "description": "Fast, low-cost model for everyday tasks"
    }
  ]
}

Conventions at a glance

• Envelope — every success response is { "data": ... }.
• Errors — { "error": string, "code": string, "details"?: unknown } with a matching HTTP status.
• Content type — application/json everywhere except file upload (multipart/form-data).
• Versioning — path-based (/api/v1); the current OpenAPI document version is 1.1.0.

Full details on the Requests, responses & errors page.

Interactive explorer

• Try it in the browser (Scalar): https://tmmate.ai/api/v1/docs
• OpenAPI 3.1 spec: https://tmmate.ai/api/v1/openapi.json

Want an AI assistant to write the integration for you? See Connect Claude, Codex & MCP.