Skip to content

Authentication

API requests authenticate with a bearer token:

Authorization: Bearer br_your_key

Create, view, and revoke API keys from:

https://app.batchrelay.com/developers
ScopePurpose
print_orders:writeCreate print orders.
print_orders:readRead print-order status.
usage:readRead usage summary.
webhooks:readRead webhook configuration.
webhooks:writeCreate or change webhook configuration.

Requests without an API key return:

{
"error": {
"code": "api_key_required",
"message": "Supply a Batch Relay API key using Authorization: Bearer <key>.",
"docs_url": "https://docs.batchrelay.com/errors#api_key_required",
"action_url": "https://app.batchrelay.com/developers"
},
"request_id": "req..."
}

Revoked keys stop working immediately. Create a new key if a bearer token is exposed.