Skip to main content

Documentation Index

Fetch the complete documentation index at: https://buildpixel.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Error response shape

Non-2xx responses return JSON:
{
  "error": "machine_readable_code",
  "message": "Human-readable description.",
  "requestId": "req_abc123..."
}
  • error is stable — code your branching logic against this.
  • message is for humans; we may rephrase it without notice.
  • requestId is what you mention to support when something is broken.

Status codes

CodeWhen
200 OKSuccessful read
201 CreatedResource created
202 AcceptedAsync operation queued (e.g. build dispatch)
204 No ContentSuccessful write with no body
400 Bad RequestInvalid input
401 UnauthorizedMissing or invalid token
403 ForbiddenToken lacks permission for this action
404 Not FoundResource doesn’t exist or you can’t see it
429 Too Many RequestsRate-limited; see Retry-After header
500 Internal Server ErrorBug on our side — include requestId when reporting

Common error codes

CodeDescription
invalid_tokenToken is malformed, revoked, or expired.
insufficient_scopeToken doesn’t have the required permission.
validation_failedInput failed schema validation.
engine_not_foundRequested ueVersion is not supported.
repo_not_accessibleGitHub App lost access to the repo.
perforce_auth_failedPerforce credentials rejected.

Rate limiting

When rate-limited:
HTTP/1.1 429 Too Many Requests
Retry-After: 12
Wait Retry-After seconds before the next request.