Skip to content
VIDMOATDocs

Create a cast member

POSThttps://api.vidmoat.com/v1/cast
Bearer tokenScope cast.writeFreeTry it in the playground

Save a member from 1 to 8 images in the account: uploads (referenceUrls), a generated image (fromUrl), or a frame of a video (fromJobId, or fromFrame { src, time }; without a time the sharpest last frame). Characters get a face print for the consistency check.

Body#

  • namestringrequired
    Up to 60 characters.
  • kindenumdefault character
    What it is.
    One of character, location, prop, style
  • descriptionstring
    The words that must never drift, appended to every prompt that uses the member. Up to 600 characters; longer is refused, never truncated.
  • referenceUrlsarray of strings
    Images in the account, 1 to 8.
  • viewsarray of enums
    One per reference: front, three_quarter, profile, back, full_body, expression, wide or detail.
  • fromUrlstring
    A generated image in the account.
  • fromJobIdstring
    A finished video generation; its frame becomes the reference.
  • voiceIdstring
    A Speech Lab voice of the account or a published one, or a stock voice with voiceProvider.

Response#

Returns 201.

Response fields#

  • memberobject
    The member.
  • problemsarray
    For example: no face found, so the face check reports this member as unknown.

Errors#

Besides the errors any request can get (authentication, rate limits):

StatusCodeWhen
400invalid_requestA missing name, an image not in the account, more than 8 images, a description over 600 characters, or a real person.