Skip to main content
GET
/
extract
List all extract jobs
curl --request GET \
  --url https://api.cloudglue.dev/v1/extract \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "job_id": "<string>",
      "status": "pending",
      "url": "<string>",
      "created_at": 123,
      "extract_config": {
        "prompt": "<string>",
        "schema": {},
        "enable_video_level_entities": false,
        "enable_segment_level_entities": true
      },
      "segmentation_id": "<string>",
      "data": {
        "entities": {},
        "segment_entities": [
          {
            "start_time": 123,
            "end_time": 123,
            "entities": {}
          }
        ]
      },
      "total": 123,
      "limit": 123,
      "offset": 123,
      "error": "<string>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:50

Maximum number of extract jobs to return

Required range: x <= 100
​
offset
integer
default:0

Number of extract jobs to skip

​
status
enum<string>

Filter extract jobs by status

Available options:
pending,
processing,
completed,
failed,
not_applicable
​
created_before
string<date>

Filter extract jobs created before a specific date (YYYY-MM-DD format), in UTC timezone

​
created_after
string<date>

Filter extract jobs created after a specific date (YYYY-MM-DD format), in UTC timezone

​
url
string

Filter extract jobs by the input URL used for extraction

​
include_data
boolean
default:true

Include the data in the response. If false, the response will only include the job information and not the data to minimize the response size.

Response

A list of extract jobs

​
object
enum<string>
required

Object type, always 'list'

Available options:
list
​
data
object[]
required

Array of extract job objects

​
total
integer
required

Total number of extract jobs matching the query

​
limit
integer
required

Number of items returned in this response

​
offset
integer
required

Offset from the start of the list