REST API
Everything you need to know before your first integration. The complete endpoint-by-endpoint schema lives in the API Reference.
Base URL and versioning
Code
Public endpoints are versioned under a path prefix, currently /v0/:
Code
v0 reflects a young, evolving surface: it is stable enough to build on, and material changes will be communicated — but pin your integration to the documented request/response shapes rather than incidental behavior.
Authentication
Send an API key from the console as a Bearer token on every request:
Code
Key management, limits, and handling guidance: Authentication.
Request conventions
- Endpoints take a JSON body via POST — including retrieval endpoints, because filter sets are structured objects.
- Timestamps are ISO 8601 UTC (
2026-07-23T14:00:00Z). Every time-aware endpoint follows the same point-in-time semantics: pastend_timestamp= as-of, omitted or future = realtime. - Empty result lists are valid
200responses, not errors. The error contract documents the failure modes worth coding against — including the structured422details designed to be machine-correctable.
Billing
Each billable request deducts from your credit balance, with automatic refunds on failure. Requests exceeding your balance are rejected with 402 before any work runs. Details: Credits & billing.
Schemas
The API Reference is generated from the live OpenAPI schema, and the schema itself is downloadable from the reference page — use it to generate typed clients or feed your agent tooling.
Where the real documentation lives
The reference tells you what each field is; the capability pages tell you how to use each endpoint well — use cases with tested request bodies, filter semantics, pitfalls, and FAQ. Integrating against an endpoint without reading its capability page is the most common way to have a bad first hour with the API.
MCP as an alternative
If your integration target is an agent framework that speaks MCP, consider connecting the MCP server instead of hand-wiring REST calls — same capabilities, same account, with tool schemas delivered to the agent automatically.