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

# Quick Start

> Get started with Apostra API — connect your AI agent in minutes

# Quick Start

<Note>
  Building a buyer integration? Start with [Buyer Onboarding](/v2/setup/buyer-onboarding) for the end-to-end campaign-launch flow. This page covers AI agent connections.
</Note>

<Warning>
  **Demo and onboarding access:** Data shown in a demo environment is synthetic
  and has no commercial effect. Do not rely on it for commercial decisions or
  present it as market data. Access is for evaluation only and does not grant a
  license or other right in the platform, APIs, schemas, documentation, models,
  or demo data. Read the full [Demo Environment Notice](https://apostra.com/agreements/demo-environment-notice).
</Warning>

The fastest way to get started depends on how you want to connect. Most users connect an AI agent (Claude, ChatGPT, etc.) directly — no code required.

## Step 1: Get Access

<Steps>
  <Step title="Create your account">
    Sign up at [app.apostra.com](https://app.apostra.com) and log in.
  </Step>

  <Step title="Choose your authentication method">
    * **OAuth (recommended for AI agents):** Used automatically when connecting via Claude Connectors or ChatGPT MCP Connectors. No keys to manage — just log in when prompted.
    * **API Key (for CLI tools and custom integrations):** Generate one at [app.apostra.com/user-api-keys](https://app.apostra.com/user-api-keys). Keys start with `scope3_`.
  </Step>
</Steps>

***

## Sanity check (optional — 30 seconds)

Before wiring up an agent, you can confirm the platform is reachable and your API key works with two curls.

**1. Reach the platform.** No auth needed:

```bash theme={null}
curl https://api.apostra.com/health
```

You should get back `{"status":"ok", ...}`.

**2. Confirm your key resolves to your account.** Replace `scope3_…` with your key:

```bash theme={null}
curl https://api.apostra.com/api/v2/accounts/current \
  -H "Authorization: Bearer scope3_your_api_key_here"
```

You should get back your account — `id`, `company`, `name`, `role`. A `401` means the key is wrong or revoked; a `403` with `TOS_ACCEPTANCE_REQUIRED` on a *write* call means your organization hasn't accepted the latest Platform Service Agreement (read endpoints still work — see [Buyer Onboarding](/v2/setup/buyer-onboarding) for the acceptance flow).

If both succeed, you're set up. Continue with an AI agent connection below or jump straight to [Buyer Onboarding](/v2/setup/buyer-onboarding) for the end-to-end campaign-launch flow.

***

## Step 2: Connect

Pick your AI tool and follow the detailed setup guide:

<CardGroup cols={2}>
  <Card title="Claude (Team / Enterprise)" href="/v2/setup/built-for-agents#claude-connector-claudeai-team--enterprise" icon="message-bot">
    Recommended. Admin registers the connector once, every team member connects via OAuth.
  </Card>

  <Card title="Claude Desktop (Personal)" href="/v2/setup/built-for-agents#claude-desktop-personal--manual-setup" icon="desktop">
    Manual config file setup for personal Claude Desktop use with an API key.
  </Card>

  <Card title="Claude Code (CLI)" href="/v2/setup/built-for-agents#claude-code-cli" icon="terminal">
    Add the MCP server via CLI and authenticate with an API key.
  </Card>

  <Card title="ChatGPT" href="/v2/setup/built-for-agents#chatgpt" icon="comments">
    Connect via MCP Connector with OAuth — no API keys needed.
  </Card>

  <Card title="Cursor" href="/v2/setup/built-for-agents#cursor" icon="code">
    Add the MCP server in Cursor settings with an API key.
  </Card>

  <Card title="REST API" href="/v2/setup/built-for-agents#rest-api" icon="bolt">
    Standard HTTP endpoints for programmatic integrations.
  </Card>
</CardGroup>

***

## Step 3: Try It Out

Once connected, your agent has access to 3 MCP tools:

| Tool                   | What It Does                                  |
| ---------------------- | --------------------------------------------- |
| `health`               | Check API connectivity                        |
| `ask_about_capability` | Ask the API what it can do (natural language) |
| `api_call`             | Execute any REST endpoint                     |

**Try these prompts with your connected agent:**

```
List all my advertisers

Create an advertiser called "Acme Corp"

What campaigns exist for advertiser 24?

Create a $50K performance campaign optimized for SALES
```

The agent uses `ask_about_capability` to discover endpoints, then `api_call` to execute them. No need to memorize API paths.

***

## Skill File (for Custom Agents)

Building your own agent? Point it at the skill file for instant API understanding:

| Role       | Skill File URL                                       |
| ---------- | ---------------------------------------------------- |
| Buyer      | `https://api.apostra.com/api/v2/buyer/skill.md`      |
| Storefront | `https://api.apostra.com/api/v2/storefront/skill.md` |

Example prompt for your agent: *"Read [https://api.apostra.com/api/v2/buyer/skill.md](https://api.apostra.com/api/v2/buyer/skill.md) and help me create an advertiser"*

Learn more about [what a skill file is](/v2/skill).

***

## Next Steps

<CardGroup cols={3}>
  <Card title="Buyer Onboarding" href="/v2/setup/buyer-onboarding" icon="user-plus">
    End-to-end campaign-launch flow — from advertiser to live campaign.
  </Card>

  <Card title="Storefront Onboarding" href="/v2/setup/storefront-onboarding" icon="store">
    Sellers: register your storefront and expose inventory.
  </Card>

  <Card title="Advertiser Guide" href="/v2/object-guides/advertiser" icon="bullhorn">
    Learn the advertiser model and required fields.
  </Card>

  <Card title="Built for Agents" href="/v2/setup/built-for-agents" icon="robot">
    Why the API is agent-first and what that means for you.
  </Card>

  <Card title="Authentication" href="/v2/authentication" icon="key">
    API keys, OAuth, and SSO configuration.
  </Card>

  <Card title="API Reference" href="/v2/buyer-api-reference" icon="code">
    Browse all available endpoints.
  </Card>
</CardGroup>