Favorite Chat

Favorite a chat

PUT
/chats/{chatId}/favorite
Authorization<token>

Your v0 API key. Get one at https://v0.dev/chat/settings/keys

In: header

Path Parameters

chatIdstring

Path parameter "chatId"

isFavoriteboolean

Response Body

curl -X PUT "https://api.v0.dev/v1/chats/string/favorite" \
  -H "Content-Type: application/json" \
  -d '{
    "isFavorite": true
  }'
{
  "id": "string",
  "object": "chat",
  "favorited": true
}
{
  "error": {
    "message": "string",
    "type": "unauthorized_error"
  }
}
{
  "error": {
    "message": "string",
    "type": "forbidden_error"
  }
}
{
  "error": {
    "message": "string",
    "type": "not_found_error"
  }
}
{
  "error": {
    "message": "string",
    "type": "conflict_error"
  }
}
{
  "error": {
    "message": "string",
    "type": "payload_too_large_error"
  }
}
{
  "error": {
    "message": "string",
    "type": "unprocessable_entity_error"
  }
}
{
  "error": {
    "message": "string",
    "type": "too_many_requests_error"
  }
}
{
  "error": {
    "message": "string",
    "type": "internal_server_error"
  }
}

Code Examples

cURL

PUT /chats/{chatId}/favorite
curl -X PUT "https://api.v0.dev/v1/chats/chat_123abc/favorite" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"isFavorite": true}'

TypeScript SDK

Using v0-sdk
import { v0 } from 'v0-sdk'

// Add chat to favorites
await v0.chats.favorite({ 
  chatId: 'chat_123abc', 
  isFavorite: true 
})

// Remove from favorites
await v0.chats.favorite({ 
  chatId: 'chat_123abc', 
  isFavorite: false 
})

// Toggle favorite status
const chat = await v0.chats.getById({ chatId: 'chat_123abc' })
await v0.chats.favorite({ 
  chatId: 'chat_123abc', 
  isFavorite: !chat.isFavorite 
})