Find Chats | v0 Docs

GET/v1/chats

Usage

TypeScript Example

import { v0 } from 'v0-sdk'

const result = await v0.chats.find({
  limit: '10',
  offset: '0',
  isFavorite: 'false',
})

console.log(result)

API Signature

Request

Query Parameters

limit?: number

Specifies the maximum number of chat records to return in a single response. Useful for paginating results when there are many chats.

offset?: number

Determines the starting point for pagination. Used in conjunction with limit to retrieve a specific page of chat results.

isFavorite?: 'true' | 'false'

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.

Response

object: 'list'

data: object[]

id?: string

A unique identifier for the chat.

object?: 'chat'

Fixed value identifying this object as a chat.

shareable?: boolean

Indicates whether the chat can be shared via public link.

privacy?: 'public' | 'private' | 'team' | 'team-edit' | 'unlisted'

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

name?: string

An optional name assigned to the chat by the user.

title?: string

deprecated

Deprecated title field preserved for backward compatibility.

createdAt?: string

The ISO timestamp representing when the chat was created.

updatedAt?: string

The ISO timestamp of the last update to the chat.

favorite?: boolean

Indicates whether the chat is marked as a favorite.

authorId?: string

The ID of the user who created the chat.

projectId?: string

Optional ID of the v0 project associated with this chat.

webUrl?: string

Web URL to view this chat in the browser.

apiUrl?: string

API URL to access this chat via the API.

latestVersion?: object

The most recent generated version of the chat, if available.

id: string

A unique identifier for the version.

object: 'version'

Fixed value identifying this object as a version.

status: 'pending' | 'completed' | 'failed'

The current status of the version generation process.

demoUrl?: string

Optional URL for previewing the generated output.

createdAt: string

The date and time when the version was created, in ISO 8601 format.

updatedAt?: string

The date and time when the version was last updated, in ISO 8601 format.