Skip to main content

Documentation Index

Fetch the complete documentation index at: https://slatehq.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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:
ServicePath prefix
Workflows/workflow-service/api/public/v1/
Sheets/sheet-service/api/public/v1/
AEO Tracker/ai-analytics-service/api/public/v1/
Pages & Actions/slate-core/api/public/v1/

Authentication

Every request requires a Bearer token in the Authorization header:
Authorization: Bearer slat_<your-token>
Generate tokens from Settings > API Tokens in the Slate dashboard. 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

All responses return JSON. A successful response typically looks like:
{
  "run_id": "8c5e0f8a-2b35-4c1f-9b6a-9d0a6b3c1f4e",
  "status": "QUEUED",
  "created_at": "2026-01-27T01:23:45Z"
}
Error responses include an error field:
{
  "error": "Missing Authorization bearer token"
}
See Errors for the full list of error codes.

Available APIs

APIDescription
WorkflowsList and inspect workflows, trigger runs, poll for status, and cancel queued runs.
SheetsCreate and manage spreadsheets, columns, and rows.
AEO TrackerManage prompts, query runs, analytics, sentiment, and topics.
PagesCreate, list, and delete pages.
ActionsCreate, update, and comment on actions.

Quick start

  1. Create an API token in your workspace settings.
  2. 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"
    }
  }'
  1. Check the run status using the run_id from the response.

What’s next