CLcloudglue
Files
File Segments
Describe

List describes for a file segment

Changed on

List all describe outputs for a specific file segment

get/files/{file_id}/segments/{segment_id}/describes

Request

  • Base URL
    https://api.cloudglue.dev/v1
  • Auth
    HTTP bearer

Path parameters

file_idstring uuid required

The ID of the file

segment_idstring uuid required

The ID of the segment

Query parameters

statusstring

Filter by job status. Supports comma-separated values (e.g., 'completed,processing'). Defaults to 'completed'.

response_format'json' | 'markdown'

Output format for the describe data

include_databoolean

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

limitinteger

Number of items to return

offsetinteger

Offset from the start of the list

Response

List of describes for the segment

object'list' required

Object type, always 'list'

totalinteger required

Total number of describe jobs for this segment

limitinteger required

Number of items returned in this response

offsetinteger required

Offset from the start of the list

Changes