Skip to main content
Detail authenticates API requests using Bearer tokens. Include your API key in the Authorization header of every request — the API does not support cookie-based auth or query-string tokens.

Header format

Every request must carry this header, regardless of the endpoint.

Example request

Obtaining an API key

  1. Sign in at app.detail.dev.
  2. Navigate to Settings → API Keys.
  3. Click Create key, give it a name, and copy the key value immediately — it will not be shown again.

Key format

API keys come in two types, distinguished by their prefix:
Never embed API keys in client-side code, commit them to version control, or share them in public channels. Use environment variables or a secrets manager to inject keys at runtime.

Error responses

If authentication fails, the API returns a JSON error body alongside the HTTP error status. A 401 response looks like this:
If you receive a 403, check that the API key belongs to an account that has access to the organization or repository you are querying.