Introduction
The Brie API gives you programmatic access to your bug reports, workspaces, and integrations. Use it to build custom workflows, sync data with other tools, or connect AI agents to your Brie account.
Base URL
All API requests use the following base URL:
https://api.briehq.com/v1
Response format
Every response wraps data in a consistent envelope:
{
"data": { ... }
}
List endpoints include pagination:
{
"data": [ ... ],
"pagination": {
"cursor": "eyJpZCI6Ii4uLiJ9",
"hasMore": true,
"limit": 25
}
}
Errors
Errors follow a standard shape with a machine-readable code:
{
"error": {
"code": "SCOPE_DENIED",
"message": "Your API key doesn't have the required scope.",
"requestId": "req_abc123"
}
}
Health check
GET /v1/health
No authentication required. Returns { data: { status: "ok" } } when the API is operational. Use this for uptime monitoring.
Common error codes
| Status | Code | Meaning |
|---|---|---|
| 400 | VALIDATION_ERROR | Request body failed validation |
| 401 | UNAUTHORIZED | Missing or invalid API key |
| 403 | SCOPE_DENIED | Key doesn't have the required scope |
| 403 | WORKSPACE_ACCESS_DENIED | Key doesn't have access to this workspace |
| 404 | NOT_FOUND | Resource doesn't exist or you don't have access |
| 429 | RATE_LIMITED | Too many requests — check Retry-After header |
| 429 | WORKSPACE_QUOTA_EXCEEDED | WST token exceeded 10K req/hour workspace quota |
| 503 | SERVICE_UNAVAILABLE | API is temporarily down |