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

# API Reference

> Use Voqo API by domain: auth/admin, calling, campaigns, integrations, workflows, billing, developer tooling, and webhooks.

## Base URL

```text theme={null}
https://api.voqo.ai
```

## Authentication

* Use bearer token/API key authentication based on your integration path.
* Include credentials in `Authorization` header.
* Ensure keys are stored securely and rotated regularly.

```bash theme={null}
Authorization: Bearer YOUR_API_KEY
```

## Endpoint families by domain

### Auth, user, organisation, workspace

* Authentication verification
* User profile and invitation completion
* Organisation/workspace lifecycle endpoints

### Agents, calls, numbers, contacts

* Agent lifecycle and configuration
* Call history and status operations
* Number provisioning/settings
* Contacts CRUD and bulk ingestion

### Voice runtime

* Outbound call start
* Inbound call handling
* Runtime connection and status callbacks

### Batch outbound campaigns

* Campaign management
* Uploads and batch contacts
* Batch jobs and progress monitoring

### Knowledge, integrations, workflows

* Knowledge base lists/items
* Integration connect/sync/disconnect
* Workflow lifecycle and external triggers

### Billing, analytics, developer tools

* Subscription/payment lifecycle
* Analytics endpoints
* API keys and secrets management

### Webhooks and events

* Twilio (call/SMS events)
* Stripe billing events
* Clerk identity events
* Mobile messaging inbound events

## Common use-case paths

<CardGroup cols={2}>
  <Card title="Start a call" icon="phone" href="/api-reference/endpoint/start-call">
    Trigger outbound calling from your application.
  </Card>

  <Card title="Build webhook consumers" icon="webhook" href="/tutorials/integrations/webhook-integration-guide">
    Receive and verify post-call events and integration updates.
  </Card>

  <Card title="Run campaign automation" icon="bullhorn" href="/tutorials/batch-outbound-calls/batch-outbound-calls-overview">
    Launch campaigns with uploads, contacts, and jobs.
  </Card>

  <Card title="Secure admin integrations" icon="shield-check" href="/tutorials/admin/plan-and-permission-matrix">
    Validate plan/role gating before provisioning credentials.
  </Card>
</CardGroup>

## Notes

* Some features/endpoints are plan or role gated.
* Confirm workspace context for all tenant-scoped calls.
* Use idempotent handling for webhook/event processing paths.