API access

The Kime API gives you programmatic access to your AI visibility analytics. Use it to integrate Kime data into your own dashboards, BI tools, or internal systems.

​

What you can access

The API provides read-only access to your workspace data: All analytics endpoints support filtering by date range, answer engine, brand, prompt, category, and tags.

​

Supported answer engines

Filter by any combination of: chatgpt · perplexity · claude · gemini · google-ai-overview · google-ai-mode

​

Authentication

The API uses API keys passed in the x-api-key header. Each key is scoped to your organization and can be restricted to specific resources.

​

How to get an API key

1. Sign in to the Kime dashboard.
2. Go to Settings → API Keys.
3. Click Create API Key and give it a name.
4. Copy the key — it’s shown only once.

Your organization admin controls which API scopes are available. Keys can access only the resources their scopes permit (e.g., a key with metrics scope cannot access sources).

​

Making requests

All requests go to: https://api.kime.ai/v1/… Include your API key in the header: x-api-key: your_api_key_here Example — list your workspaces: curl -H "x-api-key: your_api_key_here" \ https://api.kime.ai/v1/workspaces

​

Pagination

List endpoints return paginated results. Use page_size (max 100) and the cursor from the response to fetch additional pages.

​

Date filtering

Analytics endpoints default to the last 7 days. Override with start_date and end_date query parameters (format: YYYY-MM-DD).

​

Error handling

Errors return RFC 9457 Problem Details format with a type, title, status, and detail field. Common codes:

​

Full API reference

Explore all endpoints, parameters, and response schemas in the interactive documentation: Open API Documentation →

​

Need help?

Contact us at team@kime.ai