Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/transcoding-service/get-transcoding-job-details.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 4
---
# Get Transcoding Job detail

Expand Down
70 changes: 70 additions & 0 deletions docs/transcoding-service/list-all-transcoding-jobs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
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/<organization_id>/transcoding_jobs/
```

Replace `<organization_id>` 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. <br/> 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. <br/> Options: `-created` (Latest first), `created` (Oldest first). |

#### Example request with filters
`https://app.tpstreams.com/api/v1/<organization_id>/transcoding_jobs/?status=completed&enable_drm=true&created_from=2023-04-20T00:00:00Z&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/<organization_id>/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=<access_key>&secret_key=<secret_key>&region=<region>",
"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=<access_key>&secret_key=<secret_key>&region=<region>",
"start_time": null,
"end_time": null,
"error_message": null,
"enable_drm": false
}
]
}
```
2 changes: 1 addition & 1 deletion docs/transcoding-service/transcoding-cancelation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 5
---

# Cancel Transcoding Job
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)