Run Job

POST 
/api/v1/extractionv2/jobs

Run Job

Request

Cookie Parameters

session any

application/json

Body

required

extraction_agent_id uuidrequired

The id of the extraction agent

file_id uuidrequired

The id of the file

data_schema_override

object

The data schema to override the extraction agent's data schema with

anyOf

MOD1

property name*

object

anyOf

MOD1

object

MOD2

Array [

]

MOD3

string

MOD4

integer

MOD5

number

MOD6

boolean

config_override

object

The config to override the extraction agent's config with

anyOf

ExtractConfig

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

Responses

200

Successful Response

application/json

Schema

Schema

id uuidrequired

The id of the extraction job

extraction_agent

object

required

Schema and configuration for creating an extraction agent.

id uuidrequired

The id of the extraction agent.

name Name (string)required

The name of the extraction agent.

project_id uuidrequired

The ID of the project that the extraction agent belongs to.

data_schema

object

required

The schema of the data.

property name*

object

anyOf

MOD1

object

MOD2

Array [

]

MOD3

string

MOD4

integer

MOD5

number

MOD6

boolean

config

object

required

The configuration 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

created_at

object

The creation time of the extraction agent.

anyOf

MOD1

string

updated_at

object

The last update time of the extraction agent.

anyOf

MOD1

string

status StatusEnum (string)required

Enum for representing the status of a job

Possible values: [PENDING, SUCCESS, ERROR, PARTIAL_SUCCESS, CANCELLED]

error

object

The error that occurred during 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

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "extraction_agent": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "data_schema": {},
    "config": {
      "extraction_mode": "PER_DOC",
      "handle_missing": false,
      "system_prompt": "string"
    },
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
  },
  "status": "PENDING",
  "error": "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"
  }
}

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"
    }
  ]
}