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

# Karta API reference

> Authentication, base URL, and endpoints for integrating voice calls, campaigns, WebSocket sessions, and billing.

## What you can do

* List agents, retrieve voice agent settings, and search call logs.
* Create phone and web calls, and retrieve call details.
* List phone numbers and manage outbound campaigns.
* Create WebSocket sessions for voice conversations.
* View account pricing, credit balances, and transactions.
* Receive [call events](https://docs.getkarta.ai/api-reference/webhooks/call-events.md) at a configured webhook URL.

## Base URL

Use this base URL for REST API requests:

```text theme={null}
https://api.getkarta.ai/public/v1
```

Append the endpoint path shown in the reference. For example, `GET /client` becomes `GET https://api.getkarta.ai/public/v1/client`.

Send JSON request bodies with `Content-Type: application/json`. For WebSocket connections, use the URL returned by [Create WebSocket session](https://docs.getkarta.ai/api-reference/realtime/create-websocket-session.md).

## Authentication

Authenticate each REST API request with your Karta API key:

```http theme={null}
Authorization: Bearer YOUR_KARTA_API_KEY
```

Keep your API key on your server. See [authentication](https://docs.getkarta.ai/authentication.md) for details.

## Try an endpoint

Click **Try it** on an endpoint page, enter your API key, fill in the request fields, and click **Send**. Requests go directly from your browser to the production API. Start with **Get account** to verify your key.

> [!WARNING]
>
> Playground requests affect your account. Calls and campaigns can consume credits, and cancelling a campaign stops future calls. Use test agents, campaigns, and phone numbers you control.

For calls and campaigns, set a unique `X-Request-ID` for each new action and preserve it with the same body when retrying.

## Next steps

* [Make a phone call](https://docs.getkarta.ai/guides/phone-calls.md) or [run a campaign](https://docs.getkarta.ai/guides/campaigns.md).
* Review [errors](https://docs.getkarta.ai/errors.md) and [idempotency](https://docs.getkarta.ai/idempotency.md) before adding automatic retries.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.