v1

latestOpenAPI 3.1.02026-07-24650272.2 KB

API Endpoints

List Assets

List folders and assets for a workspace in a single response. Use parent_id to browse a specific folder, or filters like title, status, and playlist_id to search assets.

get/video/workspaces/{workspace_id}/list

Path parameters

workspace_idstring required

Video workspace id.

Query parameters

type'folders' | 'videos' | 'all'

Return folders, videos, or all. Default is all.

parent_idstring

Parent folder id. Send null to browse the root level.

titlestring

Search folders or assets by title/name.

statusstring

Comma-separated asset status values.

tagstring

Comma-separated asset tags.

playlist_idstring

Filter assets to a playlist.

start_datestring

Asset created_at lower bound.

end_datestring

Asset created_at upper bound.

min_durationnumber

Minimum asset duration in seconds.

max_durationnumber

Maximum asset duration in seconds.

sortBy'title' | 'duration' | 'uploaded_at' | 'created_at'

Sort assets by a supported field.

orderBy'asc' | 'desc'

Asset sort order.

searchIndex'search_index_for_asset_list' | 'cms-search' | 'cms-search-v2'

Search index used for asset title search.

offsetinteger

Offset for paginated results.

sizeinteger

Page size. Maximum 100.

Response

200

folder_countinteger

asset_countinteger

total_countinteger

current_offsetinteger

Example response

{
  "folders": [
    {
      "id": "67e4f01d403562dbea6542d4",
      "name": "Course Assets",
      "video_source_id": "67e4ece9403562dbea65425f",
      "path": [
        "67e4f01d403562dbea6542d4"
      ],
      "path_names": [
        "Course Assets"
      ],
      "subdirectory_count": 2,
      "asset_count": 12,
      "created_at": "2026-03-18T10:00:00.000Z",
      "updated_at": "2026-03-18T10:15:00.000Z"
    }
  ],
  "all_assets": [
    {
      "asset_id": "6192269e0822a81d955d1a4b",
      "created_at": 1636968094594,
      "status": "optimizing",
      "source_id": "5f462c1561cf8a766464ffc4",
      "input": {
        "transformations": {
          "resolution": "240p,360p",
          "format": "hls",
          "audio_codec": [
            "aac"
          ],
          "video_codec": [
            "libx264"
          ],
          "thumbnail": [
            "auto"
          ],
          "thumbnail_format": "png",
          "keep_original": true,
          "per_title_encoding": true
        },
        "source_url": "https://gumlet.sgp1.digitaloceanspaces.com/video/BigBuckBunny.mp4",
        "size": 158008374,
        "duration": 596.473333,
        "aspect_ratio": "16:9",
        "fps": 24,
        "width": 1280,
        "height": 720,
        "additional_tracks": [
          {
            "url": "https://gumlet.sgp1.digitaloceanspaces.com/video/BigBuckBunny.aac",
            "type": "audio",
            "language_code": "en",
            "name": "English"
          }
        ]
      },
      "output": {
        "format": "hls",
        "status_url": "https://api.gumlet.com/v1/video/assets/6192269e0822a81d955d1a4b",
        "playback_url": "https://video.gumlet.io/5f462c1561cf8a766464ffc4/6192269e0822a81d955d1a4b/1.m3u8",
        "thumbnail_url": [
          "https://video.gumlet.io/5f462c1561cf8a766464ffc4/6192269e0822a81d955d1a4b/thumbnail-1-0.png"
        ]
      }
    }
  ],
  "folder_count": 1,
  "asset_count": 1,
  "total_count": 2,
  "current_offset": 2
}