Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Transformation Job Status

GET/api/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transformationJobs/{transformationJobId}
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Gets the status of a transformation job.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:mediasets-transform.

Path parameters

mediaSetRid
string

The RID of the media set.

mediaItemRid
string

The RID of the media item.

transformationJobId
string

The ID of the transformation job.

Query parameters

preview
boolean
optional

A boolean flag that, when set to true, enables the use of beta features in preview mode.

Response body

GetTransformationJobStatusResponse
object

The status of the transformation job.

Hide child attributes

Hide child attributes

status
string (enum)

The status of a transformation job.

Enum values: PENDING, FAILED, SUCCESSFUL

jobId
string

An identifier for a media item transformation job.

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transformationJobs/{transformationJobId}?preview=true"