Cancel Agent Action Execution

Request the cancellation of an in-progress agent action.

POST/api/{version}/services/ai/agent_actions/actions/cancel

Headers

Name	Description
`Accept`	`application/json` (default) or `application/xml`
`Content-Type`	`application/json`

Body Parameters

In the body of the request, include a JSON object with the following:

Name	Description
`execution_id` required	The execution ID of the agent action to cancel.

Request

curl --location 'https://myvault.veevavault.com/api/v25.2/services/ai/agent_actions/actions/cancel' \
--header 'Accept: application/json' \
--header 'Authorization: {SESSION_ID}' \
--header 'X-VaultAPI-ClientID: veeva-vault-api-reference-example' \
--header 'Content-Type: application/json' \
--data '    {
       "execution_id": "VAB000000001003"
   }'

Response

{
   "responseStatus": "SUCCESS",
   "data": {
       "actionStatus": "SUBMITTED",
       "executionId": "VAB000000001003"
   }
}

Response Details

On SUCCESS, the response returns the submitted execution ID and provides the status.