VeristageDevelopers
Jobs

Poll one job

GET/jobs/{ref}

Returns the current state of a job the caller owns. A job belonging to another user (or that does not exist) returns 404 NOT_FOUND — the two cases are deliberately indistinguishable. Requires the read scope.

Authorization

apiKey
X-Api-Key<token>

Issued to you when your integration is provisioned. Determines which catalogue resources are visible and which AI tools are available.

In: header

Path Parameters

ref*integer

Numeric job reference returned by POST /jobs.

Range1 <= value

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/jobs/1"
{  "data": {    "result": "Report ready",    "error": "Ran out of tokens"  }}
{  "success": false,  "status": "fail",  "message": "string",  "error": {    "message": "API key is required",    "code": "NO_API_KEY"  }}

{  "success": false,  "status": "fail",  "message": "API key is required",  "error": {    "code": "NO_API_KEY",    "message": "API key is required"  }}

{  "success": false,  "status": "fail",  "message": "This API key does not have the 'write' scope",  "error": {    "code": "INSUFFICIENT_SCOPE",    "message": "This API key does not have the 'write' scope"  }}

{  "success": false,  "status": "fail",  "message": "string",  "error": {    "message": "API key is required",    "code": "NO_API_KEY"  }}

Inspect the api-key and its scope GET

Returns the identity of the api-key holder and, when the key has catalogue access, the access scope (group + permissions). Use this as the first call from any new integration to verify the key is active (`cmsAccess: true`) and that `imageProviderDefault` matches what you expect.

List the linked user's recent jobs GET

Returns jobs submitted by this api-key's linked service user, newest first. Only the caller's own jobs are visible. Requires the `read` scope.