Check CV processing status

Check the processing status of one or more CVs by their IDs. Use this endpoint to poll for completion after submitting CVs for analysis. Each requested ID is returned with a per-item status (PENDING, COMPLETED, FAILED, or NOT_FOUND).

POST /cvs/status

Check CV processing status

cURL

curl --request POST \
  --url https://api-service.fribl.co/api/v1/cvs/status \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

200

{
  "message": "<string>",
  "length": 123,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "original_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

x-api-key · string · header · required

API key in UUID format. Include this header with every authenticated request.

Body

application/json

Request body for checking processing status. The ids array must contain at least one identifier — empty arrays are rejected with 400.

ids · string<uuid>[] · required

List of document identifiers to check status for. Must be non-empty.

Minimum array length: 1

Response

200

application/json

Status of the requested CVs.

message · string · required

length · integer · required

Number of status items returned.

data · object[] · required

Show child attributes