Create Extraction Agent

POST 
/api/v1/extractionv2/extraction_agent

Create Extraction Agent

Request

Query Parameters

project_id any
organization_id any

Cookie Parameters

session any

application/json

Body

required

name Name (string)required

The name of the extraction schema

Possible values: non-empty and <= 3000 characters

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

Responses

200

Successful Response

application/json

Schema

Schema

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

Example (from schema)

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

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