canonical: https://jentic.com/apis/airbrake.io/airbrake-api

# Airbrake API

Jentic publishes the only available OpenAPI specification for Airbrake API, keeping it validated and agent-ready. Airbrake is an error tracking, performance monitoring, and deploy tracking platform for production applications. This expanded spec exposes 27 endpoints spanning v3 error notice ingestion, v4 project and group management, v5 performance monitoring routes, queue stats, and database query stats. Authentication uses an API key passed as the 'key' query parameter.

## For AI agents

Track errors, post deploys, query performance metrics, and manage source maps for applications monitored by Airbrake.

## Scope

Does not handle log aggregation, infrastructure metrics, or alerting policy management - use for application error tracking, deploys, and route-level performance only.

## Capabilities

- Submit error notices to `/api/v3/projects/{project_id}/notices` for ingestion into the live error stream
- Pull, mute, and delete error groups across projects to triage incidents
- Record deployments with `/api/v4/projects/{project_id}/deploys` to correlate releases with error rates
- Upload and manage source maps so stack traces resolve to original sources
- Report v5 route, queue, and database query performance stats from instrumented services
- Pull project activity feeds and group statistics for dashboard rollups

## Use cases

### Deploy-Error Correlation

Tag every release with a deploy event so spikes in errors are linked back to the change that introduced them. POST `/api/v4/projects/{project_id}/deploys` at the end of every CI release, then surface the activity feed and group stats to engineers reviewing post-deploy health.

Example prompt: Create a deploy on project 12345 with environment production and revision abc123, then list any error groups created in the last 30 minutes

### Source Map Upload Pipeline

Resolve minified JavaScript stack traces back to original source by uploading source maps after every build. POST `/api/v4/projects/{project_id}/sourcemaps` uploads the map, list and delete operations let you prune stale maps as old bundles are replaced.

Example prompt: Upload sourcemap app.min.js.map for project 12345 referencing the bundle URL https://cdn.example.com/app.min.js

### Error Group Triage Dashboard

Build an internal dashboard listing the top error groups across all projects with mute, unmute, and delete actions. GET `/api/v4/groups` returns groups across the account, `/api/v4/projects/{project_id}/groups/{group_id}/stats` provides per-group counts, and PUT `/api/v4/projects/{project_id}/groups/{group_id}/muted` hides resolved noise.

Example prompt: List error groups across all projects, then mute group 999 in project 12345 and record a justification note

### AI Agent Incident Responder

An agent watching Airbrake can ingest new error groups, fetch their stats, summarise the stack trace, and post a release deploy event when a fix ships - all without operator intervention. Through Jentic the API key stays in the vault and only scoped operations are exposed.

Example prompt: Search Jentic for 'list airbrake error groups', load the schema, fetch new groups for project 12345, and mute any group with under 5 occurrences in the last hour

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/v3/projects/{project_id}/notices` | Submit an error notice |
| GET | `/api/v4/projects` | List projects |
| POST | `/api/v4/projects/{project_id}/deploys` | Record a deployment |
| GET | `/api/v4/projects/{project_id}/groups` | List error groups for a project |
| PUT | `/api/v4/projects/{project_id}/groups/{group_id}/muted` | Mute an error group |
| POST | `/api/v4/projects/{project_id}/sourcemaps` | Upload a source map |
| PUT | `/api/v5/projects/{project_id}/routes-stats` | Report route performance stats |

## Key resources

- **Projects** — Monitored applications grouped under an Airbrake account
- **Notices** — Individual error events ingested via the v3 endpoint
- **Groups** — Aggregated error groups with mute, unmute, and delete actions
- **Deploys** — Release events correlated with error rate changes
- **Source Maps** — Source maps for resolving minified stack traces
- **Performance** — Route, queue, and database query performance stats (v5)
- **Activities** — Project-level activity feed for audit and dashboarding

## Why Jentic

- **Setup:** Wiring Airbrake by hand means appending its key as a query parameter, tracking which API version each endpoint lives on across v3 through v5, and writing your own retry logic. Through Jentic you install once, import Airbrake from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Airbrake puts the project id in the URL path (`/projects/{project_id}/deploys`, `/projects/{project_id}/groups`), so a rule can pin your agent to one project. You choose the operations it may call, so muting a group is only included if you add it.
- **Credential handling:** Your Airbrake key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'record an airbrake deploy', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Sentry API** — Error tracking and performance monitoring with broader language SDK support
- **Rollbar API** — Real-time error tracking with deploy correlation and assignment workflows
- **Bugsnag API** — Stability score-driven error monitoring with strong mobile SDK coverage
- **New Relic API** — Full-stack APM that pairs with Airbrake for error-and-metric correlation

## FAQ

### Why is there no official OpenAPI spec for Airbrake API?

Airbrake does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Airbrake API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Airbrake API use?

Airbrake uses an API key passed as the 'key' query parameter on every request. Jentic stores the key encrypted in the vault and appends it at call time, so the agent does not see the raw value.

### Can I record deploys with the Airbrake API?

Yes. POST `/api/v4/projects/{project_id}/deploys` accepts environment, revision, repository, username, and version fields, and the deploy is then linked to subsequent error groups for release-correlation analysis.

### What are the rate limits for the Airbrake API?

Spec metadata does not declare hard rate limits. Notice ingestion (`/api/v3/projects/{project_id}/notices`) accepts high volumes; management endpoints under `/api/v4` are best used in burst-and-pause patterns.

### How do I upload a source map with the Airbrake API through Jentic?

Run pip install jentic, search Jentic for 'upload airbrake source map', load the schema for POST `/api/v4/projects/{project_id}/sourcemaps`, then execute with the project ID, source map file, and original bundle URL. Jentic injects the API key automatically.

### Does the Airbrake API support performance monitoring as well as error tracking?

Yes. The v5 endpoints under `/api/v5/projects/{project_id}/routes-stats`, /routes-breakdowns, /queries-stats, and /queues-stats accept performance telemetry from instrumented services so route latency and database query timing are reportable alongside errors.

### Can I limit what my agent is allowed to do with the Airbrake API?

Yes. Because Jentic One is self-hosted, your own rules decide which Airbrake operations and credentials the agent may use. Airbrake carries the project id in the URL path, such as `/projects/{project_id}/deploys` and `/projects/{project_id}/groups`, so a rule can pin the agent to a single project. You also pick the exact operations it may call, so a destructive action like muting an error group is available only if you add it.