Infer Schema

POST 
/api/v1/extraction/schemas/infer

Infer Schema

Request

Cookie Parameters

session any

application/json

Body

required

schema_id

object

The ID of a schema to update with the new schema

anyOf

MOD1

string

name Name (string)required

The name of the extraction schema

Possible values: non-empty and <= 3000 characters

project_id

object

The ID of the project that the extraction schema belongs to

anyOf

MOD1

string

file_ids uuid[]required

The IDs of the files that the extraction schema contains

Possible values: >= 1

stream Stream (boolean)
Whether to stream the results of the extraction schema
Default value: false

Responses

200

Successful Response

application/json

Schema

Schema

id uuidrequired

Unique identifier

created_at

object

Creation datetime

anyOf

MOD1

string

updated_at

object

Update datetime

anyOf

MOD1

string

name Name (string)required

The name of the extraction schema

project_id uuidrequired

The ID of the project that the extraction schema belongs to

data_schema

object

The schema of the data

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",
  "name": "string",
  "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data_schema": {}
}

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

Loading...