API Overview - Slate Documentation

The Slate API lets you integrate Slate features into your own applications and automation pipelines. Use it to trigger workflow runs, manage spreadsheet data, and pull analytics from AEO Tracker.

Base URL

All API requests use the following base URL:

https://api.slatehq.ai

Each service has its own path prefix:

Service	Path prefix
Workflows	`/workflow-service/api/public/v1/`
Sheets	`/sheet-service/api/public/v1/`
AEO Tracker	`/ai-analytics-service/api/public/v1/`
Pages, Actions & Content Updates	`/slate-core/api/public/v1/`

Authentication

Every request requires a Bearer token in the Authorization header:

Authorization: Bearer slat_<your-token>

Generate tokens from Workspace settings → API tokens in Slate. See Authentication for step-by-step instructions.

Request format

Send request bodies as JSON with the Content-Type: application/json header.
Pass path parameters directly in the URL (for example, /workflows/{workflowId}/runs).
Pass query parameters as standard URL query strings.

Response format

Successful responses return JSON. For example, creating a workflow run returns:

{
  "run_id": "8c5e0f8a-2b35-4c1f-9b6a-9d0a6b3c1f4e",
  "status": "QUEUED",
  "workspace_id": 1234,
  "workflow_execution_id": null,
  "status_url": "/workflow-service/api/public/v1/workflow-runs/8c5e0f8a-2b35-4c1f-9b6a-9d0a6b3c1f4e"
}

Authentication errors return a plain-text body (unauthorized or forbidden). Most other errors return JSON with an error field:

{
  "error": "Too many concurrent runs"
}

See Errors for every status code and error format.

Available APIs

API	Description
Workflows	List and inspect workflows, trigger runs, poll for status, and cancel queued runs.
Sheets	Create and manage spreadsheets, columns, and rows.
AEO Tracker	Manage prompts, query runs, analytics, sentiment, and topics.
Pages	Create, list, and delete pages.
Actions	Create, update, and comment on actions.
Content Updates	Record that a page was published or refreshed.

Reference pages for the Sheets, Pages, and Actions APIs aren’t published yet.

Limits

Each API token can have up to 3 workflow runs queued or running at once. A new run beyond that returns 429. See Errors.

Quick start

Create an API token in your workspace settings.
Make your first API call:

curl -s -X POST "https://api.slatehq.ai/workflow-service/api/public/v1/workflows/wf_abc123/runs" \
  -H "Authorization: Bearer slat_YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data-raw '{
    "inputs": {
      "brandDomain": "example.com"
    }
  }'

import requests

response = requests.post(
    "https://api.slatehq.ai/workflow-service/api/public/v1/workflows/wf_abc123/runs",
    headers={
        "Authorization": "Bearer slat_YOUR_TOKEN",
        "Content-Type": "application/json",
    },
    json={
        "inputs": {
            "brandDomain": "example.com",
        }
    },
)
run = response.json()

const response = await fetch(
  "https://api.slatehq.ai/workflow-service/api/public/v1/workflows/wf_abc123/runs",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer slat_YOUR_TOKEN",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      inputs: {
        brandDomain: "example.com",
      },
    }),
  }
);
const run = await response.json();

Check the run status using the run_id from the response.

What’s next

Authentication — Create and manage API tokens.
Errors — Understand error responses and status codes.
Create Workflow Run — Trigger your first workflow.

​Base URL

​Authentication

​Request format

​Response format

​Available APIs

​Limits

​Quick start

​What’s next

Base URL

Authentication

Request format

Response format

Available APIs

Limits

Quick start

What’s next