API Reference

A concise index of the main API services and endpoints.

This page is a quick index of the most-used endpoints. For auth, pagination, and error formats, use the dedicated guides in this section.

Most endpoints require either x-api-key (workspace API key) or Authorization: Bearer ….

System (/v1/system)

  • GET /v1/system/health
  • GET /v1/system/workspaces
  • GET /v1/system/workspace/variables
  • POST /v1/system/workspace/variables

Auth (/v1/auth)

  • POST /v1/auth/token
  • GET /v1/auth/me
  • POST /v1/auth/api-key
  • GET /v1/auth/api-key
  • DELETE /v1/auth/api-key/{key_id}

Data (/v1/data)

  • GET /v1/data/health
  • GET /v1/data/sources
  • POST /v1/data/sources
  • GET /v1/data/sources/{data_source_id}
  • POST /v1/data/sources/{data_source_id}/sync/start

Integrations (/v1/integrations)

  • GET /v1/integrations/integrations
  • POST /v1/integrations/integrations
  • PATCH /v1/integrations/integrations/{integration_id}
  • DELETE /v1/integrations/integrations/{integration_id}

Agents (/v1/agents)

  • GET /v1/agents/health
  • GET /v1/agents/blueprint
  • POST /v1/agents/blueprint
  • GET /v1/agents/agents
  • POST /v1/agents/agents

AI (/v1/ai)

  • POST /v1/ai/agents/{agent_id}/run
  • POST /v1/ai/chat

Webhooks (/v1/webhooks)

  • GET /v1/webhooks/webhooks
  • POST /v1/webhooks/webhooks
  • PATCH /v1/webhooks/webhooks/{webhook_id}
  • DELETE /v1/webhooks/webhooks/{webhook_id}

Audit (/v1/audit)

  • GET /v1/audit/logs
  • GET /v1/audit/docs

Solutions (/v1/solutions)

  • GET /v1/solutions/workplace/forecast/runs

MCP (/api/v1/mcp)

  • GET /api/v1/mcp/health
  • POST /api/v1/mcp/mcp