Dynamic Graphics Render

Describe template

Changed on

Analyzes a MOGRT (video template) file and returns a manifest of editable controls; fonts, images, audio, video and other supported values.

post/v1/templates/describe

Request

  • Base URL: https://audio-video-api.adobe.io
  • URL: https://audio-video-api.adobe.io/v1/templates/describe
  • Auth: HTTP bearer and API key in header x-api-key

Request body

type'mogrt' | 'aep'

Input template type. Use mogrt for a Motion Graphics Template or aep for an After Effects project. Defaults to mogrt when omitted.

compNamestring

Name of the After Effects composition to describe. Required when type is aep; not applicable to mogrt. This composition name within the AEP project must be unique so that compName resolves to a single composition.

Response

Accepted

jobIdstring required

Unique identifier for the describe job.

statusUrlstring uri required

URL to poll for the status of the describe job.

Changes

  • a0995187b59aRevision changes
    • breaking

      added 'if' subschema to the request body

    • breaking

      added 'then' subschema to the request body

    • info

      added the new optional request property

    • info

      added the new optional request property

  • 0691056d1802Revision changes
    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property