The dashboard uses a signed-in Clerk session scoped to the active organization. These endpoints are for the webapp and authenticated users. Machine clients use organization API keys with the scrape, map, and quote endpoints.
Playground
POST /v1/playground/scrape takes the same body as /v1/scrape and returns the same scrape result. It requires a signed-in session. The playground is rate limited per user.
API keys
| Endpoint | Action | Access |
|---|---|---|
GET /v1/keys |
List key names, prefixes, scopes, and revoked_at. Add include_revoked=true to include revoked keys. |
Signed-in organization member. |
POST /v1/keys |
Create a key from name, optional scopes, and optional live. The key secret is returned once. |
Organization owner or admin. |
DELETE /v1/keys/{key_id} |
Revoke a key. | Organization owner or admin. |
New keys default to both scrape and map scopes. live defaults to true; false creates a test-prefixed key. Store the one-time secret securely.
Usage
| Endpoint | Action |
|---|---|
GET /v1/usage?days=30 |
Daily counts, credits, errors, cache-hit rate, and current credit balance. days can be 1 to 365. |
GET /v1/usage/activity?limit=50 |
Newest usage events with an optional cursor for the next page. limit can be 1 to 200. |
Usage data is scoped to the active organization. The activity response includes events and next_cursor. Pass next_cursor as the next request's cursor until it is null.