> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloudglue.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# List Segment Describes

> List all describe outputs for a specific file segment



## OpenAPI

````yaml GET /files/{file_id}/segments/{segment_id}/describes
openapi: 3.0.0
info:
  title: Cloudglue API
  description: API for Cloudglue
  license:
    name: Apache License 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 0.7.13
servers:
  - url: https://api.cloudglue.dev/v1
security:
  - bearerAuth: []
paths:
  /files/{file_id}/segments/{segment_id}/describes:
    get:
      tags:
        - Files
        - File Segments
        - Describe
      summary: List describes for a file segment
      description: List all describe outputs for a specific file segment
      operationId: listFileSegmentDescribes
      parameters:
        - name: file_id
          in: path
          required: true
          description: The ID of the file
          schema:
            type: string
            format: uuid
        - name: segment_id
          in: path
          required: true
          description: The ID of the segment
          schema:
            type: string
            format: uuid
        - name: status
          in: query
          description: >-
            Filter by job status. Supports comma-separated values (e.g.,
            'completed,processing'). Defaults to 'completed'.
          required: false
          schema:
            type: string
        - name: response_format
          in: query
          description: Output format for the describe data
          required: false
          schema:
            type: string
            enum:
              - json
              - markdown
        - name: include_data
          in: query
          description: >-
            Include the describe data in the response. If false, only job
            information is returned. Defaults to false.
          required: false
          schema:
            type: boolean
        - name: limit
          in: query
          description: Number of items to return
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
        - name: offset
          in: query
          description: Offset from the start of the list
          required: false
          schema:
            type: integer
            minimum: 0
      responses:
        '200':
          description: List of describes for the segment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SegmentDescribeListResponse'
        '404':
          description: File or segment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    SegmentDescribeListResponse:
      type: object
      description: List of describe outputs for a video segment
      properties:
        object:
          type: string
          enum:
            - list
          description: Object type, always 'list'
        data:
          type: array
          items:
            $ref: '#/components/schemas/SegmentDescribe'
          description: Array of segment describe objects
        total:
          type: integer
          description: Total number of describe jobs for this segment
        limit:
          type: integer
          description: Number of items returned in this response
        offset:
          type: integer
          description: Offset from the start of the list
      required:
        - object
        - data
        - total
        - limit
        - offset
    Error:
      required:
        - error
      type: object
      properties:
        error:
          type: string
    SegmentDescribe:
      type: object
      description: Describe output for a specific video segment
      properties:
        job_id:
          type: string
          format: uuid
          description: The ID of the describe job
        segment_id:
          type: string
          format: uuid
          description: The ID of the video segment
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
            - not_applicable
          description: Status of the describe job
        describe_config:
          $ref: '#/components/schemas/DescribeConfig'
        created_at:
          type: integer
          description: Unix timestamp in milliseconds when the job was created
        completed_at:
          type: integer
          description: Unix timestamp in milliseconds when the job completed
        start_time:
          type: number
          description: Start time of the segment in seconds
        end_time:
          type: number
          description: End time of the segment in seconds
        file_id:
          type: string
          format: uuid
          description: The ID of the file
        segmentation_id:
          type: string
          format: uuid
          description: The ID of the segmentation job
        data:
          oneOf:
            - $ref: '#/components/schemas/SegmentDescribeJsonData'
            - $ref: '#/components/schemas/SegmentDescribeMarkdownData'
          description: >-
            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.
        object:
          type: string
          enum:
            - segment_describe
          description: Object type
      required:
        - job_id
        - segment_id
        - status
        - describe_config
        - created_at
        - start_time
        - end_time
        - file_id
        - object
    DescribeConfig:
      type: object
      description: Configuration for media description from videos
      properties:
        enable_summary:
          type: boolean
          description: >-
            Whether to generate video-level and segment-level (moment-level)
            summaries and titles
        enable_speech:
          type: boolean
          description: Whether to generate speech transcript
        enable_visual_scene_description:
          type: boolean
          description: Whether to generate visual scene description
        enable_scene_text:
          type: boolean
          description: Whether to generate scene text extraction
        enable_audio_description:
          type: boolean
          description: Whether to generate audio description
    SegmentDescribeJsonData:
      type: object
      description: JSON format describe output data
      properties:
        visual_scene_description:
          type: array
          items:
            $ref: '#/components/schemas/SegmentDescribeOutputEntry'
          description: Visual scene descriptions with timestamps
        speech:
          type: array
          items:
            $ref: '#/components/schemas/SegmentDescribeSpeechEntry'
          description: Speech transcript with timestamps and speaker info
        scene_text:
          type: array
          items:
            $ref: '#/components/schemas/SegmentDescribeOutputEntry'
          description: On-screen text detected with timestamps
        audio_description:
          type: array
          items:
            $ref: '#/components/schemas/SegmentDescribeOutputEntry'
          description: Audio descriptions with timestamps
        title:
          type: string
          description: Generated title for the segment
        summary:
          type: string
          description: Generated summary for the segment
        start_time:
          type: number
          description: Start time of the segment in seconds
        end_time:
          type: number
          description: End time of the segment in seconds
        segment_id:
          type: string
          format: uuid
          description: The ID of the segment
    SegmentDescribeMarkdownData:
      type: object
      description: Markdown format describe output data
      properties:
        content:
          type: string
          description: Markdown formatted content containing the describe output
      required:
        - content
    SegmentDescribeOutputEntry:
      type: object
      description: A single describe output entry with timestamp
      properties:
        text:
          type: string
          description: The text content
        start_time:
          type: number
          description: Start time in seconds
        end_time:
          type: number
          description: End time in seconds
      required:
        - text
        - start_time
        - end_time
    SegmentDescribeSpeechEntry:
      type: object
      description: A speech entry with optional speaker information
      properties:
        text:
          type: string
          description: The speech text
        start_time:
          type: number
          description: Start time in seconds
        end_time:
          type: number
          description: End time in seconds
        speaker:
          type: string
          description: Speaker identifier
      required:
        - text
        - start_time
        - end_time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````