API Reference

Comprehensive reference for our REST API endpoints, payloads, and error codes.

Our API follows REST conventions with JSON bodies. Authenticate requests using an API key in the Authorization: Bearer <key> header. Below are example endpoint summaries to get you started.

Authentication

Use your dashboard to generate an API key. Keep keys secret and rotate them periodically. For server-to-server calls, store keys in environment variables.

Example: Create Project

POST /api/projects
{
  "name": "My Project",
  "owner_id": "12345"
}

Error Codes

Common responses include 400 for validation errors, 401 for unauthorized requests, and 429 for rate limits. Error bodies include a descriptive message field.

For full, versioned documentation and code samples, export SDKs, and changelogs, check back here or contact support for early access.