HirePlus Docs

Get analysis status

GET
/v1/analyses/{id}/status

Check whether an analysis has completed processing. Useful for polling in asynchronous workflows. Returns the current status along with timestamps.

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication. Pass your key in the x-api-key request header.

In: header

Path Parameters

id*string

Analysis ID returned by POST /v1/analyses

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://next.hireplus.ai/api/v1/analyses/123/status"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "processing",
  "created_at": "string",
  "completed_at": "string"
}
{
  "error": "Invalid request parameters"
}
{
  "error": "Invalid or expired API key"
}
{
  "error": "API key does not have required scope"
}
{
  "error": "string"
}
{
  "error": "Rate limit exceeded. Max 100 requests per minute."
}
{
  "error": "Internal server error"
}