List Segmentation Describes

List all describe jobs that referenced the specified segmentation. Returns describe job records associated with the segmentation.

GET /segmentations/{segmentation_id}/describes

List describe jobs for a segmentation

cURL

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

import requests

url = "https://api.cloudglue.dev/v1/segmentations/{segmentation_id}/describes"

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/segmentations/{segmentation_id}/describes', 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/segmentations/{segmentation_id}/describes",
  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/segmentations/{segmentation_id}/describes"

	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/segmentations/{segmentation_id}/describes")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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": [
    {
      "job_id": "<string>",
      "url": "<string>",
      "duration_seconds": 123,
      "thumbnail_url": "<string>",
      "created_at": 123,
      "describe_config": {
        "enable_summary": true,
        "enable_speech": true,
        "enable_visual_scene_description": true,
        "enable_scene_text": true,
        "enable_audio_description": true,
        "participants": [
          {
            "name": "<string>",
            "scope": "<string>"
          }
        ]
      },
      "use_in_default_index": true,
      "data": {
        "content": "<string>",
        "title": "<string>",
        "summary": "<string>",
        "segment_summary": [
          {
            "title": "<string>",
            "summary": "<string>",
            "start_time": 123,
            "end_time": 123,
            "thumbnail_url": "<string>"
          }
        ],
        "visual_scene_description": [
          {
            "text": "<string>",
            "start_time": 123,
            "end_time": 123
          }
        ],
        "scene_text": [
          {
            "text": "<string>",
            "start_time": 123,
            "end_time": 123
          }
        ],
        "speech": [
          {
            "speaker": "<string>",
            "text": "<string>",
            "start_time": 123,
            "end_time": 123,
            "words": [
              {
                "word": "<string>",
                "start_time": 123,
                "end_time": 123
              }
            ]
          }
        ],
        "audio_description": [
          {
            "text": "<string>",
            "start_time": 123,
            "end_time": 123
          }
        ]
      },
      "error": "<string>",
      "segmentation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "chapters": [
        {
          "index": 1,
          "start_time": 1,
          "end_time": 1,
          "description": "<string>"
        }
      ],
      "shots": [
        {
          "index": 1,
          "start_time": 1,
          "end_time": 1
        }
      ],
      "total_chapters": 1,
      "total_shots": 1,
      "file": {
        "id": "<string>",
        "uri": "<string>",
        "bytes": 123,
        "created_at": 123,
        "filename": "<string>",
        "metadata": {},
        "media_info": {
          "duration_seconds": 123,
          "width": 123,
          "height": 123,
          "sample_rate": 123,
          "channels": 123,
          "bitrate": 123,
          "format": "<string>",
          "has_audio": true
        },
        "video_info": {
          "duration_seconds": 123,
          "height": 123,
          "width": 123,
          "format": "<string>",
          "has_audio": true
        },
        "thumbnail_url": "<string>",
        "source_metadata": {
          "source_type": "grain",
          "grain_recording_id": "<string>",
          "title": "<string>",
          "start_datetime": "2023-11-07T05:31:56Z",
          "end_datetime": "2023-11-07T05:31:56Z",
          "duration_ms": 123,
          "grain_url": "<string>",
          "thumbnail_url": "<string>",
          "tags": [
            "<string>"
          ],
          "teams": [
            {
              "id": "<string>",
              "name": "<string>"
            }
          ],
          "meeting_type": {
            "id": "<string>",
            "name": "<string>",
            "scope": "<string>"
          },
          "participants": [
            {
              "id": "<string>",
              "name": "<string>",
              "email": "<string>",
              "confirmed_attendee": true,
              "hs_contact_id": "<string>"
            }
          ],
          "highlights": [
            {}
          ],
          "ai_summary": {
            "text": "<string>"
          },
          "ai_action_items": [
            {
              "timestamp_ms": 123,
              "text": "<string>",
              "assignee": {
                "id": "<string>",
                "name": "<string>",
                "user_id": "<string>"
              }
            }
          ],
          "ai_template_sections": [
            {}
          ],
          "calendar_event": {
            "ical_uid": "<string>"
          },
          "hubspot": {
            "hubspot_company_ids": [
              "<string>"
            ],
            "hubspot_deal_ids": [
              "<string>"
            ]
          }
        }
      }
    }
  ],
  "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

segmentation_id · string<uuid> · required

The ID of the segmentation job

Query Parameters

include_data · boolean

Include the describe data in the response. If false, only job information is returned. Defaults to false.

response_format · enum<string>

Output format for the describe data

Available options: json, markdown

limit · integer

Number of items to return

Required range: 1 <= x <= 100

offset · integer

Offset from the start of the list

Required range: x >= 0

include_metadata · boolean · default: false

Include the file's user-defined metadata and source metadata. In markdown these render as a ## Metadata section; in JSON they populate file.metadata and file.source_metadata.

Response

200

application/json

List of describe outputs for the segmentation

object · enum<string> · required

Object type, always 'list'

Available options: list

data · object[] · required

Array of describe job objects

Show child attributes

total · integer · required

Total number of describe jobs matching the query

limit · integer · required

Number of items returned in this response

offset · integer · required

Offset from the start of the list