v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
instances

get async request status

Retrieve the status or result of an async request by its reference UUID. Results are cached for up to 5 minutes after processing.

get/instances/{id}/request/{reference}

Path parameters

idinteger required

Instance ID

referencestring uuid required

Reference UUID returned by an async request

Response

The request result or pending status

status'success' | 'error'

Example response

{
  "data": {
    "status": "pending",
    "message": "request still pending"
  },
  "status": "success"
}