GET
/
segments
List all segmentation jobs
curl --request GET \
  --url https://api.cloudglue.dev/v1/segments \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "segments",
      "status": "pending",
      "criteria": "shot",
      "created_at": 123,
      "shot_config": {
        "detector": "adaptive",
        "threshold": 123,
        "max_duration_seconds": 300,
        "min_duration_seconds": 1
      },
      "narrative_config": {
        "prompt": "<string>"
      },
      "total_segments": 1,
      "segments": [
        {
          "start_time": 1,
          "end_time": 1,
          "description": "<string>",
          "thumbnail_url": "<string>"
        }
      ]
    }
  ],
  "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 segmentation jobs to return

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

Number of segmentation jobs to skip

status
enum<string>

Filter segmentation jobs by status

Available options:
pending,
processing,
completed,
failed
criteria
enum<string>

Filter segmentation jobs by criteria type

Available options:
shot,
narrative
created_before
string<date>

Filter segmentation jobs created before a specific date (YYYY-MM-DD format), in UTC timezone

created_after
string<date>

Filter segmentation jobs created after a specific date (YYYY-MM-DD format), in UTC timezone

url
string

Filter segmentation jobs by the input URL used for segmentation

Response

A list of segmentation jobs

object
enum<string>
required

Object type, always 'list'

Available options:
list
data
object[]
required

Array of segmentation job objects

total
integer
required

Total number of segmentation jobs matching the query

limit
integer
required

Number of items returned in this response

offset
integer
required

Offset from the start of the list