Skip to content
LionrapidLionRapid Docs

Get Document Parse Status

GET
/documents/parse/{task_id}
curl --request GET \
  --url https://example.com/documents/parse/example \
  --header 'Authorization: Bearer <token>'

Poll the status of a document parse job submitted via POST /documents/parse.

Returns: status=pending — queued, waiting for worker status=started — worker is processing (warmup or active parsing) status=completed — markdown and content_list are populated status=failed — error contains failure details

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
task_id
required
Task Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
DocumentParseStatus
object
task_id
required
Task Id

Celery task ID

string
status
required
Status

Task status: pending, started, completed, failed

string
markdown
Any of:
string
content_list
Any of:
Array<object>
object
key
additional properties
any
model_used
Any of:
string
processing_time_ms
Any of:
integer
error
Any of:
string
Examplegenerated
{
  "task_id": "example",
  "status": "example",
  "markdown": "example",
  "content_list": [
    {}
  ],
  "model_used": "example",
  "processing_time_ms": 1,
  "error": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}