Retrieve Agent

Retrieve details of the specified agent, including all of the agent’s actions.

GET/api/{version}/services/ai/agents/{agent_name}

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`.

Request

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

Response

{
    "responseStatus": "SUCCESS",
    "agent": {
        "name": "quick_check__v",
        "label": "Quick Check",
        "status": true,
        "agentClass": "com.veeva.vault.system.agent.BaseDocumentAgent",
        "documentType": "base_document__v",
        "description": "Performs automated compliance and quality checks on documents in regulated industries to support faster, smoother MLR review. Identifies issues in areas such as important safety information (ISI), boxed warnings, privacy and unsubscribe links, spelling, grammar, accessibility, and risky phrase assessment. Use only for structured document quality checks, not general Q&A.",
        "source": "standard",
        "agentUser": "[agent]quick_check__v",
        "agentModelLevel": "ADVANCED",
        "actions": [
            {
                "name": "spelling_grammar__v",
                "label": "Spelling and Grammar",
                "url": "/api/v25.2/services/ai/agent_action/quick_check__v/spelling_grammar__v"
            },
            {
                "name": "privacy__v",
                "label": "Privacy Policy Link",
                "url": "/api/v25.2/services/ai/agent_action/quick_check__v/privacy__v"
            },
            {
                "name": "phrase_assessment__v",
                "label": "Phrase Assessment",
                "url": "/api/v25.2/services/ai/agent_action/quick_check__v/phrase_assessment__v"
            },
            {
                "name": "boxed_warning_detect__v",
                "label": "Boxed Warning Detect",
                "url": "/api/v25.2/services/ai/agent_action/quick_check__v/boxed_warning_detect__v"
            },
            {
                "name": "boxed_warning_assessment__v",
                "label": "Boxed Warning Assessment",
                "url": "/api/v25.2/services/ai/agent_action/quick_check__v/boxed_warning_assessment__v"
            }
        ]
    }
}

Response Details

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