Get the status of a task

GET 
/v1/task/:task_id

Get the status of a task (parsing, extraction).

Request

Path Parameters

task_id Task Idrequired

Responses

200

The status of the task.

application/json

Schema

Schema

status ResourceStatus (string)required

Possible values: [COMPLETED, FAILED, BUILDING, WAITING]

The status of the task.

error

object

An error message if the task failed.

anyOf

MOD1

string

result

object

The result of the task.

anyOf

CompletedTaskResponse

task_id Task Id (string)required

The ID of the task.

duration Duration (number)required

The time taken to complete the task, in seconds.

result_url Result Url (string)required

A URL to access the results (e.g., parsed file, extracted information).

Example (from schema)

{
  "status": "COMPLETED",
  "error": "string",
  "result": {}
}

403

The user is not authorized to perform this action.

application/json

Schema

Schema

any

Example (from schema)

{
  "status_code": 403,
  "detail": "The user is not authorized to perform this action."
}

Example

{
  "status_code": 403,
  "detail": "The user is not authorized to perform this action."
}

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...