Skip to main content

Documentation Index

Fetch the complete documentation index at: https://onlook.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Base URL

https://api.onlookai.com/v1
For self-hosted deployments, replace with your ingest endpoint (default: http://localhost:4000/v1).

Authentication

All API requests require a Bearer token.
curl https://api.onlookai.com/v1/sessions \
  -H "Authorization: Bearer YOUR_API_KEY"
Generate API keys from the dashboard under Settings → API Keys.

Response format

All responses are JSON. Errors follow this shape:
{
  "error": {
    "code": "session_not_found",
    "message": "No session found with id sess_8xK2mP9q"
  }
}

Rate limits

PlanRequests/minute
Free60
Pro600
EnterpriseUnlimited

Pages

Sessions

List and retrieve session data.

Scores

Query attention scores and history.

Webhooks

Configure and verify webhook delivery.