# Getting Started (/docs)



## What is Trackee? [#what-is-trackee]

Trackee is the SEO & AI Visibility API. One API to track where a brand shows up across Google search and the major AI models (ChatGPT, Claude, Gemini, Perplexity), and to build SEO / AEO / GEO products on top of that data. Every organization has a credit account that tracks its monthly allowance, usage, and purchased credits.

**Base URL:**

```text
https://api.trackee.dev
```

## Create an access key [#create-an-access-key]

1. Sign in to the [Trackee dashboard](/dashboard).
2. Create or select an organization.
3. Create a key, then copy it. Trackee shows the full key only once.

Send the key in the `x-access-key` header on every request.

## Check the service [#check-the-service]

The health endpoint does not require an access key:

```bash
curl https://api.trackee.dev/v1/health
```

```json
{ "ok": true }
```

## Make your first request [#make-your-first-request]

Check your credit balance. Reading usage is free and never consumes credits:

```bash
curl https://api.trackee.dev/v1/usage \
  -H "x-access-key: YOUR_ACCESS_KEY"
```

Then run a real query, for example a keyword rank check (costs 1 credit):

```bash
curl -X POST https://api.trackee.dev/v1/rank \
  -H "x-access-key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"keyword": "best crm software", "domain": "salesforce.com"}'
```

```json
{
  "success": true,
  "credits": { "charged": 1, "remaining": 4999 },
  "data": {
    "keyword": "best crm software",
    "domain": "salesforce.com",
    "position": 2,
    "url": "https://www.salesforce.com/crm/what-is-crm/software/",
    "ai_overview": { "present": true, "cited": true }
  }
}
```

Every response includes a `credits` block so you always know what a call cost and what is left.

## Save a brand [#save-a-brand]

A saved brand keeps the domain, aliases, prompts, competitors, keywords, and AI engines that belong together. Use its `id` in later requests so you do not need to send the same configuration each time.

```bash
curl -X POST https://api.trackee.dev/v1/brands \
  -H "x-access-key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme",
    "domain": "acme.com",
    "aliases": ["Acme Inc."],
    "engines": ["chatgpt", "claude", "gemini", "perplexity"],
    "prompts": ["What is the best project management software?"],
    "competitors": ["Linear", "Asana"],
    "keywords": ["project management software"]
  }'
```

Save the returned `data.id`. Adding it to visibility, tracking, and SEO requests connects results to the same brand. See [Set up a brand](/docs/brands) for field guidance.

## Next steps [#next-steps]

* [Set up a brand](/docs/brands) and choose useful prompts, aliases, and competitors.
* [Check AI visibility](/docs/ai-visibility) for a prompt across one or more AI engines.
* [Track visibility over time](/docs/tracking) with recurring trackers or bulk scans.
* [Research SEO opportunities](/docs/seo-research) with rank, keyword, domain, backlink, and audit data.
* Read [Credits and usage](/docs/credits) before building a high-volume workflow.
* Open the [API Reference](/docs/api) for every request and response field.
* Connect an AI client with [AI Agents & Resources](/docs/ai).