Synthesia APIs
IntegrationsHelp centerSynthesia UpdatesLog in

Create an interactive avatar

post
https://developers.synthesia.io/api/interactive-avatars/avatars

Create an interactive avatar from an existing Studio avatar.

  • Generation is asynchronous: the request answers 202 with the avatar's current status.
  • Poll by repeating the same request (with regenerate omitted) until done is true — a
    repeat never starts a second generation.
  • Once status is completed, include the returned id in the avatarIds list of
    POST /api/interactive-avatars/sessions.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The source to generate an interactive avatar from.

Repeating a request returns the current status of the avatar generated from that source and never
starts a second generation - unless regenerate is true, which starts a fresh one on every call.

string
required

The avatar id shown in Studio, with the av_ prefix.

boolean
Defaults to false

Force a fresh interactive avatar generation instead of returning the existing avatar.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 4 hours ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated about 4 hours ago

Did this page help you?