Transcode Task

Returns detailed information about a specific transcoding task.

Request

Property	Value
Method	`GET`
URL	`/api/transcode/task/{taskId}`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X GET "{BASE_URL}/api/transcode/task/{taskId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Path Parameters

Parameter	Type	Required	Description
`taskId`	string	Yes	Unique identifier of the task

Request With Parameters

bash

curl -X GET "{BASE_URL}/api/transcode/task/{taskId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Task Object

Parameter	Type	Description
`data.id`	string	Unique identifier of the task
`data.type`	string	Task type
`data.state`	string	Task state
`data.applicationName`	string	Application name
`data.streamKey`	string	Stream key
`data.subStream`	string	Sub-stream name
`data.startTime`	integer	Task start time (Unix timestamp in ms)
`data.duration`	integer	Task duration in milliseconds
`data.readPackets`	integer	Number of packets read
`data.writePackets`	integer	Number of packets written
`data.errorCount`	integer	Number of errors encountered
`data.isReader`	boolean	Indicates if task is reading data
`data.isWriter`	boolean	Indicates if task is writing data

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "id": "p_f81yhse9mj1x6nk8",
    "type": "FILE_READER",
    "state": "RUNNING",
    "applicationName": "origin",
    "streamKey": "f1",
    "subStream": "native",
    "startTime": 1765486678488,
    "duration": 306190174,
    "readPackets": 10234345,
    "writePackets": 0,
    "errorCount": 0,
    "isReader": true,
    "isWriter": true
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1765792868662
  }
}

Error Response (4xx/5xx)

Parameter	Type	Description
`message`	string	Human-readable error message

Task Not Found (404)

json

{
  "message": "Task not found"
}

Error Response

json

{
  "message": "Error message"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.