List File Segmentations

List all segmentations for a specific file

GET /files/{file_id}/segmentations

List segmentations for a file

cURL

curl --request GET \
  --url https://api.cloudglue.dev/v1/files/{file_id}/segmentations \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cloudglue.dev/v1/files/{file_id}/segmentations"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cloudglue.dev/v1/files/{file_id}/segmentations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cloudglue.dev/v1/files/{file_id}/segmentations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloudglue.dev/v1/files/{file_id}/segmentations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.cloudglue.dev/v1/files/{file_id}/segmentations")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cloudglue.dev/v1/files/{file_id}/segmentations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "object": "list",
  "data": [
    {
      "segmentation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": 1,
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "segmentation_config": {
        "uniform_config": {
          "window_seconds": 60.5,
          "hop_seconds": 60.5
        },
        "shot_detector_config": {
          "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>",
          "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": 123,
  "limit": 123,
  "offset": 123
}

{
  "error": "<string>"
}

{
  "error": "<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

Query Parameters

limit · integer

Number of segmentations to return

Required range: 1 <= x <= 100

offset · integer

Offset from the start of the list

Required range: x >= 0

Response

200

application/json

List of segmentations

object · enum<string> · required

Object type, always 'list'

Available options: list

data · object[] · required

Array of segmentation objects

Show child attributes

total · integer · required

Total number of segmentations matching the query

limit · integer · required

Number of items returned in this response

offset · integer · required

Offset from the start of the list