HEheygen
Templates

Get Template

Changed on

Returns template details including its variable schema (with current default values) and scenes. Variable defaults are returned in the same shape the generate request accepts, so a response can be edited and posted back. Only draft version 4 templates (the current editor format) are supported.

get/v3/templates/{template_id}

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/templates/{template_id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

template_idstring required

Unique template identifier

Response

Successful response

Changes

  • 7dfa5e59b4f5Revision changes
    • breaking

      the response property //// became optional for the status

    • breaking

      response property data/variables/additionalProperties/oneOf[subschema #5: TemplateCharacterVariable]/character_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/variables/additionalProperties/oneOf[subschema #5: TemplateCharacterVariable]/character_type list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the //// response property's minLength was decreased from 1 to 0 for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      the response's property default value avatar was removed for the status

    • info

      response property data/scenes deprecated

    • info

      response property data/variables/additionalProperties/oneOf[subschema #5: TemplateCharacterVariable]/character_id deprecated

    • info

      response property data/variables/additionalProperties/oneOf[subschema #5: TemplateCharacterVariable]/character_type deprecated

    • info

      added asset_id base64 url discriminator mapping keys to the //// response property for the response status

    • info

      added asset_id base64 url discriminator mapping keys to the //// response property for the response status

    • info

      added asset_id base64 url discriminator mapping keys to the //// response property for the response status

    • info

      added audio character image text video voice discriminator mapping keys to the // response property for the response status

    • info

      removed the avatar enum value from the //// response property for the response status

    • info

      removed the talking_photo enum value from the //// response property for the response status