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.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.
Base URL
All API requests use the following base URL:| 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 | /slate-core/api/public/v1/ |
Authentication
Every request requires a Bearer token in theAuthorization header:
Request format
- Send request bodies as JSON with the
Content-Type: application/jsonheader. - 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:error field:
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. |
Quick start
- Create an API token in your workspace settings.
- Make your first API call:
- Check the run status using the
run_idfrom 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.