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

# API Reference

> Botcadence API reference for projects, sources, customers, campaigns, conversations, and analytics

Use the Botcadence API to read projects and customers, manage knowledge sources, trigger campaign calls, inspect conversations, and retrieve analytics.

## Projects

| Method | Endpoint                                                 | Docs                                               |
| ------ | -------------------------------------------------------- | -------------------------------------------------- |
| `GET`  | `/organizations/{organization_id}/projects`              | [List projects](/docs/api-reference/projects/list) |
| `GET`  | `/organizations/{organization_id}/projects/{project_id}` | [Get project](/docs/api-reference/projects/get)    |

## Sources

| Method   | Endpoint                  | Docs                                                         |
| -------- | ------------------------- | ------------------------------------------------------------ |
| `POST`   | `.../sources/files`       | [Upload files](/docs/api-reference/sources/upload-files)     |
| `POST`   | `.../sources/urls`        | [Upload URLs](/docs/api-reference/sources/upload-urls)       |
| `POST`   | `.../sources/domains`     | [Upload domains](/docs/api-reference/sources/upload-domains) |
| `GET`    | `.../sources`             | [List sources](/docs/api-reference/sources/list)             |
| `GET`    | `.../sources/{source_id}` | [Get source](/docs/api-reference/sources/get)                |
| `DELETE` | `.../sources/{source_id}` | [Delete source](/docs/api-reference/sources/delete)          |

## Customer profiles

| Method | Endpoint                                        | Docs                                                                           |
| ------ | ----------------------------------------------- | ------------------------------------------------------------------------------ |
| `GET`  | `.../customer-profiles`                         | [List profiles](/docs/api-reference/customer-profiles/list)                    |
| `GET`  | `.../customer-profiles/{id}`                    | [Get profile](/docs/api-reference/customer-profiles/get)                       |
| `GET`  | `.../customer-profiles/{id}/chat-conversations` | [Chat conversations](/docs/api-reference/customer-profiles/chat-conversations) |

## Campaigns

| Method | Endpoint                          | Docs                                                       |
| ------ | --------------------------------- | ---------------------------------------------------------- |
| `GET`  | `.../campaigns`                   | [List campaigns](/docs/api-reference/campaigns/list)       |
| `GET`  | `.../campaigns/{id}`              | [Get campaign](/docs/api-reference/campaigns/get)          |
| `POST` | `.../campaigns/{id}/retry-call`   | [Retry call](/docs/api-reference/campaigns/retry-call)     |
| `POST` | `.../campaigns/{id}/trigger-call` | [Trigger call](/docs/api-reference/campaigns/trigger-call) |

## Conversations

| Method | Endpoint                               | Docs                                                               |
| ------ | -------------------------------------- | ------------------------------------------------------------------ |
| `GET`  | `.../conversations`                    | [List](/docs/api-reference/conversations/list)                     |
| `GET`  | `.../conversations/{id}`               | [Get](/docs/api-reference/conversations/get)                       |
| `GET`  | `.../conversations/{id}/messages`      | [Messages](/docs/api-reference/conversations/messages)             |
| `GET`  | `.../conversations/{id}/recording-url` | [Recording URL](/docs/api-reference/conversations/recording-url)   |
| `GET`  | `.../inbounds/{id}/report`             | [Inbound report](/docs/api-reference/conversations/inbound-report) |

## Analytics

| Method | Endpoint                                                  | Docs                                                                                  |
| ------ | --------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `GET`  | `/organizations/{organization_id}/analytics`              | [Org analytics](/docs/api-reference/analytics/organization)                           |
| `GET`  | `.../analytics`                                           | [Project analytics](/docs/api-reference/analytics/project)                            |
| `GET`  | `/organizations/{organization_id}/conversation-analytics` | [Org conversation analytics](/docs/api-reference/analytics/organization-conversation) |
| `GET`  | `.../conversation-analytics`                              | [Project conversation analytics](/docs/api-reference/analytics/project-conversation)  |

## Base URL

| Environment | Base URL                                 |
| ----------- | ---------------------------------------- |
| Production  | `https://backend.botcadence.com`         |
| Staging     | `https://staging-backend.botcadence.com` |

## Authentication

```bash theme={null}
X-API-Key: bot_live_YOUR_KEY
```

See [Authentication](/docs/api-reference/authentication).

## Next steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/docs/api-reference/authentication">
    Create and use project API keys.
  </Card>

  <Card title="List projects" icon="folder" href="/docs/api-reference/projects/list">
    List projects in an organization.
  </Card>

  <Card title="Upload files" icon="file-arrow-up" href="/docs/api-reference/sources/upload-files">
    Add knowledge-base files to a project.
  </Card>

  <Card title="Customer profiles" icon="users" href="/docs/api-reference/customer-profiles/list">
    List unified customer profiles.
  </Card>

  <Card title="Trigger outbound call" icon="phone" href="/docs/api-reference/campaigns/trigger-call">
    Place a call with your API key.
  </Card>
</CardGroup>