Sign in

v1

latestOpenAPI 3.0.32026-07-2691139249.7 KB
personas

Mixin to provide a reusable list method for filtering and paginating queryset results.

get/api/personas/

Query parameters

age_range'child' | 'teen' | 'adult' | 'senior'

Filter by one or more age ranges (comma-separated)

  • child - Child
  • teen - Teen
  • adult - Adult
  • senior - Senior
gender'm' | 'f' | 'nb'

Filter by one or more genders (comma-separated)

  • m - Male
  • f - Female
  • nb - Non-Binary
location'outdoor' | 'fantasy' | 'indoor' | 'other'

Filter by one or more locations (comma-separated)

  • outdoor - Outdoor
  • fantasy - Fantasy
  • indoor - Indoor
  • other - Other
style'selfie' | 'presenter' | 'other'

Filter by one or more styles (comma-separated)

  • selfie - Selfie
  • presenter - Presenter
  • other - Other
suitable_industriesinteger[]

Filter by one or more industry names (comma-separated).

  • Apparel & Accessories - Apparel & Accessories
  • Appliances - Appliances
  • Apps - Apps
  • Baby Kids & Maternity - Baby Kids & Maternity
  • Beauty & Personal Care - Beauty & Personal Care
  • Business Services - Business Services
  • E-Commerce - E-Commerce
  • Education - Education
  • Financial Services - Financial Services
  • Food & Beverage - Food & Beverage
  • Games - Games
  • Health - Health
  • Home Improvement - Home Improvement
  • Household Products - Household Products
  • Life Services - Life Services
  • News & Entertainment - News & Entertainment
  • Pets - Pets
  • Sports & Outdoors - Sports & Outdoors
  • Tech & Electronics - Tech & Electronics
  • Travel - Travel
  • Vehicle & Transportation - Vehicle & Transportation
  • Others - Others

Response

idstring uuid required
created_atstring date-time required
updated_atstring date-time required
gender'm' | 'f' | 'nb' required
  • m - Male
  • f - Female
  • nb - Non-Binary
age_range'child' | 'teen' | 'adult' | 'senior'
  • child - Child
  • teen - Teen
  • adult - Adult
  • senior - Senior
location'outdoor' | 'fantasy' | 'indoor' | 'other'
  • outdoor - Outdoor
  • fantasy - Fantasy
  • indoor - Indoor
  • other - Other
style'selfie' | 'presenter' | 'other'
  • selfie - Selfie
  • presenter - Presenter
  • other - Other
creator_namestring required
video_scenestring nullable

A word to describe the background setting. API user rely on this

videostring uri required
keywordsstring nullable

keywords (comma separated)

suitable_industriesstring required
preview_image_16_9string nullable required
preview_image_1_1string nullable required
preview_image_9_16string nullable required
preview_video_16_9string nullable required
preview_video_1_1string nullable required
preview_video_9_16string nullable required
landscape_preview_videostring uri nullable required

Landscape preview video of the persona

squared_preview_videostring uri nullable required

Squared preview video of the persona

portrait_preview_videostring uri nullable required

Portrait preview video of the persona

is_activeboolean required

Is the creator active to use, if not, it will not be shown in the UI

process_statusstring required
failed_reasonstring required
typestring required