List Extract Runs

GET 
/api/v1/extractionv2/runs

List Extract Runs

Request

Query Parameters

extraction_agent_id any
run_id any
job_id any

Cookie Parameters

session any

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

id uuidrequired

The id of the extraction run

created_at

object

Creation datetime

anyOf

MOD1

string

updated_at

object

Update datetime

anyOf

MOD1

string

extraction_agent_id uuidrequired

The id of the extraction agent

data_schema

object

required

The schema used for extraction

property name*

object

anyOf

MOD1

object

MOD2

Array [

]

MOD3

string

MOD4

integer

MOD5

number

MOD6

boolean

config

object

required

Additional parameters for the extraction agent.

extraction_mode ExtractMode (string)

The extraction mode specified.

Possible values: [PER_DOC, PER_PAGE]

Default value: PER_DOC

handle_missing Handle Missing (boolean)

Whether to handle missing fields in the schema.

Default value: false

system_prompt

object

The system prompt to use for the extraction.

anyOf

MOD1

string

file

object

required

Schema for a file.

id uuidrequired

Unique identifier

created_at

object

Creation datetime

anyOf

MOD1

string

updated_at

object

Update datetime

anyOf

MOD1

string

name Name (string)required

Possible values: non-empty and <= 3000 characters

external_file_id External File Id (string)required

The ID of the file in the external system

file_size

object

Size of the file in bytes

anyOf

MOD1

integer

file_type

object

File type (e.g. pdf, docx, etc.)

anyOf

MOD1

string

Possible values: non-empty and <= 3000 characters

project_id uuidrequired

The ID of the project that the file belongs to

last_modified_at

object

The last modified time of the file

anyOf

MOD1

string

resource_info

object

Resource information for the file

anyOf

MOD1

property name*

object

anyOf

MOD1

object

MOD2

Array [

]

MOD3

string

MOD4

integer

MOD5

number

MOD6

boolean

permission_info

object

Permission information for the file

anyOf

MOD1

property name*

object

anyOf

MOD1

object

MOD2

Array [

]

MOD3

string

MOD4

integer

MOD5

number

MOD6

boolean

data_source_id

object

The ID of the data source that the file belongs to

anyOf

MOD1

string

status ExtractState (string)required

The status of the extraction run

Possible values: [CREATED, PENDING, SUCCESS, ERROR]

error

object

The error that occurred during extraction

anyOf

MOD1

string

job_id

object

The id of the job that the extraction run belongs to

anyOf

MOD1

string

data

object

The data extracted from the file

anyOf

MOD1

property name*

object

anyOf

MOD1

object

MOD2

Array [

]

MOD3

string

MOD4

integer

MOD5

number

MOD6

boolean

extraction_metadata

object

The metadata extracted from the file

anyOf

MOD1

property name*

object

anyOf

MOD1

object

MOD2

Array [

]

MOD3

string

MOD4

integer

MOD5

number

MOD6

boolean

• ]

Example (from schema)

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "extraction_agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "data_schema": {},
    "config": {
      "extraction_mode": "PER_DOC",
      "handle_missing": false,
      "system_prompt": "string"
    },
    "file": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "name": "string",
      "external_file_id": "string",
      "file_size": 0,
      "file_type": "string",
      "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "last_modified_at": "2024-07-29T15:51:28.071Z",
      "resource_info": {},
      "permission_info": {},
      "data_source_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "status": "CREATED",
    "error": "string",
    "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "data": {},
    "extraction_metadata": {}
  }
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}