Introduction
Our RESTful API is designed to be simple, efficient, and developer-friendly. This guide will help you quickly understand how to start integrating our services into your applications using standard HTTP conventions.Simple API Requests
Our API uses only the two most common HTTP methods:GET
: Retrieve data from the serverPOST
: Send data to the server
We deliberately keep the surface area small; no
PUT
, PATCH
, or DELETE
to worry about.Key Concepts
Essential Headers
Essential Headers
All requests should include these headers:
Content-Type
:application/json
Authorization
:Bearer {api_key}
Authentication
Authentication
Interacting with the API requires a Bearer token:You can generate API keys from your organization settings. Tokens are tied to your organization and rate-limited per key.
Formatting Requests
Formatting Requests
- For
GET
requests, include data as query parameters:
- For
POST
requests, send data as JSON:
All responses also include meaningful HTTP status codes (
200
, 400
, 403
, 429
).Rate Limiting
Rate Limiting
The API enforces limits per organization and API key. Exceeding the limit returns a
429 Too Many Requests
response. Rate limits reset automatically after a short cooldown.