Skip to Content
AgentFlow
API referenceAi agentRequests

Get Request

POST
/ai-agent/getRequest

Request Body

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

Response Body

OK

application/json
  1. response
id*string
Length1 <= length
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
deletedAt*|null
meta*
externalRequestId*string
Length1 <= length
version*integer
Range-9007199254740991 <= value <= 9007199254740991
workflowKey*string
Length1 <= length
status*string
Value in"pending""opened""decision_in_progress""verification_required""approved""rejected""changes_requested""expired""cancelled""failed"
title*string
Length1 <= length
actionType*string
Length1 <= length
actionSummary*string
Length1 <= length
agent*
risk*
requester*
target*
decisionRule*
receivedAt*string
Formatdate-time
expiresAt*string
Formatdate-time
contentHash*string
Length1 <= length
locationContext*
timeWindowContext*
Example Request
curl -X POST 'http://localhost:4000/api/v1/ai-agent/getRequest' \  -H 'Content-Type: application/json' \  -d '{  "requestId": "string"}'
Example Response
{  "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  }}