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

# API quickstart

> Create an API key, check it with /me, list your brands and pull their daily AI visibility in five minutes.

By the end of this page you'll have a working key and a script that reads the last 30 days of visibility for one of your brands.

## Before you start

* You're the **owner** of the workspace or an **integration admin**. Other members can see the key list but can't create keys. See [Team and roles](https://docs.usequotable.com/workspace/team-and-roles.md).
* The workspace has at least one brand with tracking data.

## Make your first calls

**1. Create a key**

1. In Quotable, open **Settings → API keys** and select **Create API key**.
2. Under **Scope**, choose **Brand** for the brand you're working in, or **Workspace** for every brand you can access.
3. Name the key after the integration that will use it, for example `Looker dashboard`, and select **Create key**.
4. Copy the key. This is the only time Quotable shows it.

> [!NOTE]
>
> If Quotable asks you to sign in again or confirm your authenticator code, that's expected: creating a key requires a recent sign-in.

Store the key in an environment variable so the examples below can read it:

```bash theme={"system"}
export QUOTABLE_API_KEY="quotable_live_…"
```

**2. Check the key**

`GET /me` works with any valid key and tells you what the key can do.

```bash cURL theme={"system"}
curl https://app.usequotable.com/api/v1/me \
  -H "Authorization: Bearer $QUOTABLE_API_KEY"
```

```javascript JavaScript theme={"system"}
const res = await fetch("https://app.usequotable.com/api/v1/me", {
  headers: { Authorization: `Bearer ${process.env.QUOTABLE_API_KEY}` },
});
console.log(await res.json());
```

```python Python theme={"system"}
import os
import requests

res = requests.get(
    "https://app.usequotable.com/api/v1/me",
    headers={"Authorization": f"Bearer {os.environ['QUOTABLE_API_KEY']}"},
    timeout=30,
)
print(res.json())
```

```json Response theme={"system"}
{
  "organization_id": "8f3c2a1e-5b7d-4e9a-9c1f-2d6b8a4e7f10",
  "key": {
    "id": "3b9e7c2d-1a4f-4b8e-a6d2-5c7f9e1b3a20",
    "name": "Looker dashboard",
    "prefix": "quotable_live_a1B2c3D4",
    "scopes": ["read:projects", "read:visibility", "read:content", "read:demand", "read:agents", "read:tables", "read:facts", "run:agents", "write:facts"],
    "project_ids": null,
    "expires_at": null,
    "created_at": "2026-10-01T14:02:11.000Z"
  }
}
```

`project_ids: null` means the key reads every brand. A list means it reads only those. `expires_at: null` means the key doesn't expire.

**3. List your brands**

```bash cURL theme={"system"}
curl "https://app.usequotable.com/api/v1/projects?limit=10" \
  -H "Authorization: Bearer $QUOTABLE_API_KEY"
```

```javascript JavaScript theme={"system"}
const res = await fetch("https://app.usequotable.com/api/v1/projects?limit=10", {
  headers: { Authorization: `Bearer ${process.env.QUOTABLE_API_KEY}` },
});
const { data, next_cursor } = await res.json();
for (const brand of data) console.log(brand.id, brand.name);
```

```python Python theme={"system"}
res = requests.get(
    "https://app.usequotable.com/api/v1/projects",
    params={"limit": 10},
    headers={"Authorization": f"Bearer {os.environ['QUOTABLE_API_KEY']}"},
    timeout=30,
)
for brand in res.json()["data"]:
    print(brand["id"], brand["name"])
```

```json Response theme={"system"}
{
  "data": [
    {
      "id": "c4a1e8f2-7d3b-4c6a-9e5f-1b2d3c4e5f60",
      "name": "Acme Analytics",
      "domain": "acme.com",
      "brand_name": "Acme",
      "market": { "location_code": 2840, "language": "English" },
      "engines": ["chatgpt", "perplexity", "ai_overview", "gemini"],
      "paused": false,
      "created_at": "2026-08-12T09:30:00.000Z"
    }
  ],
  "next_cursor": null
}
```

Copy the `id` of the brand you want. The next call uses it as `project_id`.

**4. Read daily visibility**

Without `from` and `to`, you get the last 30 days ending today (UTC).

```bash cURL theme={"system"}
curl "https://app.usequotable.com/api/v1/projects/c4a1e8f2-7d3b-4c6a-9e5f-1b2d3c4e5f60/visibility" \
  -H "Authorization: Bearer $QUOTABLE_API_KEY"
```

```javascript JavaScript theme={"system"}
const projectId = "c4a1e8f2-7d3b-4c6a-9e5f-1b2d3c4e5f60";
const res = await fetch(
  `https://app.usequotable.com/api/v1/projects/${projectId}/visibility`,
  { headers: { Authorization: `Bearer ${process.env.QUOTABLE_API_KEY}` } },
);
const series = await res.json();
for (const point of series.data) console.log(point.date, point.score);
```

```python Python theme={"system"}
project_id = "c4a1e8f2-7d3b-4c6a-9e5f-1b2d3c4e5f60"
res = requests.get(
    f"https://app.usequotable.com/api/v1/projects/{project_id}/visibility",
    headers={"Authorization": f"Bearer {os.environ['QUOTABLE_API_KEY']}"},
    timeout=30,
)
for point in res.json()["data"]:
    print(point["date"], point["score"])
```

```json Response theme={"system"}
{
  "project_id": "c4a1e8f2-7d3b-4c6a-9e5f-1b2d3c4e5f60",
  "from": "2026-09-02",
  "to": "2026-10-01",
  "data": [
    {
      "date": "2026-09-30",
      "score": 41.25,
      "mention_rate": 0.5833,
      "share_of_voice": { "Acme": 0.38, "Globex": 0.34, "Initech": 0.28 }
    },
    {
      "date": "2026-10-01",
      "score": 43.8,
      "mention_rate": 0.6111,
      "share_of_voice": { "Acme": 0.41, "Globex": 0.33, "Initech": 0.26 }
    }
  ]
}
```

Each point is one day with a tracking run, oldest first:

* `score` is the visibility score, from 0 to 100.
* `mention_rate` is the share of answers that mention the brand, from 0 to 1.
* `share_of_voice` maps every brand named in answers to its share, from 0 to 1. The values sum to 1 whenever any brand is named.

Days without a tracking run are absent, so a 30-day range can return fewer than 30 points.

## Check the response headers

Add `-i` to any cURL call to see the headers that come back with every successful response:

```http theme={"system"}
HTTP/2 200
content-type: application/json; charset=utf-8
cache-control: private, no-store
etag: "q3D2x8kVb1mN0pR7sT9uW4yZ6aC"
x-api-version: 2026-09-18
x-ratelimit-limit: 300
x-ratelimit-remaining: 297
x-ratelimit-reset: 42
x-request-id: 7c9e6679-7425-40de-944b-e07fc1f90ae7
```

## Next steps

> [card] [Authentication](https://docs.usequotable.com/api-reference/authentication.md)
>
> Scopes, brand access, expiry and safe revocation.

> [card] [Pagination](https://docs.usequotable.com/api-reference/pagination.md)
>
> Walk every page of prompts, citations, articles and demand terms.

> [card] [Weekly visibility trend](https://docs.usequotable.com/guides/weekly-visibility-trend.md)
>
> Turn the visibility series into a week-over-week trend.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.