IntegrationsApi reference

Get job status (for async jobs)

Check the current status of an asynchronous document parsing job.

Job Statuses:

pending: Job is queued and waiting to be processed
running: Job is currently being processed
completed: Job finished successfully, results are available
failed: Job failed due to an error

Polling Recommendations:

Check status every 5-10 seconds for small files
Check status every 15-20 seconds for larger files
Stop polling once status is completed or failed

Authorization

API Key Authentication

X-API-KEY<token>

Enter your secret API key to authorise requests.

You can obtain your key by contacting us: gian@dionitech.com

**Example**: `sk_live_12345abcde...`

In: header

Path Parameters

job_id*Job Id

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

curl -X GET "https://loading/v1/parse/string/status"

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "pending"
}

Empty

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get job results (for async jobs) GET

Retrieve the parsed results from a completed asynchronous job. **Prerequisites:** - Job must have `completed` status (check via `/status` endpoint) - Job must belong to your API key **Response Structure:** The results contain structured candidate information including: - Personal details (name, contact information) - Work experience and employment history - Education background - Skills and competencies - Additional parsed fields based on document content

Performs a Health Check GET

Perform a comprehensive health check of the API and its dependencies. Verifies: - API service availability - Database connectivity - Core system components Returns HTTP 200 if all systems are operational, HTTP 503 if any critical component is unavailable.