# Introduction (/introduction)

The Cloakup API lets you manage campaigns and domains with API keys. All public endpoints live under `/v1` on `https://api.cloakup.me`.

<Cards>
  <Card title="Quickstart" href="/quickstart">

Create a key, send your first request, and follow the recommended workflow.

  </Card>
  <Card title="Authentication" href="/authentication">

API key format, scopes, rate limits, and prerequisites.

  </Card>
  <Card title="Campaigns API" href="/api/campaigns">

List, create, update, clone, and toggle campaigns.

  </Card>
  <Card title="Domains API" href="/api/domains">

Register, verify, list, and delete domains.

  </Card>
</Cards>

## Base URL [#base-url]

```
https://api.cloakup.me
```

No trailing slash. Set `CLOAKUP_API_URL` in clients and scripts.

## Use with AI [#use-with-ai]

Each page has **Copy page**, **View as Markdown**, **Open in ChatGPT**, and **Open in Claude**. ChatGPT and Claude fetch the public Markdown URL, so this works after the docs are deployed.

You can also load Markdown directly:

- Index of all pages: [/llms.txt](/llms.txt)
- Full dump: [/llms-full.txt](/llms-full.txt)
- This page: [/raw/index.md](/raw/index.md)

## What you need [#what-you-need]

1. A Cloakup plan with **API keys enabled**
2. An API key created in **Settings → API Keys** in the [dashboard](https://app.cloakup.me)
3. A key with the right **scopes** for each endpoint

<Callout type="info">

API keys are shown only once at creation. Store them securely. Revoked or expired keys return `401`.

</Callout>

## Recommended workflow [#recommended-workflow]

1. Register a domain: `POST /v1/domains` → `PATCH /v1/domains/:id/verify` until `verified: true`
2. Create a campaign with the [minimal example](/guides/campaign-create#minimal-example) — keep `deny_always: false` or omit it
3. Confirm with `GET /v1/campaigns/:id` or list (`in_review` must be `false` for production)

<Callout type="warn">

Read [Production safety](/guides/production-safety) before creating campaigns. Wrong defaults can send all traffic to the safe page.

</Callout>