v0

App · 20 actions

Create and organize v0 chats and projects, send messages, inspect versions and read deployments and account usage.

Actions

ActionWhat it does
Create chatCreate chat.
Create projectCreate project.
Delete chatDelete chat.
Delete projectDelete project.
Get billingGet billing.
Get chatGet chat.
Get deploymentGet deployment.
Get planGet plan.
Get projectGet project.
Get rate limitsGet rate limits.
Get userGet user.
Get versionGet version.
List chatsList chats.
List deploymentsList deployments.
List messagesList messages.
List projectsList projects.
List versionsList versions.
Send messageSend message.
Update chatUpdate chat.
Update projectUpdate project.

Create chat

Create chat.

Inputs

MessagemessagetextRequired
Creates a new chat using a user message, optional system context, and model configuration. Useful for prompting the model within the scope of a specific project.
Attachmentsattachmentslist
A list of files or assets to be included in the conversation context. Useful when the chat or task requires referencing documents, images, or other resources.
Systemsystemtext
Provides system-level context or background for the chat. This is typically used to specify frameworks, tools, or development environments relevant to the task.
Chat privacychat_privacytext
Determines the privacy setting of the chat. This can control whether the chat is visible only to the user, to team members, or is public.One of: public, private, team-edit, team, unlisted. Default: private.
Projectproject_idtext
Associates the chat with a specific project in your workspace. Helps organize and group related chats under a common project context.
Model configurationmodel_configurationobject
Settings that control how the model behaves in the chat.
Design system IDdesign_system_idtext
The ID of a design system to apply to this chat. Design systems provide consistent styling and components for generated UI.
Mcp server IDsmcp_server_idslist
Array of MCP server IDs to enable for this chat. When provided, only the specified servers will be used. When omitted, falls back to the user's enabled MCP servers.
Attached skill IDsattached_skill_idslist
Array of skill IDs (from skills.sh) to attach to this chat. Backwards-compatible alias for `skills` entries of type `remote`. Maximum 3 skills per chat.
Skillsskillslist
Skills to force-attach to this chat. Supports skills.sh (`remote`), user/team memory (`memory`), and project (`project`) skills. Merged with `attachedSkillIds`. Maximum 3 skills per chat.
Metadatametadataobject
Arbitrary key-value data to attach to the chat. Useful for storing additional data about the chat, such as external user IDs.

Outputs

dataobject
Detailed representation of a chat, including its messages, files, versions, and model configuration.
Example output
{
  "data": {
    "apiUrl": "example",
    "authorId": "example",
    "createdAt": "example",
    "demo": "example",
    "favorite": false,
    "files": [],
    "id": "example",
    "latestVersion": {
      "createdAt": "example",
      "demoUrl": "example",
      "files": [],
      "id": "example",
      "object": "example",
      "screenshotUrl": "example",
      "status": "pending",
      "updatedAt": "example"
    },
    "messages": [],
    "metadata": {},
    "modelConfiguration": {
      "fast": false,
      "imageGenerations": false,
      "modelId": "v0-auto",
      "thinking": false,
      "thinkingEffort": "none"
    },
    "name": "example",
    "object": "example",
    "permissions": {
      "write": false
    },
    "privacy": "public",
    "projectId": "example",
    "shareable": false,
    "text": "example",
    "title": "example",
    "updatedAt": "example",
    "url": "example",
    "vercelProjectId": "example",
    "webUrl": "example"
  }
}

Create project

Create project.

Inputs

NamenametextRequired
The name of the project.
Descriptiondescriptiontext
A brief summary of the project’s purpose.
Iconicontext
An icon identifier to visually represent the project.Default: icon-wand-sparkles.
Environment variablesenvironment_variableslist
A list of key-value pairs used to define runtime variables for the project.
Instructionsinstructionstext
Guidance or goals that provide context for the model when working within the project.
Vercel project IDvercel_project_idtext
The ID of an existing Vercel project to link to. If not provided, a new Vercel project will be created.
Privacyprivacytext
The privacy setting for the project. For user accounts, this is always "private". For team/enterprise accounts, this can be either "private" or "team".One of: private, team.

