From 790ab583656345b96b11dd5da829ad68be3bc9a6 Mon Sep 17 00:00:00 2001 From: Anif Date: Tue, 3 Mar 2026 15:24:24 +0530 Subject: [PATCH 1/2] doc: Add document for listing transcoding jobs api --- .../get-transcoding-job-details.md | 2 +- .../list-all-transcoding-jobs.md | 68 +++++++++++++++++++ .../transcoding-cancelation.md | 2 +- .../transcoding-service-introduction.md | 1 + 4 files changed, 71 insertions(+), 2 deletions(-) create mode 100644 docs/transcoding-service/list-all-transcoding-jobs.md diff --git a/docs/transcoding-service/get-transcoding-job-details.md b/docs/transcoding-service/get-transcoding-job-details.md index a675c7df..705f43cc 100644 --- a/docs/transcoding-service/get-transcoding-job-details.md +++ b/docs/transcoding-service/get-transcoding-job-details.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 --- # Get Transcoding Job detail diff --git a/docs/transcoding-service/list-all-transcoding-jobs.md b/docs/transcoding-service/list-all-transcoding-jobs.md new file mode 100644 index 00000000..65c886da --- /dev/null +++ b/docs/transcoding-service/list-all-transcoding-jobs.md @@ -0,0 +1,68 @@ +--- +sidebar_position: 3 +--- +# List all Transcoding Jobs + +To list all transcoding jobs, make a GET request to the following API endpoint, with the [authentication Header](../server-api/authentication.md). + +```base +https://app.tpstreams.com/api/v1//transcoding_jobs/ +``` + +Replace `` with your organization's unique identifier. + +### Query Parameters + +You can filter and order the list of transcoding jobs using the following query parameters: + +| Parameter | Type | Description | +| :--- | :--- | :--- | +| `status` | string | Filter jobs by status. You can provide multiple statuses by repeating the parameter.
Options: `queued`, `transcoding`, `completed`, `error`. | +| `enable_drm` | boolean | Filter jobs by whether DRM is enabled (`true`) or disabled (`false`). | +| `ordering` | string | Order the jobs by creation time.
Options: `-created` (Latest first), `created` (Oldest first). | + +#### Example request with filters +`https://app.tpstreams.com/api/v1//transcoding_jobs/?status=completed&status=error&enable_drm=true&ordering=-created` + +### Sample Response + +The response is paginated and contains a list of transcoding jobs. + +```json +{ + "count": 42, + "next": "https://app.tpstreams.com/api/v1//transcoding_jobs/?page=2", + "previous": null, + "results": [ + { + "id": "5KQfnXCg8Qh", + "resolutions": [ + "240p", + "480p" + ], + "video_duration": 120, + "status": "Completed", + "input_url": "https://example.com/input-video.mp4", + "output_path": "s3://example-bucket/path/?access_key=&secret_key=®ion=", + "start_time": "2023-04-20T23:20:06.034924+12:00", + "end_time": "2023-04-20T23:40:06.034924+12:00", + "error_message": null, + "enable_drm": true + }, + { + "id": "7XkLp9mN2O", + "resolutions": [ + "720p" + ], + "video_duration": 300, + "status": "Queued", + "input_url": "https://example.com/another-video.mp4", + "output_path": "s3://example-bucket/another-path/?access_key=&secret_key=®ion=", + "start_time": null, + "end_time": null, + "error_message": null, + "enable_drm": false + } + ] +} +``` diff --git a/docs/transcoding-service/transcoding-cancelation.md b/docs/transcoding-service/transcoding-cancelation.md index 4aac1d51..9464dcba 100644 --- a/docs/transcoding-service/transcoding-cancelation.md +++ b/docs/transcoding-service/transcoding-cancelation.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 5 --- # Cancel Transcoding Job diff --git a/docs/transcoding-service/transcoding-service-introduction.md b/docs/transcoding-service/transcoding-service-introduction.md index be8440b8..d54f29b0 100644 --- a/docs/transcoding-service/transcoding-service-introduction.md +++ b/docs/transcoding-service/transcoding-service-introduction.md @@ -9,5 +9,6 @@ Welcome to the Transcoding as a Service documentation! This guide is your gatewa Refer the documentation below for more information. - [Transcode a Video](transcode-a-video) +- [List all Transcoding Jobs](list-all-transcoding-jobs) - [Get Transcoding Job Details](get-transcoding-job-details) - [Cancel Transcoding Job](transcoding-cancelation) From 5699a81b881b3101a85b13fbf680459ee70121bf Mon Sep 17 00:00:00 2001 From: Anif Date: Tue, 3 Mar 2026 17:27:48 +0530 Subject: [PATCH 2/2] refactor --- docs/transcoding-service/list-all-transcoding-jobs.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/transcoding-service/list-all-transcoding-jobs.md b/docs/transcoding-service/list-all-transcoding-jobs.md index 65c886da..84bb67a1 100644 --- a/docs/transcoding-service/list-all-transcoding-jobs.md +++ b/docs/transcoding-service/list-all-transcoding-jobs.md @@ -19,10 +19,12 @@ You can filter and order the list of transcoding jobs using the following query | :--- | :--- | :--- | | `status` | string | Filter jobs by status. You can provide multiple statuses by repeating the parameter.
Options: `queued`, `transcoding`, `completed`, `error`. | | `enable_drm` | boolean | Filter jobs by whether DRM is enabled (`true`) or disabled (`false`). | +| `created_from` | string | Filter jobs created on or after this date and time (ISO 8601 format). | +| `created_to` | string | Filter jobs created on or before this date and time (ISO 8601 format). | | `ordering` | string | Order the jobs by creation time.
Options: `-created` (Latest first), `created` (Oldest first). | #### Example request with filters -`https://app.tpstreams.com/api/v1//transcoding_jobs/?status=completed&status=error&enable_drm=true&ordering=-created` +`https://app.tpstreams.com/api/v1//transcoding_jobs/?status=completed&enable_drm=true&created_from=2023-04-20T00:00:00Z&ordering=-created` ### Sample Response @@ -41,7 +43,7 @@ The response is paginated and contains a list of transcoding jobs. "480p" ], "video_duration": 120, - "status": "Completed", + "status": "completed", "input_url": "https://example.com/input-video.mp4", "output_path": "s3://example-bucket/path/?access_key=&secret_key=®ion=", "start_time": "2023-04-20T23:20:06.034924+12:00", @@ -55,7 +57,7 @@ The response is paginated and contains a list of transcoding jobs. "720p" ], "video_duration": 300, - "status": "Queued", + "status": "queued", "input_url": "https://example.com/another-video.mp4", "output_path": "s3://example-bucket/another-path/?access_key=&secret_key=®ion=", "start_time": null,