API Overview

The Sapt REST API gives you direct HTTP access to Projects, agents, memory, actions, and everything else in the workspace for that Project. Prefer to connect Claude or ChatGPT? See the MCP Connector.

Base URL

https://api.sapt.ai

Authentication

All requests require an API key in the Authorization header:

Authorization: ApiKey sapt_...

Create API keys under Account > API Keys in the Sapt dashboard. See Authentication for the steps and the other ways to sign in.

Content type

Request and response bodies use JSON, except media uploads, which take raw bytes:

Content-Type: application/json

Error responses

Errors return a structured envelope. code is machine-readable, message is human-readable, and details is present for field-level validation errors or additional context.

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Field 'name' is required",
    "details": { "issues": [{ "path": "name", "code": "invalid_type", "message": "Required" }] }
  }
}

See Errors for every code.

Endpoint reference

Every public endpoint is auto-generated from the live OpenAPI spec. Browse them under Reference.

Reading the reference

A few fields are free-form JSON: their exact shape depends on the resource, so the reference shows them as an open object rather than a fixed schema. The most common ones:

Field	Where	What it holds
`bundle`	Project templates	The full saved configuration a template applies (roles, workflows, CRM types, sidebar). Its structure is documented in Project templates & the bundle.
`actions`, `steps`	Workflows	The ordered work a workflow runs; each entry’s shape depends on its action type.
`data`	Object records	The CRM record’s values, keyed by the fields of its object type.
`metadata`	Assets, scheduled jobs	Caller-supplied key/value details attached to the resource.

If a field shows up as an open or “unknown” object, treat it as JSON whose keys depend on the specific resource, not as a typo or a missing type.

Status codes

Code	Meaning
`200`	OK
`201`	Created
`202`	Accepted (queued for delivery)
`400`	Bad Request: invalid input
`401`	Unauthorized: missing or invalid API key
`403`	Forbidden: valid key, but no permission on this project
`404`	Not Found
`429`	Rate Limited: back off and retry
`500`	Internal Error

Example request

curl https://api.sapt.ai/projects/{projectId}/agents \
  -H "Authorization: ApiKey sapt_..." \
  -H "Content-Type: application/json"

Start with the API

Platform

Social publishing

Analytics

REST API guides

MCP connector

API Overview

Base URL

Authentication

Content type

Error responses

Endpoint reference

Reading the reference

Status codes

Example request

​Base URL

​Authentication

​Content type

​Error responses

​Endpoint reference

​Reading the reference

​Status codes

​Example request

Base URL

Authentication

Content type

Error responses

Endpoint reference

Reading the reference

Status codes

Example request