Skip to main content
POST
https://api.documind.xyz
/
run-job
Create Extraction Job
curl --request POST \
  --url https://api.documind.xyz/run-job \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file": "<string>",
  "schema": [
    {
      "name": "<string>",
      "description": "<string>",
      "type": "<string>",
      "values": [
        "<string>"
      ],
      "children": [
        {
          "name": "<string>",
          "description": "<string>",
          "type": "<string>",
          "values": [
            "<string>"
          ]
        }
      ]
    }
  ]
}
'
{
  "id": "<string>",
  "createdAt": "<string>",
  "status": "<string>",
  "pages": 123,
  "fileName": "<string>",
  "result": "<string>",
  "urls": {}
}

​
Body

​
file
string
required
The file URL.
​
schema
object[]
required
The schema that defines the structure of the data you want to extract

​
Response

​
id
string
The unique id of the extraction job.
​
createdAt
string
Date and time when the job was created.
​
status
string
Status of the job. At the point of the job creation, this will be CREATED.
​
pages
number
Number of pages in the document processed.
​
fileName
string
The file URL.
​
result
string
The result of the extracted job. At the point of job creation, this will be null.
​
urls
object
The full endpoint url to poll for the results of the job.