Authentication

All /v1/* endpoints authenticate with your project API key, sent as a Bearer token:

http
Authorization: Bearer apk_test_your_key_here

Where to get a key

  1. Sign in to the dashboard.
  2. Open your project.
  3. Go to API Keys and create one.

Each key is scoped to exactly one project. The resolved context — key → project → organization — is what every request is authorized against, so a key for project A can never see project B's files.

Key lifecycle

StateBehavior
test keysFor development. Identical endpoints to live keys.
live keysFor production traffic.
Revoked keysImmediately rejected with 401 UNAUTHORIZED.
Expiring keysPass an optional expiresInDays at creation.

Use /v1/me as a configuration sanity check:

bash
curl https://api.apulodi.com/v1/me \
  -H "Authorization: Bearer $APULODI_API_KEY"
json
{
  "project": { "id": "prj_…", "name": "My App", "slug": "my-app" },
  "organization": { "id": "org_…" },
  "apiKey": { "id": "key_…", "name": "ci", "environment": "test" }
}

Key safety

  • Keys are secrets. Never commit them to source control.
  • The SDK is intended for server-side use only. Bundling an API key into browser JavaScript exposes it to every visitor.
  • APULODI never logs the full key — only its prefix.
  • Rotate a key by revoking it and creating a replacement.

Common errors

StatusCodeWhy
401UNAUTHORIZEDMissing, malformed or revoked Authorization header.
400VALIDATION_ERRORMalformed JSON or invalid request body.

Next: read the API overview for conventions and the error envelope.