VirtuousAI
Reference

Approvals

List Approvals

GET
/api/v1/approvals

Query Parameters

status?string

Filter by status (pending, decided)

Default"pending"

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/approvals"
{
  "items": [
    {
      "automationId": "de580a02-68f2-4f04-b675-19968bf358e1",
      "automationName": "string",
      "automationRunId": "4af84d04-01a4-49f4-81d8-0d80347921c3",
      "context": {},
      "decisionType": "approve_reject",
      "description": "string",
      "formSchema": {},
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "requestedAt": "2019-08-24T14:15:22Z",
      "status": "pending",
      "stepKey": "string",
      "title": "string"
    }
  ],
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Approve Decision

POST
/api/v1/approvals/{approval_id}/approve

Path Parameters

approval_id*string
Formatuuid

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Request Body

application/json

formResponse?|

Form data for form_input type

rejectionReason?|

Reason for rejection

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/approvals/497f6eca-6276-4993-bfeb-53cbbbba6f08/approve" \  -H "Content-Type: application/json" \  -d '{}'
{
  "automationId": "de580a02-68f2-4f04-b675-19968bf358e1",
  "automationName": "string",
  "automationRunId": "4af84d04-01a4-49f4-81d8-0d80347921c3",
  "context": {},
  "decisionType": "approve_reject",
  "description": "string",
  "formSchema": {},
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "requestedAt": "2019-08-24T14:15:22Z",
  "status": "pending",
  "stepKey": "string",
  "title": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Reject Decision

POST
/api/v1/approvals/{approval_id}/reject

Path Parameters

approval_id*string
Formatuuid

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Request Body

application/json

formResponse?|

Form data for form_input type

rejectionReason?|

Reason for rejection

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/approvals/497f6eca-6276-4993-bfeb-53cbbbba6f08/reject" \  -H "Content-Type: application/json" \  -d '{}'
{
  "automationId": "de580a02-68f2-4f04-b675-19968bf358e1",
  "automationName": "string",
  "automationRunId": "4af84d04-01a4-49f4-81d8-0d80347921c3",
  "context": {},
  "decisionType": "approve_reject",
  "description": "string",
  "formSchema": {},
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "requestedAt": "2019-08-24T14:15:22Z",
  "status": "pending",
  "stepKey": "string",
  "title": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}