Skip to content

API key authentication

Send the project API key in the HTTP Authorization header using the Bearer scheme:

Authorization: Bearer <project-api-key>

Example:

curl -sS "$API_BASE/v1/key/projects/$PROJECT_ID/jobs" \
  -H "Authorization: Bearer $API_KEY"

Key scope

Each API key belongs to one project. Use that project's ID in project-scoped paths. Requests for another project return 403 FORBIDDEN.

Create and revoke keys in the dashboard. The full key is shown only when it is created. See API keys.

Authentication errors

HTTP status Meaning
401 UNAUTHORIZED The Authorization header is missing or malformed, or the key is invalid or revoked.
403 FORBIDDEN The key is valid, but the resource is outside its project or the project cannot use that operation.

See Error taxonomy for the response envelope and other request errors.