Skip to main content

Encode Media

POST 
/api

Create an encoding job to encode a component to a web playable format. Encoded components can be retrieved from the returned job’s job_components relation.

Request​

Header Parameters

    Ftrack-Api-Options any
            Api options formatted as key value pairs separated by semicolon. 
            Suported values are:
             - denormalize
             - strict

             denormalize - data is not normalised before sent to client which means there is no need to merge entities client side. 
             Must also have strict option enabled.
             strict - only requested data is loaded and returned to the client

             Examples:

             denormalize=1;strict=1
             denormalize=False;strict=True
             denormalize=false;strict=false
    Ftrack-Api-Key any
            API key used to authenticate. API keys are created from Settings under the page API keys.
    Ftrack-User any
            Username used to authenticate.

Body

array

required

  • Array [

    • action Actionrequired

    Possible values: [encode_media]

    keep_original Keep Originalrequired
    component_id uuidrequired

    version_id

    object

    nullable

    anyOf

    string

    metadata

    object

    property name* any

  • ]

Responses​

Successful Response

Loading...