Authentication

Public API requests require authentication via an org-scoped API key. Each key grants access to the supported Extract, Enrich, and Explore resources for one organization and carries api:read, api:write, or api:* scopes. Requests without a valid key receive a 401 Unauthorized response.

Getting your API key

1. Sign in to the Extralt dashboard
2. Select your organization
3. Navigate to API key settings
4. Create a new API key

API keys are org-scoped. Each key is tied to a specific organization. If you have multiple organizations, generate a separate key for each.

Using your API key

Include your API key in the Authorization header as a Bearer token:

Authorization: Bearer your-api-key

Example request

curl "https://api.extralt.com/v1/extract/robots" \
  -H "Authorization: Bearer your-api-key"

Base URL

All API requests use the host https://api.extralt.com with a versioned, pipeline-scoped prefix:

https://api.extralt.com/v1/extract/...   # Extract pipeline (robots, runs, captures, schedules, imports)
https://api.extralt.com/v1/enrich/...    # Enrich pipeline (enrichments, items)
https://api.extralt.com/v1/explore/...   # Explore views (overview, facets, current markets, variants)

Security

• Store keys in environment variables or a secrets manager
• Rotate keys periodically
• Revoke compromised keys immediately from the dashboard
• Each key is scoped to one organization and cannot access other orgs' data

Error responses

If authentication fails, the API returns a 401 Unauthorized response:

{
  "error": {
    "code": "unauthorized",
    "message": "A valid Bearer credential is required",
    "request_id": "019..."
  }
}

See the generated OpenAPI document for endpoint-specific response schemas.

Next steps

• Making Requests — request and response conventions
• OpenAPI document — authoritative endpoints and schemas
• Common Patterns — pagination, filtering, and polling