Sign in
chats

Create Chat

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.

post/chats

Request body

messagestring required

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.

systemstring

Provides system-level context or background for the chat. This is typically used to specify frameworks, tools, or development environments relevant to the task.

chatPrivacy'public' | 'private' | 'team-edit' | 'team' | 'unlisted'

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.

projectIdstring

Associates the chat with a specific project in your workspace. Helps organize and group related chats under a common project context.

responseMode'sync' | 'async' | 'experimental_stream'

Controls how the response is delivered.

  • "sync": The response is returned immediately with the HTTP request.
  • "async": Returns a message placeholder immediately; use getById to poll for completion status and final output.
  • "experimental_stream": Returns content parts as Server-Sent Events for real-time streaming.
designSystemIdstring nullable

The ID of a design system to apply to this chat. Design systems provide consistent styling and components for generated UI.

Response

Success

idstring required

A unique identifier for the chat.

object'chat' required

Fixed value identifying this object as a chat.

shareableboolean required

Indicates whether the chat can be shared via public link.

privacy'public' | 'private' | 'team' | 'team-edit' | 'unlisted' required

Defines the visibility of the chat—private, team-only, or public.

namestring

An optional name assigned to the chat by the user.

titlestring

Deprecated title field preserved for backward compatibility.

createdAtstring date-time required

The ISO timestamp representing when the chat was created.

updatedAtstring

The ISO timestamp of the last update to the chat.

favoriteboolean required

Indicates whether the chat is marked as a favorite.

authorIdstring required

The ID of the user who created the chat.

projectIdstring

Optional ID of the v0 project associated with this chat.

webUrlstring required

Web URL to view this chat in the browser.

apiUrlstring required

API URL to access this chat via the API.

urlstring required

The canonical URL to access this chat.

demostring

Deprecated demo URL used for previewing the chat result.

textstring required

The main user prompt or instruction that started the chat.

Changes