Retrieve Agent Action

Retrieve the details of a specific agent action.

GET/api/{version}/services/ai/agent_action/{agent_name}/{actionName}

Headers

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

URI Path Parameters

Name	Description
`{agent_name}`	The name of the agent to retrieve. For example, `promomats_document_chat__v`.
`{action_name}`	The name of the action to retrieve. For example, `spelling_grammar__v`.

Request

curl --location 'https://myvault.veevavault.com/api/v25.2/services/ai/agent_action/quick_check__v/spelling_grammar__v' \
--header 'Accept: application/json' \
--header 'Authorization: {SESSION_ID}' \
--header 'X-VaultAPI-ClientID: veeva-vault-api-reference-example'

Response

{
   "responseStatus": "SUCCESS",
   "agentAction": {
       "name": "spelling_grammar__v",
       "label": "Spelling and Grammar",
       "active": true,
       "source": "standard",
       "description": "Performs a mechanical proofreading check on the document. Identifies spelling errors, typos, malformed technical terminology, and structural grammatical faults (syntax, morphology, and punctuation). Focuses strictly on linguistic accuracy and reading flow, leveraging domain-specific medical knowledge to identify technical errors while ignoring regulatory or scientific validity.",
       "supportChat": false,
       "toolEvaluation": "AUTO"
   }
}

Response Details

On SUCCESS, the response contains details about the specified agent and each action it can perform.