Create File Segmentation

Create a new segmentation for a file using the specified segmentation configuration

POST /files/{file_id}/segmentations

Create a new segmentation for a file

cURL

curl --request POST \
  --url https://api.cloudglue.dev/v1/files/{file_id}/segmentations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "narrative_config": {
    "prompt": "<string>",
    "number_of_chapters": 2,
    "min_chapters": 2,
    "max_chapters": 2
  },
  "start_time_seconds": 1,
  "end_time_seconds": 1
}
'

200

{
  "segmentation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "created_at": 1,
  "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segmentation_config": {
    "strategy": "uniform",
    "uniform_config": {
      "window_seconds": 60.5,
      "hop_seconds": 60.5
    },
    "shot_detector_config": {
      "detector": "adaptive",
      "threshold": 123,
      "min_seconds": 300.3,
      "max_seconds": 300.5,
      "fill_gaps": true
    },
    "manual_config": {
      "segments": [
        {
          "start_time": 123,
          "end_time": 123
        }
      ]
    },
    "narrative_config": {
      "prompt": "<string>",
      "strategy": "comprehensive",
      "number_of_chapters": 2,
      "min_chapters": 2,
      "max_chapters": 2
    },
    "keyframe_config": {
      "frames_per_segment": 4,
      "max_width": 2232
    },
    "start_time_seconds": 1,
    "end_time_seconds": 1
  },
  "thumbnails_config": {
    "enable_segment_thumbnails": true
  },
  "total_segments": 1,
  "total_shots": 1,
  "total_chapters": 1,
  "data": {
    "object": "list",
    "total": 123,
    "limit": 123,
    "offset": 123,
    "segments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "start_time": 123,
        "end_time": 123,
        "thumbnail_url": "<string>"
      }
    ],
    "shots": [
      {
        "index": 123,
        "start_time": 1,
        "end_time": 1
      }
    ],
    "chapters": [
      {
        "index": 123,
        "start_time": 1,
        "end_time": 1,
        "description": "<string>"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

file_id · string<uuid> · required

The ID of the file to segment

Body

application/json

Segmentation configuration

Segmentation configuration (root level) with optional thumbnails configuration.

strategy · enum<string> · required

Segmentation strategy - determines which config you must provide

Available options: uniform, shot-detector, manual, narrative

uniform_config · object

🎯 REQUIRED when strategy = 'uniform' - Configuration for uniform segmentation.

Show child attributes

shot_detector_config · object

🎯 REQUIRED when strategy = 'shot-detector' - Configuration for shot detection segmentation.

Show child attributes

manual_config · object

🎯 REQUIRED when strategy = 'manual' - Configuration for manual segmentation.

Show child attributes

narrative_config · object

🎯 REQUIRED when strategy = 'narrative' - Configuration for narrative-based chapter segmentation using AI analysis.

Show child attributes

keyframe_config · object

When provided, will be used to extract keyframes for the segmentation.

Show child attributes

start_time_seconds · number

Optional: The start time of the video in seconds to start segmenting from

Required range: x >= 0

end_time_seconds · number

Optional: The end time of the video in seconds to stop segmenting at

Required range: x >= 0

thumbnails_config · object

Configuration for segment thumbnails. Optional.

Show child attributes

Response

200

application/json

Segmentation created successfully

segmentation_id · string<uuid> · required

Unique identifier for the segmentation job

status · enum<string> · required

Status of the segmentation job. If a job has the status 'not_applicable' it means that we were unable to find any appropriate scenes for this video. This can be possible if you use the shot-detector strategy.

Available options: pending, processing, completed, failed, not_applicable

created_at · number · required

Unix timestamp in milliseconds when the segmentation was created

Required range: x >= 0

file_id · string<uuid> · required

ID of the file this segmentation belongs to

segmentation_config · object · required

Configuration for video segmentation. Choose a strategy and provide ONLY the corresponding config:

• uniform: Provide uniform_config, do NOT provide other configs • shot-detector: Provide shot_detector_config, do NOT provide other configs • manual: Provide manual_config, do NOT provide other configs • narrative: Provide narrative_config, do NOT provide other configs

Optionally specify start_time_seconds and end_time_seconds to limit segmentation to a portion of the video.

Show child attributes

thumbnails_config · object · required

Show child attributes

total_segments · number

Total number of segments in this segmentation (only present when status is completed)

Required range: x >= 0

total_shots · number

Total number of shots in this segmentation (only present when status is completed and segmentation_config.strategy is 'shot-detector')

Required range: x >= 0

total_chapters · number

Total number of chapters in this segmentation (only present when status is completed and segmentation_config.strategy is 'narrative')

Required range: x >= 0

data · object

Segment data with pagination (only present when status is completed and segments exist)

Show child attributes