# Introduction

The Limy API gives you programmatic access to all the AI visibility data available in the Limy platform. Use it to integrate brand visibility metrics, citation analytics, sentiment data, and agentic commerce insights into your BI dashboards, reporting tools, and automated workflows.

## Base URL

All API requests are made to:

```
https://app.limy.ai/api/v1
```

## API Versioning

The API uses URL-based versioning. The current version is `v1`. All endpoints are prefixed with `/v1/`.

When breaking changes are introduced, a new version will be released (e.g., `/v2/`). Previous versions will continue to work with advance deprecation notice.

## Request Format

* All requests use standard HTTP methods (`GET` for analytics, `POST`/`PUT`/`DELETE` for operations)
* Query parameters are used for filtering and pagination
* Request bodies (where applicable) use JSON with `Content-Type: application/json`

## Response Format

All responses return JSON. Successful responses return the data directly:

```json
{
  "data": { ... },
  "meta": {
    "requestedAt": "2026-05-05T12:00:00Z"
  }
}
```

Paginated responses include pagination metadata:

```json
{
  "data": [ ... ],
  "pagination": {
    "total": 150,
    "limit": 50,
    "offset": 0,
    "hasMore": true
  },
  "meta": { ... }
}
```

## What's Available

### Analytics

| Category            | Description                                                                     |
| ------------------- | ------------------------------------------------------------------------------- |
| **Visibility**      | Brand mentions, provider distribution, competitor visibility, appearance trends |
| **Citations**       | Citing domains, citation share over time                                        |
| **Sentiment**       | Sentiment scores per entity, per topic                                          |
| **Prompts**         | Average ranking, per-prompt entity rankings                                     |
| **Commerce**        | Shopping visibility, category/product/merchant analytics                        |
| **Traffic**         | Bot and user traffic from AI sources                                            |
| **Recommendations** | Recommendation status summary and progress                                      |

### Operations (coming soon)

CRUD management for prompts, competitors, topics, recommendations, and tracked URLs.

## Next Steps

1. [Set up authentication](https://github.com/limyai/limy-api-reference/blob/main/authentication.md) to get your API key
2. Review [common filters](https://github.com/limyai/limy-api-reference/blob/main/filtering.md) used across endpoints
3. Start with [Visibility Mentions](/analytics/appearance-over-time/mentions.md) for a quick overview of your brand's AI presence


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://api-reference.limy.ai/introduction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.