Outputs

dataobject
Full representation of a project, including its associated chats.
Example output
{
  "data": {
    "apiUrl": "example",
    "chats": [],
    "createdAt": "example",
    "description": "example",
    "id": "example",
    "instructions": "example",
    "name": "example",
    "object": "example",
    "privacy": "private",
    "updatedAt": "example",
    "vercelProjectId": "example",
    "webUrl": "example"
  }
}

Delete chat

Delete chat.

Inputs

Chatchat_idtextRequired
Chat ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "deleted": false,
    "id": "example",
    "object": "example"
  }
}

Delete project

Delete project.

Inputs

Projectproject_idtextRequired
Project ID.
Delete all chatsdelete_all_chatstext
If true, deletes all the chats associated with the given project ID. Deleting is permanent. Defaults to false.One of: true, false. Default: false.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "deleted": false,
    "id": "example",
    "object": "example"
  }
}

Get billing

Get billing.

Inputs

Scopescopetext
Filters billing data by a specific scope, such as a project ID or slug.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "billingType": "example",
    "data": {
      "balance": {
        "remaining": 1.0,
        "total": 1.0
      },
      "billingCycle": {
        "end": 1.0,
        "start": 1.0
      },
      "billingMode": "example",
      "onDemand": {
        "balance": 1.0,
        "blocks": []
      },
      "plan": "example",
      "role": "example"
    }
  }
}

Get chat

Get chat.

Inputs

Chatchat_idtextRequired
Chat ID.

Outputs

dataobject
Detailed representation of a chat, including its messages, files, versions, and model configuration.
Example output
{
  "data": {
    "apiUrl": "example",
    "authorId": "example",
    "createdAt": "example",
    "demo": "example",
    "favorite": false,
    "files": [],
    "id": "example",
    "latestVersion": {
      "createdAt": "example",
      "demoUrl": "example",
      "files": [],
      "id": "example",
      "object": "example",
      "screenshotUrl": "example",
      "status": "pending",
      "updatedAt": "example"
    },
    "messages": [],
    "metadata": {},
    "modelConfiguration": {
      "fast": false,
      "imageGenerations": false,
      "modelId": "v0-auto",
      "thinking": false,
      "thinkingEffort": "none"
    },
    "name": "example",
    "object": "example",
    "permissions": {
      "write": false
    },
    "privacy": "public",
    "projectId": "example",
    "shareable": false,
    "text": "example",
    "title": "example",
    "updatedAt": "example",
    "url": "example",
    "vercelProjectId": "example",
    "webUrl": "example"
  }
}

Get deployment

Get deployment.

Inputs

Deployment IDdeployment_idtextRequired
Deployment ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "apiUrl": "example",
    "chatId": "example",
    "id": "example",
    "inspectorUrl": "example",
    "object": "example",
    "projectId": "example",
    "versionId": "example",
    "webUrl": "example"
  }
}

Get plan

Get plan.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "balance": {
      "remaining": 1.0,
      "total": 1.0
    },
    "billingCycle": {
      "end": 1.0,
      "start": 1.0
    },
    "object": "example",
    "plan": "example"
  }
}

Get project

Get project.

Inputs

Projectproject_idtextRequired
Project ID.

Outputs

dataobject
Full representation of a project, including its associated chats.
Example output
{
  "data": {
    "apiUrl": "example",
    "chats": [],
    "createdAt": "example",
    "description": "example",
    "id": "example",
    "instructions": "example",
    "name": "example",
    "object": "example",
    "privacy": "private",
    "updatedAt": "example",
    "vercelProjectId": "example",
    "webUrl": "example"
  }
}

Get rate limits

Get rate limits.

Inputs

Scopescopetext
The context or namespace to check rate limits for (e.g., a project slug or feature area).

Outputs

