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

# API introduction

> Programmatic access to your Autocampaign AI workspace over a REST API.

## Overview

Autocampaign AI exposes a REST API for your workspace's resources — contacts, segments,
campaigns, polls, templates, and links. Anything you can do in the app you can
automate with the API.

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/api/authentication">
    Create an API key and send it with each request.
  </Card>

  <Card title="Conventions" icon="list-check" href="/api/conventions">
    Response envelope, pagination, rate limits, and errors.
  </Card>
</CardGroup>

## Base URL

All endpoints live at the root of `https://api.autocampaign.ai` (there's no `/api` prefix):

```
https://api.autocampaign.ai/contacts
https://api.autocampaign.ai/campaigns
```

Paths in this reference are shown without the host (for example, `POST /contacts`).
The app itself runs at `https://app.autocampaign.ai`; the API is a separate host.

## Interactive reference

The full, always-current endpoint reference — every route, request schema, and
response schema, with a **try-it console** — is served by the platform as
interactive docs (ReDoc):

<Card title="Open the interactive API docs" icon="book-open" href="https://api.autocampaign.ai/docs">
  Browse and try every endpoint at api.autocampaign.ai/docs. The raw OpenAPI spec is
  at [api.autocampaign.ai/docs-json](https://api.autocampaign.ai/docs-json).
</Card>

This Mintlify reference covers **getting started, authentication, conventions, and a
curated resource overview**. Use the interactive docs for exhaustive, generated
schema detail.

## What you can call with an API key

An [API key](/api/authentication) can call the same org-scoped resources a
workspace Owner can — [Contacts](/api/resources#contacts),
[Segments](/api/resources#segments), [Tags](/api/resources#tags),
[Campaigns](/api/resources#campaigns), [Polls](/api/resources#polls),
[Templates](/api/resources#sms-templates), and [Links](/api/resources#links).

<Warning>
  A few surfaces are **session-only** (they reject API keys): the **Inbox**, and
  **API key** and **webhook** management. Use these while signed in to the app.
</Warning>

<Card title="Start with authentication" icon="key" href="/api/authentication">
  Create a key and make your first call.
</Card>