ADE Get Parse Jobs

Python

import requests

url = 'https://api.ade.landing.ai/v2/parse/jobs/JOB_ID'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}

response = requests.get(url, headers=headers)
print(response.json())

const axios = require('axios');

axios.get('https://api.ade.landing.ai/v2/parse/jobs/JOB_ID', {
  headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
})
  .then(response => console.log(response.data))
  .catch(error => console.error(error));

{
  "job_id": "<string>",
  "created_at": "<string>",
  "completed_at": "<string>",
  "progress": 123,
  "result": {
    "markdown": "<string>",
    "metadata": {
      "job_id": "<string>",
      "model_version": "<string>",
      "page_count": 123,
      "output_markdown_chars": 123,
      "range_units": "<string>",
      "openapi_spec": "<string>",
      "failed_pages": [
        123
      ],
      "duration_ms": 123,
      "billing": {
        "total_credits": 123
      }
    },
    "structure": {
      "type": "document",
      "children": [
        {
          "grounding": {
            "page": 123,
            "range": {
              "start": 123,
              "end": 123
            },
            "box": {
              "xmin": 123,
              "ymin": 123,
              "xmax": 123,
              "ymax": 123
            }
          },
          "type": "page",
          "status": "ok",
          "reason": "<string>",
          "children": [
            {
              "id": "<string>",
              "grounding": {
                "page": 123,
                "range": {
                  "start": 123,
                  "end": 123
                },
                "box": {
                  "xmin": 123,
                  "ymin": 123,
                  "xmax": 123,
                  "ymax": 123
                }
              },
              "atomic_grounding": [
                {
                  "page": 123,
                  "range": {
                    "start": 123,
                    "end": 123
                  },
                  "box": {
                    "xmin": 123,
                    "ymin": 123,
                    "xmax": 123,
                    "ymax": 123
                  }
                }
              ],
              "children": [
                "<unknown>"
              ],
              "markdown": "<string>",
              "row": 123,
              "col": 123,
              "colspan": 123,
              "rowspan": 123
            }
          ],
          "markdown": "<string>"
        }
      ],
      "markdown": "<string>"
    }
  },
  "output_url": "<string>",
  "metadata": {
    "job_id": "<string>",
    "model_version": "<string>",
    "page_count": 123,
    "output_markdown_chars": 123,
    "range_units": "<string>",
    "openapi_spec": "<string>",
    "failed_pages": [
      123
    ],
    "duration_ms": 123,
    "billing": {
      "total_credits": 123
    }
  },
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

GET

parse

jobs

{job_id}

Python

import requests

url = 'https://api.ade.landing.ai/v2/parse/jobs/JOB_ID'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}

response = requests.get(url, headers=headers)
print(response.json())

const axios = require('axios');

axios.get('https://api.ade.landing.ai/v2/parse/jobs/JOB_ID', {
  headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
})
  .then(response => console.log(response.data))
  .catch(error => console.error(error));

{
  "job_id": "<string>",
  "created_at": "<string>",
  "completed_at": "<string>",
  "progress": 123,
  "result": {
    "markdown": "<string>",
    "metadata": {
      "job_id": "<string>",
      "model_version": "<string>",
      "page_count": 123,
      "output_markdown_chars": 123,
      "range_units": "<string>",
      "openapi_spec": "<string>",
      "failed_pages": [
        123
      ],
      "duration_ms": 123,
      "billing": {
        "total_credits": 123
      }
    },
    "structure": {
      "type": "document",
      "children": [
        {
          "grounding": {
            "page": 123,
            "range": {
              "start": 123,
              "end": 123
            },
            "box": {
              "xmin": 123,
              "ymin": 123,
              "xmax": 123,
              "ymax": 123
            }
          },
          "type": "page",
          "status": "ok",
          "reason": "<string>",
          "children": [
            {
              "id": "<string>",
              "grounding": {
                "page": 123,
                "range": {
                  "start": 123,
                  "end": 123
                },
                "box": {
                  "xmin": 123,
                  "ymin": 123,
                  "xmax": 123,
                  "ymax": 123
                }
              },
              "atomic_grounding": [
                {
                  "page": 123,
                  "range": {
                    "start": 123,
                    "end": 123
                  },
                  "box": {
                    "xmin": 123,
                    "ymin": 123,
                    "xmax": 123,
                    "ymax": 123
                  }
                }
              ],
              "children": [
                "<unknown>"
              ],
              "markdown": "<string>",
              "row": 123,
              "col": 123,
              "colspan": 123,
              "rowspan": 123
            }
          ],
          "markdown": "<string>"
        }
      ],
      "markdown": "<string>"
    }
  },
  "output_url": "<string>",
  "metadata": {
    "job_id": "<string>",
    "model_version": "<string>",
    "page_count": 123,
    "output_markdown_chars": 123,
    "range_units": "<string>",
    "openapi_spec": "<string>",
    "failed_pages": [
      123
    ],
    "duration_ms": 123,
    "billing": {
      "total_credits": 123
    }
  },
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

Path Parameters

job_id

string

required

The identifier of the job to retrieve, as returned by the create-job request.

Response

Job status / result

job_id

string

The unique identifier for this parse job. Format: <service>-<26-character Crockford base32 ULID> matching ^(parse|extract)-[0-9a-hjkmnp-tv-z]{26}$. Opaque, server-minted, and stable for the life of the job — the same id is returned on the sync response, the async 202, and every poll. Treat it as opaque; older id formats remain accepted indefinitely and are never re-issued.

status

enum<string>

The job's current status: pending, processing, completed, or failed.

Available options:

pending,

processing,

completed,

failed

created_at

string | null

ISO-8601 timestamp for when the job was created.

completed_at

string

ISO-8601 timestamp; present once the job is terminal.

progress

number

Job completion as a decimal from 0 (not started) to 1 (complete). Present while processing.

result

ParseResponse · object | null

The parse response, present once the job has completed and output_save_url was not set. When output_save_url was set, the result is delivered there and output_url is returned instead.

Show child attributes

output_url

string | null

The URL the result was delivered to. Present once the job has completed and output_save_url was set, instead of inline result.

metadata

ParseMetadata · object | null

The parse metadata (billing included), present alongside output_url once a job with output_save_url has completed — the delivery moves the content, not the receipt. Inline jobs carry it inside result instead.

Show child attributes

error

object

Present once the job has failed — the failure code + message.

Show child attributes

⌘I