Sign in

v1

latestOpenAPI 3.0.32026-07-24106305257.4 KB
Scenes (Express Avatars)

Get a specific scene

get/scenes/{id}

Path parameters

idstring required

Response

OK

owner_idstring required

the organization or user id that owns the scene

idstring required
created_atstring required
modified_atstring required

Last modified time as iso-8601 string

created_bystring required

Unique identifier of the user that submitted the scene

avatar_idstring required
status'created' | 'started' | 'error' | 'done' | 'rejected' required
audio_urlstring
result_urlstring

The result url of the scene

pending_urlstring

The result url in which scene will be saved when done. Returns only when scene is in process.

started_atstring

Video processing start time as iso-8601 string

completed_atstring

Video completion time as iso-8601 string

subtitles_urlstring required

URL for the scene subtitles.

thumbnail_urlstring required

URL for the scene thumbnail.

namestring

The name of the scene

webhookstring required
user_datastring required

Example response

{
  "config": {
    "logo": {
      "position": [
        0,
        500
      ]
    }
  }
}