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

# Introduction

> Welcome to the Voicy API documentation

# Welcome to Voicy API

Voicy is a voice agent platform that enables you to build and deploy AI-powered phone agents. Our API provides programmatic access to manage calls, retrieve transcripts, and integrate voice AI into your applications.

## What can you do with the Voicy API?

<CardGroup cols={2}>
  <Card title="Make Outbound Calls" icon="phone-arrow-up-right">
    Initiate AI-powered phone calls to any number programmatically
  </Card>

  <Card title="Retrieve Call Data" icon="file-lines">
    Access transcripts, recordings, and summaries for all your calls
  </Card>

  <Card title="Manage Calls" icon="list-check">
    List, filter, and organize calls with powerful query options
  </Card>

  <Card title="Custom Metadata" icon="tags">
    Attach custom data to calls for CRM integration
  </Card>
</CardGroup>

## Base URL

All API requests should be made to:

```
https://api.voicy.co
```

## Getting Started

<Steps>
  <Step title="Get your API key">
    Log in to the [Voicy Dashboard](https://app.voicy.co) and navigate to Account Settings to create an API key.
  </Step>

  <Step title="Make your first request">
    Use the API key to authenticate and list your calls:

    ```bash theme={null}
    curl -X POST https://api.voicy.co/functions/v1/call-list \
      -H "Authorization: Bearer voicy_sk_live_xxx" \
      -H "Content-Type: application/json" \
      -d '{"limit": 10}'
    ```
  </Step>

  <Step title="Explore the API">
    Check out the [API Reference](/api-reference/overview) for all available endpoints.
  </Step>
</Steps>

## API stability

The public API is intentionally small and stable. It exposes three call endpoints — [Dial](/api-reference/call-dial), [Get](/api-reference/call-get), and [List](/api-reference/call-list) — and nothing else. We keep the surface minimal on purpose so you can integrate against a contract that won't shift under you.

**What we promise:**

* **Additive-only fields.** We may add new fields to responses, but we will not remove or repurpose a documented field without announcing it in advance. Write your integration to ignore unknown fields.
* **Stable transcript shape.** Each `transcript[]` entry is exactly `{ role, content, timestamp_ms }`, where `role` is `agent`, `caller`, or `system`. Filter for `role in [agent, caller]` if you only want spoken dialogue.

**What is *not* part of the contract:**

* **Flow-agent internals.** Prompt-based agents are manageable through the [Agent API](/api-reference/agent-create) (name, prompt, voice, welcome message, and variable contract). But **flow agents** — multi-step conversational flows with branching, function calls, and knowledge bases — are built in the [dashboard](https://app.voicy.co); their internal structure is never exposed through this API and may change at any time. You reference any agent by `agent_id` (e.g. `override_agent_id` on Dial).
* **Internal fields.** Latency breakdowns, cost/billing figures, infrastructure identifiers, and any field not documented in the API Reference are internal, may change without notice, and are not returned to API-key callers.

## Need Help?

* **Dashboard**: [app.voicy.co](https://app.voicy.co)
* **Email**: [support@voicy.co](mailto:support@voicy.co)