Documentation
Everything you need to ship an API today.
Quickstart
- Create an account and an organization.
- Create a project and paste your Postgres connection string.
- Confirm the tables you want exposed.
- Create an API key and copy it once — it isn't shown again.
- Call your API.
Authentication
Every request is authenticated by an API key sent as a bearer token.
Authorization: Bearer ak_live_a83f9c…
REST reference
List resources with pagination and filtering:
GET /v1/{project}/orders?limit=20&filter[status]=eq.paidGraphQL reference
POST /v1/{project}/graphql
{
orders(where: { status: { eq: "paid" } }, limit: 20) {
id total status customer { name }
}
}Rate limits
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers. Over-limit requests return 429 with a Retry-After header.
Webhooks
Every delivery is signed. Verify by computing HMAC-SHA256 over the raw body with your webhook secret and comparing to the X-Signature header.