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

# What the REST API covers

> Everything the Voiceflow REST API can do, grouped by the job you came to do: build an agent, run a conversation, publish it, and measure it.

The Voiceflow REST API covers the whole lifecycle of an agent. You can build
one from parts, run conversations against it, publish it through environments,
and read back what happened, all without opening the Studio.

Every request carries a [personal access token](/docs/api-reference/authentication.md).
One credential authenticates the REST API, the `vf` CLI, and the MCP server.

```bash theme={null}
curl "https://realtime-api.voiceflow.com/v1/stable/workspace" \
  -H "Authorization: Bearer $VF_PAT"
```

New to the API? [Quickstart](/docs/api-reference/quickstart.md) gets you a first
response in a few minutes.

## Build and run

> **[Build](/docs/api-reference/sections/build.md)**
>
> Create and manage the pieces an agent is built from: playbooks, functions, tools, API tools, MCP servers, variables and knowledge base documents.

> **[Running agents](/docs/api-reference/sections/running-agents.md)**
>
> Run conversations against an agent over HTTP. Send what a user would say, read the traces that come back, and inspect or reset the state between turns.

> **[Publishing](/docs/api-reference/sections/publishing.md)**
>
> Ship changes with environments. Edit a draft, publish it live, clone one to work in isolation, merge it back, and split traffic between versions.

> **[Manage](/docs/api-reference/sections/manage.md)**
>
> Create and administer the containers your agents live in: workspaces that group projects and people, and projects that each own a single agent.

## Measure and improve

> **[Observe](/docs/api-reference/sections/observe.md)**
>
> Read the conversations your agent actually had. Search transcripts, fetch a single one, and attach your own properties to record what happened.

> **[Insights](/docs/api-reference/sections/insights.md)**
>
> Score conversations against criteria you define, so agent quality becomes a number you can track over time instead of a sample you skim.

> **[QA](/docs/api-reference/sections/qa.md)**
>
> Replay scripted conversations against your agent and assert what it does, so a change that breaks a scenario fails loudly instead of silently.

> **[Analytics](/docs/api-reference/sections/analytics.md)**
>
> Query usage and cost: tokens, calls, conversations and unique users, plus the spend attributed to individual functions, playbooks and tools.

## Webhooks

> **[Session lifecycle webhook](/docs/api-reference/webhooks/session-lifecycle.md)**
>
> Receive events whenever conversations start or end, on both chat and voice.

> **[Organization events webhooks](/docs/api-reference/webhooks/org-events.md)**
>
> Receive events when projects are created, published, or deleted.


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