Authentication

Authenticate API requests with a Browsable API key and use task metadata to discover live pricing and schema information.

API Keys

All API requests require a Bearer token in the Authorization header:

curl -X POST "https://api.browsable.app/v1/reddit/search" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"test","_run":{"async":false}}'

Getting an API Key

1. Sign up for a Browsable account at browsable.app.
2. Open the API Keys page in your dashboard.
3. Create a key and store it securely.

Optional Idempotency

For POST endpoints that create work, you can optionally send an Idempotency-Key header. When you retry the same request with the same key, Browsable can return the original run or generation instead of creating duplicate work.

curl -X POST "https://api.browsable.app/v1/reddit/search" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: req_123" \
  -d '{"query":"test"}'

Managing API Keys

You can manage your API keys using the Admin API endpoints:

List API Keys

curl -X GET "https://api.browsable.app/admin/list-keys" \
  -H "Authorization: Bearer YOUR_API_KEY"

Create New API Key

curl -X POST "https://api.browsable.app/admin/create-key" \
  -H "Authorization: Bearer YOUR_API_KEY"

Revoke API Key

curl -X POST "https://api.browsable.app/admin/revoke-key" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key_id": "key_abc123"}'

Credits And Rate Limits

• Task pricing is exposed live via /v1/tasks and /v1/tasks/{task_key} in the credit_cost field.
• Different tasks can cost different amounts.
• Rate limits and entitlement checks are enforced at request time. A 429 means you should retry with backoff. A 403 usually means your account cannot execute the task.

Error Responses

API-level failures use a structured problem-details style response. Examples:

401 Unauthorized

403 Forbidden

429 Rate Limit Exceeded