Sign in
Chats v2

Get all user chats with scene information (v2)

get/v2/chats

Response

Chats retrieved successfully

idstring required
suggestionsEnabledboolean required

Whether suggestions are enabled for this chat

mode'ROLEPLAY' | 'REALISTIC' required

Mode this chat runs in (GEN-1386). Part of the chat identity — the same user can hold one chat per mode with the same model.

unreadMessageCountnumber required

Number of unread non-user messages in this chat (character / assistant)

isOnboardingboolean

Whether this chat is in onboarding mode

onboardingStepnumber

Current onboarding step (1-6) if in onboarding mode

onboardingScenarioIdstring

Onboarding scenario ID if in onboarding mode

onboardingAskSuggestionsstring[]

Localized prompt suggestions for the Ask feature during onboarding

isDemoboolean
demoMessageCountnumber
demoStockPhotosDeliveredboolean
demoAssistantTextTurnsnumber

Example response

[
  {
    "model": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "slug": "anna-smith-x7f2k",
      "name": "Emily Davis",
      "status": "IN_PROGRESS",
      "description": "Emily, a 5'8\" blonde model...",
      "photo": "https://example.com/emily.jpg",
      "avatarIcon": "https://cdn.example.com/avatars/annika-avatar.webp",
      "video": "https://example.com/emily.mp4",
      "useVideo": true,
      "isPublic": true,
      "gender": "female",
      "age": 18,
      "relationship": "Colleague",
      "hairColor": "Black",
      "hairStyle": "Long",
      "eyesColor": "Blue",
      "ethnicity": "caucasian",
      "buttSize": "small",
      "bodyType": "slim",
      "breastType": "large",
      "personality": "Playful, Adventurous",
      "occupation": "Model",
      "hobbies": "Yoga, Beach Volleyball",
      "isPro": true,
      "isNew": true,
      "tiktokVideo": "https://example.com/tiktok/annika_tiktok.mp4",
      "onboardingImage": "https://example.com/onboarding/annika_onboarding.webp",
      "allowedChatModes": [
        "ROLEPLAY"
      ],
      "defaultScenarioCover": "https://cdn.example.com/chat-images/uuid.jpg",
      "socialRating": {
        "views": 1234,
        "likes": 87
      }
    }
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.