Authentication

This placeholder page describes how requests are authenticated. All API requests require a valid API key.

API keys

Generate an API key from your account dashboard. Treat it like a password — it grants full access to your account.

Pass the key in the Authorization header as a bearer token:

curl https://api.example.com/v1/projects \
  -H "Authorization: Bearer YOUR_API_KEY"

A successful response looks like this:

{
  "data": [
    { "id": "prj_001", "name": "Example Project" }
  ]
}

When authentication fails, the API returns one of the following status codes:

Status	Code	Meaning
`401`	`missing_credentials`	No `Authorization` header was provided.
`401`	`invalid_key`	The API key is malformed or revoked.
`403`	`insufficient_scope`	The key lacks permission for the action.
`429`	`rate_limited`	Too many requests in the current window.

Continue to the Endpoints reference for the full list of available operations.