MImiaai
Scenes

Get available characters for a scene

Returns paginated list of characters ordered by: recent conversations, then private models, then public models

get/v1/scenes/{id}/characters

Request

  • Base URL
    https://api.miaai.chat (the document declares no server; this is the origin it was published from)
  • URL
    https://api.miaai.chat/v1/scenes/{id}/characters
  • Auth
    HTTP bearer

Path parameters

idstring required

Query parameters

pagenumber
limitnumber

Response

Characters retrieved successfully

totalnumber required

Total number of characters available

pageSizenumber required

Number of characters per page

pagenumber required

Current page number

Example response

{
  "total": 100,
  "pageSize": 20,
  "page": 1,
  "items": [
    {
      "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 operation across all 1 revision of this API.