Sign in
Models

Get model by slug

get/v1/models/slug/{slug}

Path parameters

slugstring required

Response

Model retrieved successfully

idstring required

The model ID

slugstring required

The model URL slug

namestring required

The model name

status'IN_PROGRESS' | 'COMPLETED' | 'FAILED' required

The model status

descriptionstring required

The model description

photostring required

The model photo URL

avatarIconstring

The model avatar icon URL

videostring

The model video URL

useVideoboolean

Whether the model uses video

isPublicboolean required

Whether the model is public

gender'male' | 'female' required

The model gender

agenumber required

The model age

relationshipstring required

The model relationship

hairColor'Blonde' | 'Brunette' | 'Black' | 'Red' | 'Pink' | 'Blue' | 'Violet' | 'Airtouch' | 'Black with blonde highlights' | 'Ombre' required

The model hair color

hairStyle'Straight' | 'Braids' | 'Bangs' | 'Bun' | 'Curly' | 'Short' | 'Long' | 'Pigtails' | 'Ponytail' | 'Emo' | 'Shoulder-length' | 'Buzz' | 'Pixie' | 'Hijab' | 'Veil' required

The model hair style

eyesColor'Blue' | 'Brown' | 'Green' required

The model eyes color

ethnicity'caucasian' | 'latina' | 'asian' | 'arab' | 'afro' | 'indian' | 'furry' | 'kemonomimi' | 'tiefling' required

The model ethnicity

buttSize'small' | 'medium' | 'large' required

The model butt size

bodyType'slim' | 'average' | 'athletic' | 'chubby' required

The model body type

breastType'small' | 'medium' | 'large' | 'xl' required

The model breast size

personalitystring required

The model personality

occupation'Massage Therapist' | 'Dentist' | 'Nutritionist' | 'Fitness Coach' | 'Artist' | 'Pharmacist' | 'Hairdresser' | 'Makeup Artist' | 'Gynecologist' | 'Writer' | 'Secretary' | 'Librarian' | 'Social Worker' | 'Fashion Designer' | 'Model' | 'Police Officer' | 'Nurse' | 'Yoga Instructor' | 'Waitress' | 'Cook' | 'Unemployed' | 'Dancer' | 'Teacher' | 'Student' | 'Life Coach' | 'Astronaut' | 'Kindergarten Teacher' | 'Soldier/Military Personnel' | 'Architect' | 'DJ' | 'Nun' required

The model occupation

hobbiesstring required

The model hobbies

isProboolean required

Whether the model is pro

isNewboolean required

Whether the model is new

tiktokVideostring

The model TikTok video URL

onboardingImagestring

The model onboarding image URL

demoModelPreviewVideostring

Short demo clip URL (static CDN) for model card / preview in demo flows

onboardingSubscriptionRewardVideoPreviewstring

Still preview for onboarding subscription reward (FLUX Klein edit pipeline; static CDN image/WebP)

onboardingSubscriptionRewardVideostring

Video for onboarding subscription reward (i2v from FLUX edit; static CDN)

hasDefaultScenarioboolean required

Whether the model has its own default scenario (cover/initial message)

allowedChatModesstring[] required

Chat modes this model may be started in (GEN-1386). Never empty. More than one → the web asks the user to pick before creating the chat.

defaultScenarioCoverstring

CDN URL for the model default scenario cover image (chat-images)

Example response

{
  "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.