Run Job

POST 
/api/v1/extraction/jobs

Run Job

Request

Cookie Parameters

session any

application/json

Body

required

schema_id uuidrequired

The id of the schema

file_id uuidrequired

The id of the file

Responses

200

Successful Response

application/json

Schema

Schema

id uuidrequired

The id of the extraction job

status StatusEnum (string)required

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

Enum for representing the status of a job

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

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

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",
  "status": "PENDING",
  "file": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2024-10-03T01:48:33.898Z",
    "updated_at": "2024-10-03T01:48:33.898Z",
    "name": "string",
    "file_size": 0,
    "file_type": "string",
    "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "last_modified_at": "2024-10-03T01:48:33.898Z",
    "resource_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"
    }
  ]
}

Loading...