dataobject
Response.
Example output
{
  "data": {
    "dailyLimit": {
      "isWithinGracePeriod": false,
      "limit": 1.0,
      "remaining": 1.0,
      "reset": 1.0
    },
    "limit": 1.0,
    "remaining": 1.0,
    "reset": 1.0
  }
}

Get user

Get user.

Inputs

None.

Outputs

dataobject
Details of the authenticated user, including profile and contact information.
Example output
{
  "data": {
    "avatar": "example",
    "createdAt": "example",
    "email": "example",
    "id": "example",
    "name": "example",
    "object": "example",
    "updatedAt": "example"
  }
}

Get version

Get version.

Inputs

Chatchat_idtextRequired
Chat ID.
Version IDversion_idtextRequired
Version ID.
Include default filesinclude_default_filestext
When true, includes all default files (package.json, configuration files, etc.) that would be part of a ZIP download. When false or omitted, returns only the generated source files.One of: true, false.

Outputs

dataobject
Detailed version data including file contents.
Example output
{
  "data": {
    "createdAt": "example",
    "demoUrl": "example",
    "files": [],
    "id": "example",
    "object": "example",
    "screenshotUrl": "example",
    "status": "pending",
    "updatedAt": "example"
  }
}

List chats

List chats.

Inputs

Limitlimitnumber
Specifies the maximum number of chat records to return in a single response. Useful for paginating results when there are many chats.At most 60. Default: 60.
Offsetoffsetnumber
Determines the starting point for pagination. Used in conjunction with limit to retrieve a specific page of chat results.Default: 0.
Is favoriteis_favoritetext
Filters chats by their "favorite" status. Accepts `"true"` or `"false"` (as strings, not booleans). - `"true"`: returns only chats marked as favorites. - `"false"`: returns only non-favorite chats.One of: true, false.
Vercel project IDvercel_project_idtext
Filters chats by the linked Vercel project ID. Only returns chats associated with the specified Vercel project.
Branchbranchtext
Filters chats by the Git branch name. Only returns chats that have an active Git connection with the specified branch as the head.
Metadatametadataobject
Filters chats by metadata. Returns chats matching every supplied key-value pair.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "object": "example"
  }
}

List deployments

List deployments.

Inputs

Projectproject_idtext
The ID of the project to find deployments for
Chatchat_idtextRequired
The ID of the chat to find deployments for
Version IDversion_idtextRequired
The ID of the version to find deployments for

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "object": "example"
  }
}

List messages

List messages.

Inputs

Chatchat_idtextRequired
Chat ID.
Limitlimitnumber
Specifies the maximum number of message records to return in a single response. Useful for paginating results when there are many messages.From 1 to 150. Default: 20.
Cursorcursortext
Base64 encoded cursor containing pagination data

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "object": "example",
    "pagination": {
      "hasMore": false,
      "nextCursor": "example",
      "nextUrl": "example"
    }
  }
}

List projects

List projects.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "object": "example"
  }
}

List versions

List versions.

Inputs

Chatchat_idtextRequired
Chat ID.
Limitlimitnumber
Specifies the maximum number of version records to return in a single response. Useful for paginating results when there are many versions.From 1 to 150. Default: 20.
Cursorcursortext
Base64 encoded cursor containing pagination data

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "totalCount": 1.0
    },
    "object": "example",
    "pagination": {
      "hasMore": false,
      "nextCursor": "example",
      "nextUrl": "example"
    }
  }
}

Send message

Send message.

Inputs

Chatchat_idtextRequired
Chat ID.
MessagemessagetextRequired
The prompt or instruction to send to the model as part of the chat.
Attachmentsattachmentslist
A list of files or assets to include with the message.
Systemsystemtext
Provides system-level context or background for the chat. This is typically used to specify frameworks, tools, or development environments relevant to the task.
Model configurationmodel_configurationobject
Overrides for the model behavior.
Mcp server IDsmcp_server_idslist
Array of MCP server IDs to enable for this message. When provided, only the specified servers will be used. When omitted, falls back to the user's enabled MCP servers.
Attached skill IDsattached_skill_idslist
Array of skill IDs (from skills.sh) to attach to this message. Backwards-compatible alias for `skills` entries of type `remote`. Maximum 3 skills per chat.
Skillsskillslist
Skills to force-attach to this message. Supports skills.sh (`remote`), user/team memory (`memory`), and project (`project`) skills. Merged with `attachedSkillIds`. Maximum 3 skills per chat.
Actionmessage_actiontext
Ask v0 to fix the errors described in your message. Leave empty for a normal message.One of: fix-with-v0.

