Skip to Content
AgentFlow
API referenceAi agentRequests

Get Status

POST
/ai-agent/getStatus

Request Body

application/json
  1. body
requestId*string
Length1 <= length

Response Body

OK

application/json
  1. response
request*
isFinal*boolean
deliveryModes*array<>
reviewProgress*
receiptId*string|null
nextPollAfterMs*integer
Range1000 <= value <= 9007199254740991
Example Request
curl -X POST 'http://localhost:4000/api/v1/ai-agent/getStatus' \  -H 'Content-Type: application/json' \  -d '{  "requestId": "string"}'
Example Response
{  "request": {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "deletedAt": "2019-08-24T14:15:22Z",    "meta": {      "property1": null,      "property2": null    },    "externalRequestId": "string",    "version": -9007199254740991,    "workflowKey": "string",    "status": "pending",    "title": "string",    "actionType": "string",    "actionSummary": "string",    "agent": {      "id": "string",      "displayName": "string",      "confidence": 0    },    "risk": {      "level": "low",      "summary": "string",      "reasons": [        "string"      ]    },    "requester": {      "displayName": "string",      "organizationId": "string"    },    "target": {      "displayName": "string",      "organizationId": "string"    },    "decisionRule": {      "allowedOutcomes": [        "approve"      ],      "requiresIdentityVerification": true,      "verificationWindowSeconds": -9007199254740991    },    "receivedAt": "2019-08-24T14:15:22Z",    "expiresAt": "2019-08-24T14:15:22Z",    "contentHash": "string",    "locationContext": {      "captured": true,      "permission": "string"    },    "timeWindowContext": {      "capturedAt": "2019-08-24T14:15:22Z",      "withinWindow": true    }  },  "isFinal": true,  "deliveryModes": [    "polling"  ],  "reviewProgress": {    "assigned": 0,    "completed": 0,    "requiredApprovals": 0,    "quorumReached": true,    "decisions": [      {        "reviewerId": "string",        "displayName": "string",        "outcome": "approve",        "decidedAt": "2019-08-24T14:15:22Z"      }    ]  },  "receiptId": "string",  "nextPollAfterMs": 1000}