Video
get/workspaces/{workspace_id}/videos

Request

Path parameters

workspace_idstring required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

filter[status]string

Comma-separated queued, processing, ready, or failed states.

Response

OK

idinteger

Video ID

public_idstring

Public ID

workspace_idinteger

Workspace ID

namestring

Video name

status'queued' | 'processing' | 'ready' | 'failed'

Computed import state. Poll until ready before attaching to a lesson.

error_code'download_failed' | 'file_too_large' | 'invalid_file_type' | 'processing_failed' | 'null' nullable

Null unless failed. Network and URL download failures share download_failed. An import that stops progressing for 3 hours fails with processing_failed.

poster_image_idinteger nullable

Poster image ID in this workspace.

urlstring nullable

Signed MP4 URL, expires one hour after this response; null until the video has a processed file. Fetch again to renew. No HLS URL is exposed.

thumbnail_urlstring nullable

Signed generated frame URL, expires one day after this response; null until the video has a processed file.

created_atstring date-time

Added

updated_atstring date-time

Updated

Example response

[
  {
    "id": 789,
    "public_id": "AbCdEfGh",
    "workspace_id": 123,
    "name": "Module 1: Welcome",
    "status": "queued",
    "error_code": null,
    "metadata": null,
    "poster_image_id": null,
    "url": null,
    "thumbnail_url": null,
    "created_at": "2026-10-20T17:00:00.000Z",
    "updated_at": "2026-10-20T17:00:00.000Z"
  }
]

Changes