---
title: Overview
description: Build custom app-generation experiences with the v0 API
product: v0 API
type: overview
related:
  - /docs/api/v2/quickstart
  - /docs/api/v2/guides/custom-chat-interface
  - /docs/api/v2/guides/accessing-previews
  - /docs/api/v2/guides/integrating-v0-into-agents
---

# Overview



<div className="@container not-prose -mt-4 mb-4">
  <figure className="flex aspect-[2/1] w-full flex-col items-center justify-center gap-4 overflow-hidden rounded-lg border border-gray-200 bg-white text-black shadow-sm @min-[500px]:aspect-[8/3] @min-[500px]:gap-8 dark:border-gray-800 dark:bg-black dark:text-white">
    <svg aria-labelledby="v0-api-logo-title" className="h-auto w-20 -translate-x-0.5 @min-[500px]:w-[168px] @min-[500px]:-translate-x-1" role="img" viewBox="0 0 252 120" xmlns="http://www.w3.org/2000/svg">
      <title id="v0-api-logo-title">
        v0
      </title>

      <path d="M96 86.0625V24H120V103.125C120 112.445 112.445 120 103.125 120C98.6751 120 94.2826 118.284 91.125 115.127L0 24H33.9375L96 86.0625Z" fill="currentColor" />

      <path d="M218.25 0C236.89 0 252 15.1104 252 33.75V96H228V41.0625L173.062 96H228V120H165.75C147.11 120 132 104.89 132 86.25V24H156V79.125L211.125 24H156V0H218.25Z" fill="currentColor" />
    </svg>

    <code className="font-mono text-base @min-[500px]:text-2xl">
      npm i v0
    </code>
  </figure>
</div>

The v0 API gives your product v0's app-building agent, including code generation, secure live previews, integrations, and deployment to Vercel.

Create a full-stack app from a prompt with one API call:

```typescript
import { v0 } from 'v0'

const result = await v0.chats.create({
  message: 'Create a project management dashboard with a kanban board',
})

if (result.error) {
  throw new Error(result.error.message)
}

console.log('Created chat:', result.data.chat.id)
```

## Why use the v0 API?

Building an app-generation experience requires more than just generating code. You need an agent that can plan and iterate, a secure environment for running its work, and a path from a prompt to a production application. The v0 API provides the complete workflow through one API.

Benefits include:

* **Agentic app generation:** Create full-stack applications from natural language, then continue iterating through follow-up messages.
* **Secure live previews:** Run generated applications and embed their previews without exposing credentials to the browser.
* **Extensible workflows:** Connect MCP servers, integrations, environment variables, and design systems.
* **Built-in deployment:** Deploy generated applications to Vercel without building separate deployment infrastructure.

The v0 API supports these primary workflows:

* **Generate and iterate on apps** with the [Chats](/docs/api/v2/reference/chats/list-chats) and [Messages](/docs/api/v2/reference/messages/list-messages) APIs.
* **Build a custom chat interface** with [`@v0-sdk/react`](/docs/api/v2/guides/custom-chat-interface) and AI SDK.
* **Embed live previews** securely in your product with [authenticated iframe URLs](/docs/api/v2/guides/accessing-previews).
* **Add app generation to agents** through the [v0 MCP server or AI SDK tools](/docs/api/v2/guides/integrating-v0-into-agents).

## Get Started

Start with a complete app-generation frontend:

```bash
npx create-v0-sdk-app
```

The starter includes a full chat interface with live previews. Follow the [Quickstart](/docs/api/v2/quickstart) to configure the starter or add v0 to an existing app.

## Reference and migration

* [Migrate from v1 to v2](/docs/api/v2/guides/migrating-from-v1-to-v2)
* [Browse the endpoint reference](/docs/api/v2/reference/chats/list-chats)


---

For a semantic overview of all documentation, see [/docs/sitemap.md](/docs/sitemap.md)

For an index of all available documentation, see [/docs/llms.txt](/docs/llms.txt)

For agent-facing discovery, including API and MCP surfaces, see [/docs/agents.md](/docs/agents.md)