Base URLs
OpenAPI
The public REST API contract is available as OpenAPI 3.1 JSON.https://api.squasher.ai/ returns a compact JSON index with links to the docs, OpenAPI contract, and hosted MCP endpoint.
See API versioning and deprecation for compatibility rules and the Deprecation and Sunset signals used during a migration.
Authentication
Send your API key in thex-squasher-key header.
Main endpoint families
- Workflow API map
- Ingestion API
- Projects API
- Query Guide API
- Events API, Logs API, Metrics API, and Traces API
- Error groups API, Replays API, and Web Vitals API
- Dashboards API and Observability Summary API
- AI Observability API, Agent Observations API, and Agent Runs API
- Monitors API, Incidents API, Alerts API, and Automations API
- Status Pages API and Subscribers API
- Source Maps API, Log Connectors API, Provider Connections API, Provider Capabilities API, and Integrations API
- GitHub API, Billing API, and API Keys API
For agents
Use the API when you are generating integration code or need stable JSON contracts. Use MCP when the assistant needs live workspace data and can call tools. Use the CLI when a terminal workflow is easier to audit. Agent sequence:- Resolve the project with
GET /v1/projectsorsquasher projects list. - Discover the right query family with
GET /v1/projects/{project_id}/query-guide. - Use bounded
fromandtowindows for telemetry queries. - Prefer summary or inspect endpoints before raw event exports.
- Ask before write, destructive, key rotation, hosted run dispatch, or incident state changes.
Response behavior
Successful responses return JSON unless the operation documents an empty or non-JSON body. Common JSON error responses include a stabletype, code, and safe message. They can also include param, doc_url, and retry_after. Some specialized endpoints still return a legacy error field with optional message and hint fields. The shared OpenAPI error schema documents both forms during this migration.
Interactive OAuth sessions use the named mcp grant published in OpenAPI and the MCP authorization metadata. Workspace membership, project access, and roles still limit every request. API keys use the more specific project scopes documented by the API Keys resource.