> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kime.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API access

> API access to your data in Kime

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:

| **Endpoint**   | **Description**                                                      |
| :------------- | :------------------------------------------------------------------- |
| **Workspaces** | List workspaces in your organization                                 |
| **Brands**     | List tracked brands in a workspace                                   |
| **Prompts**    | List active prompts (queries) being monitored                        |
| **Categories** | List prompt categories                                               |
| **Tags**       | List prompt tags                                                     |
| **Metrics**    | Brand visibility, placement, sentiment, share of voice, and rankings |
| **Domains**    | Source domains cited by AI answer engines, with citation frequency   |
| **Sources**    | Individual URLs cited, including which brands are mentioned          |

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**](https://app.kime.ai/).
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/](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](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**](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format with a `type`, `title`, `status`, and `detail` field. Common codes:

| **Status** | **Meaning**                |
| :--------- | :------------------------- |
| 401        | Invalid or missing API key |
| 403        | Key lacks required scope   |
| 404        | Resource not found         |
| 422        | Invalid filter value       |

### **Full API reference**

Explore all endpoints, parameters, and response schemas in the interactive documentation:

[**Open API Documentation →**](https://api.kime.ai/external/docs)

### **Need help?**

Contact us at [team@kime.ai](mailto:team@kime.ai)