API Overview

The Syntext API provides programmatic access to manage documentation projects, trigger builds, configure search, and more.

Base URL

https://api.syntext.dev/v1

Authentication

All API requests require authentication via API key:

curl https://api.syntext.dev/v1/projects \
  -H "Authorization: Bearer stx_abc12345_your_api_key"

API keys look like stx_{prefix}_{secret} and support scopes (full, build, read) — see API Keys. Create keys from the dashboard or the API.

Request Format

• Content-Type: application/json
• Accept: application/json

curl -X POST https://api.syntext.dev/v1/projects \
  -H "Authorization: Bearer stx_abc12345_..." \
  -H "Content-Type: application/json" \
  -d '{"name": "My Docs"}'

Response Format

All responses return JSON with consistent structure:

Success Response

{
  "data": {
    "id": "prj_abc123",
    "name": "My Docs"
  }
}

List Response

{
  "data": [
    { "id": "prj_abc123", "name": "My Docs" },
    { "id": "prj_def456", "name": "API Docs" }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20
  }
}

See Pagination for details.

Error Response

{
  "error": {
    "code": "invalid_request",
    "message": "The 'name' field is required",
    "details": {
      "field": "name",
      "reason": "required"
    }
  }
}

Error Codes

See Errors for the full reference and retry guidance, and Rate Limits for limit behavior.

API Surface

Rate Limiting

Rate limit headers are included in all responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 995
X-RateLimit-Reset: 1705312800

Pagination

List endpoints support pagination:

curl "https://api.syntext.dev/v1/projects?page=2&per_page=50"

Idempotency

For POST requests, use the Idempotency-Key header to safely retry:

curl -X POST https://api.syntext.dev/v1/builds \
  -H "Authorization: Bearer stx_abc12345_..." \
  -H "Idempotency-Key: unique-request-id-123" \
  -d '{"project_id": "prj_abc123"}'

Retrying with the same key returns the original response.

SDKs

Official SDKs for common languages:

API Resources