Transcode Task List

Returns a paginated list of transcoding tasks.

Request

Property	Value
Method	`GET`
URL	`/api/transcode/active`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

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

Query Parameters

Parameter	Type	Required	Default	Description
`page`	integer	No	1	Page number
`rowsPerPage`	integer	No	10	Number of items per page
`orderBy`	string	No	-	Field name to sort by (e.g., `"startTime"`)
`order`	asc \| desc	No	-	Sort order
`search`	string	No	-	Filter by stream key

With query parameters

bash

curl -X GET "{BASE_URL}/api/transcode/active?page=value&rowsPerPage=value&orderBy=value" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Pagination

Parameter	Type	Description
`data.totalItems`	integer	Total number of tasks
`data.itemsPerPage`	integer	Number of items per page
`data.totalPages`	integer	Total number of pages
`data.currentPage`	integer	Current page number
`data.hasPrevious`	boolean	Indicates if a previous page exists
`data.hasNext`	boolean	Indicates if a next page exists

Task Object

Parameter	Type	Description
`data.list[].id`	string	Unique identifier of the task
`data.list[].type`	string	Task type
`data.list[].state`	string	Task state
`data.list[].applicationName`	string	Application name
`data.list[].streamKey`	string	Stream key
`data.list[].subStream`	string	Sub-stream name
`data.list[].startTime`	integer	Task start time (Unix timestamp in ms)
`data.list[].duration`	integer	Task duration in milliseconds
`data.list[].readPackets`	integer	Number of packets read
`data.list[].writePackets`	integer	Number of packets written
`data.list[].errorCount`	integer	Number of errors encountered
`data.list[].isReader`	boolean	Indicates if task is reading data
`data.list[].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": {
    "totalItems": 2,
    "itemsPerPage": 10,
    "totalPages": 1,
    "currentPage": 1,
    "hasPrevious": false,
    "hasNext": false,
    "list": [
      {
        "id": "p_v7t8b218mj1x74ux",
        "type": "FILE_READER",
        "state": "RUNNING",
        "applicationName": "origin",
        "streamKey": "eternals",
        "subStream": "native",
        "startTime": 1765486700905,
        "duration": 305629206,
        "readPackets": 10209191,
        "writePackets": 0,
        "errorCount": 0,
        "isReader": true,
        "isWriter": true
      },
      {
        "id": "p_f81yhse9mj1x6nk8",
        "type": "FILE_READER",
        "state": "RUNNING",
        "applicationName": "origin",
        "streamKey": "f1",
        "subStream": "native",
        "startTime": 1765486678488,
        "duration": 305651623,
        "readPackets": 10215589,
        "writePackets": 0,
        "errorCount": 0,
        "isReader": true,
        "isWriter": true
      }
    ]
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1765792330111
  }
}

Error Response (4xx/5xx)

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

json

{
  "message": "Error message"
}

Support Needed?

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