GET
/
v1
/
async
/
result
/
{task_id}
curl --request GET \
  --url https://api.aryn.cloud/v1/async/result/{task_id} \
  --header 'Authorization: Bearer <token>'
{
  "status": [
    "<string>"
  ],
  "status_code": 123,
  "error": "<string>",
  "elements": [
    {
      "type": "<string>",
      "bbox": [
        123
      ],
      "properties": {},
      "text_representation": "<string>"
    }
  ],
  "markdown": "<string>"
}

This is the Aryn DocParse API for polling the status of an async task and getting its result when its done. For example, you can use the async partition submit API to submit a document to be partitioned (and optionally chunked) asynchronously.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
User-Agent
string | null

Path Parameters

​
task_id
string
required

Query Parameters

​
path_filter
enum<string>
required
Available options:
^/v1/document/partition$

Response

200
application/json
Successful Response
​
status
string[]
required
​
status_code
integer
required
​
elements
object[] | null
required
​
markdown
string | null
required
​
error
string | null

The error message if the partitioning is not successful.

Was this page helpful?

Async Partition SubmitAsync Partition Cancel