Get Segment Describe

Get a specific describe output for a file segment by job ID

GET /files/{file_id}/segments/{segment_id}/describes/{job_id}

Get describe for a file segment

cURL

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

import requests

url = "https://api.cloudglue.dev/v1/files/{file_id}/segments/{segment_id}/describes/{job_id}"

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}/segments/{segment_id}/describes/{job_id}', 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}/segments/{segment_id}/describes/{job_id}",
  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}/segments/{segment_id}/describes/{job_id}"

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

require 'uri'
require 'net/http'

url = URI("https://api.cloudglue.dev/v1/files/{file_id}/segments/{segment_id}/describes/{job_id}")

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

{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "describe_config": {
    "enable_summary": true,
    "enable_speech": true,
    "enable_visual_scene_description": true,
    "enable_scene_text": true,
    "enable_audio_description": true
  },
  "created_at": 123,
  "start_time": 123,
  "end_time": 123,
  "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "segment_describe",
  "completed_at": 123,
  "segmentation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "visual_scene_description": [
      {
        "text": "<string>",
        "start_time": 123,
        "end_time": 123
      }
    ],
    "speech": [
      {
        "text": "<string>",
        "start_time": 123,
        "end_time": 123,
        "speaker": "<string>"
      }
    ],
    "scene_text": [
      {
        "text": "<string>",
        "start_time": 123,
        "end_time": 123
      }
    ],
    "audio_description": [
      {
        "text": "<string>",
        "start_time": 123,
        "end_time": 123
      }
    ],
    "title": "<string>",
    "summary": "<string>",
    "start_time": 123,
    "end_time": 123,
    "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

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

segment_id · string<uuid> · required

The ID of the segment

job_id · string<uuid> · required

The ID of the describe job

Query Parameters

response_format · enum<string>

Output format for the describe data

Available options: json, markdown

Response

200

application/json

Describe for the segment

Describe output for a specific video segment

job_id · string<uuid> · required

The ID of the describe job

segment_id · string<uuid> · required

The ID of the video segment

status · enum<string> · required

Status of the describe job

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

describe_config · object · required

Configuration for media description from videos

Show child attributes

created_at · integer · required

Unix timestamp in milliseconds when the job was created

start_time · number · required

Start time of the segment in seconds

end_time · number · required

End time of the segment in seconds

file_id · string<uuid> · required

The ID of the file

object · enum<string> · required

Object type

Available options: segment_describe

completed_at · integer

Unix timestamp in milliseconds when the job completed

segmentation_id · string<uuid>

The ID of the segmentation job

data · object

The describe output data. When response_format=json, contains visual_scene_description, speech, scene_text, and audio_description arrays. When response_format=markdown, contains a content string.

Option 1

Option 2

Show child attributes