Skip to main content
GET
/
collections
List all collections
curl --request GET \
  --url https://api.cloudglue.dev/v1/collections \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "collection",
      "name": "<string>",
      "description": "<string>",
      "collection_type": "media-descriptions",
      "extract_config": {
        "prompt": "<string>",
        "schema": {},
        "enable_video_level_entities": false,
        "enable_segment_level_entities": true
      },
      "transcribe_config": {
        "enable_summary": true,
        "enable_speech": true,
        "enable_scene_text": false,
        "enable_visual_scene_description": false,
        "enable_audio_description": false
      },
      "describe_config": {
        "enable_summary": true,
        "enable_speech": true,
        "enable_scene_text": true,
        "enable_visual_scene_description": true,
        "enable_audio_description": false
      },
      "default_segmentation_config": {
        "strategy": "uniform",
        "uniform_config": {
          "window_seconds": 60.5,
          "hop_seconds": 60.5
        },
        "shot_detector_config": {
          "threshold": 123,
          "min_seconds": 60.5,
          "max_seconds": 60.5,
          "detector": "adaptive"
        },
        "manual_config": {
          "segments": [
            {
              "start_time": 123,
              "end_time": 123
            }
          ]
        },
        "start_time_seconds": 1,
        "end_time_seconds": 1
      },
      "default_thumbnails_config": {
        "enable_segment_thumbnails": true
      },
      "face_detection_config": {
        "frame_extraction_config": {
          "strategy": "uniform",
          "uniform_config": {
            "frames_per_second": 1,
            "max_width": 1024
          }
        },
        "thumbnails_config": {
          "enable_frame_thumbnails": true
        }
      },
      "created_at": 123,
      "file_count": 123
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:50

Maximum number of collections to return

Required range: x <= 100
​
offset
integer
default:0

Number of collections to skip

​
order
enum<string>
default:created_at

Order the collections by a specific field

Available options:
name,
created_at
​
sort
enum<string>
default:desc

Sort the collections in ascending or descending order

Available options:
asc,
desc
​
collection_type
enum<string>

Filter collections by type

Available options:
media-descriptions,
entities,
rich-transcripts,
face-analysis
​
created_after
string<date-time>

Filter collections created after this date (ISO 8601 format)

​
created_before
string<date-time>

Filter collections created before this date (ISO 8601 format)

Response

A list of collections

​
object
enum<string>
required

Object type, always 'list'

Available options:
list
​
data
object[]
required

Array of collection objects

​
total
integer
required

Total number of collections matching the query

​
limit
integer
required

Number of items returned in this response

​
offset
integer
required

Offset from the start of the list