Outputs

dataobject
Detailed representation of a chat, including its messages, files, versions, and model configuration.
Example output
{
  "data": {
    "apiUrl": "example",
    "authorId": "example",
    "createdAt": "example",
    "demo": "example",
    "favorite": false,
    "files": [],
    "id": "example",
    "latestVersion": {
      "createdAt": "example",
      "demoUrl": "example",
      "files": [],
      "id": "example",
      "object": "example",
      "screenshotUrl": "example",
      "status": "pending",
      "updatedAt": "example"
    },
    "messages": [],
    "metadata": {},
    "modelConfiguration": {
      "fast": false,
      "imageGenerations": false,
      "modelId": "v0-auto",
      "thinking": false,
      "thinkingEffort": "none"
    },
    "name": "example",
    "object": "example",
    "permissions": {
      "write": false
    },
    "privacy": "public",
    "projectId": "example",
    "shareable": false,
    "text": "example",
    "title": "example",
    "updatedAt": "example",
    "url": "example",
    "vercelProjectId": "example",
    "webUrl": "example"
  }
}

Update chat

Update chat.

Inputs

Chatchat_idtextRequired
Chat ID.
Namenametext
A new name to assign to the chat. Helps with identification and organization.
Privacyprivacytext
Sets the privacy level of the chat.One of: public, private, team, team-edit, unlisted.
Metadatametadataobject
Arbitrary key-value data to attach to the chat. Useful for storing additional data about the chat, such as external user IDs. Metadata added will be merged with existing attributes. Pass `null` as the value to delete a specific key, or pass `null` instead of an object to delete all existing metadata.

Outputs

dataobject
Detailed representation of a chat, including its messages, files, versions, and model configuration.
Example output
{
  "data": {
    "apiUrl": "example",
    "authorId": "example",
    "createdAt": "example",
    "demo": "example",
    "favorite": false,
    "files": [],
    "id": "example",
    "latestVersion": {
      "createdAt": "example",
      "demoUrl": "example",
      "files": [],
      "id": "example",
      "object": "example",
      "screenshotUrl": "example",
      "status": "pending",
      "updatedAt": "example"
    },
    "messages": [],
    "metadata": {},
    "modelConfiguration": {
      "fast": false,
      "imageGenerations": false,
      "modelId": "v0-auto",
      "thinking": false,
      "thinkingEffort": "none"
    },
    "name": "example",
    "object": "example",
    "permissions": {
      "write": false
    },
    "privacy": "public",
    "projectId": "example",
    "shareable": false,
    "text": "example",
    "title": "example",
    "updatedAt": "example",
    "url": "example",
    "vercelProjectId": "example",
    "webUrl": "example"
  }
}

Update project

Update project.

Inputs

Projectproject_idtextRequired
Project ID.
Namenametext
A new name to assign to the project. Helps with identification and organization.
Descriptiondescriptiontext
A new description to assign to the project. Helps with identification and organization.
Instructionsinstructionstext
Guidance or goals that provide context for the model when working within the project.
Privacyprivacytext
The privacy setting for the project. For user accounts, this must be "private". For team/enterprise accounts, this can be either "private" or "team".One of: private, team.

Outputs

dataobject
Full representation of a project, including its associated chats.
Example output
{
  "data": {
    "apiUrl": "example",
    "chats": [],
    "createdAt": "example",
    "description": "example",
    "id": "example",
    "instructions": "example",
    "name": "example",
    "object": "example",
    "privacy": "private",
    "updatedAt": "example",
    "vercelProjectId": "example",
    "webUrl": "example"
  }
}

On this page