API Reference

Base URL

All API requests go to:

https://api.squasher.ai

Ingestion endpoints (sending errors and log drain data) go to:

https://ingest.squasher.ai

Every request requires an API key in the x-squasher-key header:

curl https://api.squasher.ai/v1/projects \
  -H "x-squasher-key: sq_pk_your_key_here"

API keys are scoped per project. You can create and manage them in Dashboard > Settings > API Keys.

Key prefix	Scope	Use case
`sq_pk_`	Ingest + read	SDKs, CLI, read-only dashboards
`sq_sk_`	Full access	Server-side admin, automation

Endpoint	Limit
`POST /v1/ingest/:project_id`	Plan-dependent (5K-2M events/month)
`POST /v1/drain/*`	Unlimited (log drains are not rate-limited)
`GET /v1/*`	100 requests/minute per API key
`POST /v1/*` (mutations)	30 requests/minute per API key

When you exceed a rate limit, you’ll receive a 429 Too Many Requests response with a Retry-After header.

All responses are JSON. Successful responses return the data directly. Errors return:

{
  "error": "Human-readable error message"
}

Code	Meaning
`200`	Success
`201`	Created
`202`	Accepted (ingestion — event queued)
`400`	Bad request (invalid payload)
`401`	Unauthorized (missing or invalid API key)
`403`	Forbidden (API key doesn’t have access to this resource)
`404`	Not found
`429`	Rate limit exceeded
`500`	Internal server error