talentkiwi
IntegrationsApi reference

Performs a Health Check

GET
/health

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.

Response Body

application/json

curl -X GET "https://loading/health"
null

Get job status (for async jobs) GET

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`

Root GET

Get basic information about the API instance. Returns application metadata including version, name, and deployment information. Useful for verifying API connectivity and version compatibility.