Retrieve Agent Action Execution Status

Retrieve the status of an executed agent action. Requires at least one query parameter, execution_id or external_id, to identify the action.

GET/api/{version}/services/ai/agent_actions/status

Headers

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

Query Parameters

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

Name	Description
`execution_id` conditional	Required if `external_id` is not specified. The execution ID of the agent action. Returned as `executionId` from the Execute Agent Action request.
`external_id` conditional	Required if `execution_id` is not specified. The external ID of the agent action execution. Returned as `externalId` from the Execute Agent Action request.

Request

curl --location 'https://myvault.veevavault.com/api/v25.2/services/ai/agent_actions/status?execution_id=VAB000000003001' \
--header 'Accept: application/json' \
--header 'Authorization: {SESSION_ID}' \
--header 'X-VaultAPI-ClientID: veeva-vault-api-reference-example'

Response

{
   "responseStatus": "SUCCESS",
   "actionResponse": {
       "actionStatus": "SUCCESS",
       "executionId": "VAB000000003002",
       "agentAction": "quick_check__v.spelling_grammar__v",
       "actionOutputs": [
           {
               "type": "text",
               "value": "```json\n{\n  \"thinking\": \"Document Language: US English (confirmed by '$' symbol, MM/DD date format, 'color' spelling, and FDA-style regulatory language). Allowed Lexicon: Pharmaceutical (Human) / FDA / Patient-facing consumer content; accepting brand names (BenzaClin, Viscontour), medical terms (clindamycin, benzoyl peroxide, androgens, inflammatory acne), and creative fragments typical of patient brochures. Error Density: Moderate—primarily OCR artifacts (stray characters, malformed symbols) and a few genuine spelling/grammar issues (e.g., 'Cornrnon', 'Abqqt', missing space in 'acneheroes,com').\",\n  \"detected_industry\": \"Pharmaceutical (Human)\",\n  \"detected_regulatory_authority\": \"FDA\",\n  \"detected_target_audience\": \"Patient\",\n  \"errors\": [\n    {\n      \"page_number\": 2,\n      \"issue\": \"c1indamycin\",\n      \"error_type\": \"SpellingError\",\n      \"reason\": \"The numeral '1' is incorrectly used instead of the letter 'l'.\",\n      \"suggestion\": \"clindamycin\"\n    },\n    {\n      \"page_number\": 3,\n      \"issue\": \"Its\",\n      \"error_type\": \"GrammarError\",\n      \"reason\": \"Missing apostrophe; should be the contraction 'It's' (It is).\",\n      \"suggestion\": \"It's\"\n    } ] \n}```"
           }
       ]
   }
}

Response Details

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

Name	Description
`actionStatus` conditional	The status of the action. For example, an action which is still in progress returns `IN_PROGRESS`. When complete, the value is `SUCCESS`.
`actionOutputs` conditional	For completed actions with an `actionStatus` of `SUCCESS`, this array contains the action’s output. For example, the text returned to the user in Veeva AI chat.