Skip to main content
GET

Overview

Returns one of your team’s Cinematic characters. Use it to check an id before passing it in characterIds of Create Cinematic Video. imageUrl is a signed URL that expires, or null when the character has no photo yet. After Create Character or Update Character with imageUrl or generatePortrait, poll this endpoint until imageStatus is COMPLETED (or FAILED). Free and safe to retry.

Errors

Authorizations

x-api-key
string
header
required

Path Parameters

characterId
string
required

The character id, from List Characters.

Response

Character found

success
boolean
required
data
object
required

A Cinematic character of your team (Studio → Characters in the dashboard). Pass its id in characterIds of Create Cinematic Video.

message
string