Skip to content
Wazapin
Esc
↑↓navigate↵open⌘Jpreview

Get AI agent

GET/v1/ai/agents/{agentID}
Authorization
bearerAuthbearerAuthrequired
or
apiKeyAuthapiKeyAuthrequired
Path parameters
agentIDstringrequired
Responses
200OK
actionsAgentActionsSummaryViewrequired
Show properties
enabledCountinteger<int64>required
summarystringrequired
totalCountinteger<int64>required
analyticsAgentAnalyticsSummaryViewrequired
Show properties
agent_idstringrequired
avgFirstResponseSecondsnumber<double>required
blockedRatenumber<double>required
conversationsResolvedinteger<int64>required
csatScorenumber<double>required
handoffRatenumber<double>required
knowledge_source_countinteger<int64>required
last_deployment_atstring
latestInspectionsAnswerInspectionSample[] | null
Show properties
Array of AnswerInspectionSample
chunk_countinteger<int64>
chunk_idsstring[] | null
created_atstring
routestring
run_idstringrequired
skill_keystring
toolsstring[] | null
validate_okboolean
validate_reasonstring
latest_knowledge_gapsKnowledgeGap[] | nullrequired
Show properties
Array of KnowledgeGap
agent_idstringrequired
created_atstringrequired
idstringrequired
querystringrequired
reasonstringrequired
statusstringrequired
suggested_contentstringrequired
suggested_titlestringrequired
open_issue_countinteger<int64>required
open_knowledge_gap_countinteger<int64>required
pass_ratenumber<double>required
passed_test_run_countinteger<int64>required
playbook_countinteger<int64>required
resolutionOutcomesobject
summarystringrequired
test_run_countinteger<int64>required
briefAgentBriefViewrequired
Show properties
agent_idstringrequired
audiencestringrequired
business_contextstringrequired
escalationPolicystringrequired
escalation_policyobjectrequired
guardrailRulesstring[] | nullrequired
guardrailsobjectrequired
objectivestringrequired
response_styleobjectrequired
tonestringrequired
updated_atstringrequired
updated_bystring
channelLabelstringrequired
created_atstringrequired
created_bystring
default_localestringrequired
deploymentAgentDeploymentSummaryViewrequired
Show properties
environmentstringrequired
statusstringrequired
summarystringrequired
updatedAtstring
updatedBystring
versionLabelstringrequired
descriptionstring
idstringrequired
knowledgeAgentKnowledgeSummaryViewrequired
Show properties
indexedChunksinteger<int64>required
lastIndexedAtstring
sourceCountinteger<int64>required
summarystringrequired
modelstringrequired
namestringrequired
organization_idstringrequired
ownerNamestringrequired
playbooksAgentPlaybooksSummaryViewrequired
Show properties
activeCountinteger<int64>required
summarystringrequired
totalCountinteger<int64>required
providerstringrequired
published_deployment_idstring
runtime_modestringrequired
statusstringrequired
summarystringrequired
testingAgentTestingSummaryViewrequired
Show properties
latestRunAgentTestRunSummaryView
Show properties
coverageRatenumber<double>required
createdAtstringrequired
idstringrequired
notesstring[] | nullrequired
scorenumber<double>required
statusstringrequired
summarystringrequired
summarystringrequired
updated_atstringrequired
400Bad Request
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
401Unauthorized
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
403Forbidden
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
404Not Found
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
422Unprocessable Entity
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
500Internal Server Error
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
Request
curl -X GET "/v1/ai/agents/string"
Response
{
  "actions": {
    "enabledCount": 0,
    "summary": "string",
    "totalCount": 0
  },
  "analytics": {
    "agent_id": "string",
    "avgFirstResponseSeconds": 0,
    "blockedRate": 0,
    "conversationsResolved": 0,
    "csatScore": 0,
    "handoffRate": 0,
    "knowledge_source_count": 0,
    "last_deployment_at": "string",
    "latestInspections": [
      {
        "chunk_count": 0,
        "chunk_ids": [
          "string"
        ],
        "created_at": "string",
        "route": "string",
        "run_id": "string",
        "skill_key": "string",
        "tools": [
          "string"
        ],
        "validate_ok": true,
        "validate_reason": "string"
      }
    ],
    "latest_knowledge_gaps": [
      {
        "agent_id": "string",
        "created_at": "string",
        "id": "string",
        "query": "string",
        "reason": "string",
        "status": "string",
        "suggested_content": "string",
        "suggested_title": "string"
      }
    ],
    "open_issue_count": 0,
    "open_knowledge_gap_count": 0,
    "pass_rate": 0,
    "passed_test_run_count": 0,
    "playbook_count": 0,
    "resolutionOutcomes": {},
    "summary": "string",
    "test_run_count": 0
  },
  "brief": {
    "agent_id": "string",
    "audience": "string",
    "business_context": "string",
    "escalationPolicy": "string",
    "escalation_policy": {},
    "guardrailRules": [
      "string"
    ],
    "guardrails": {},
    "objective": "string",
    "response_style": {},
    "tone": "string",
    "updated_at": "string",
    "updated_by": "string"
  },
  "channelLabel": "string",
  "created_at": "string",
  "created_by": "string",
  "default_locale": "string",
  "deployment": {
    "environment": "string",
    "status": "string",
    "summary": "string",
    "updatedAt": "string",
    "updatedBy": "string",
    "versionLabel": "string"
  },
  "description": "string",
  "id": "string",
  "knowledge": {
    "indexedChunks": 0,
    "lastIndexedAt": "string",
    "sourceCount": 0,
    "summary": "string"
  },
  "model": "string",
  "name": "string",
  "organization_id": "string",
  "ownerName": "string",
  "playbooks": {
    "activeCount": 0,
    "summary": "string",
    "totalCount": 0
  },
  "provider": "string",
  "published_deployment_id": "string",
  "runtime_mode": "string",
  "status": "string",
  "summary": "string",
  "testing": {
    "latestRun": {
      "coverageRate": 0,
      "createdAt": "string",
      "id": "string",
      "notes": [
        "string"
      ],
      "score": 0,
      "status": "string",
      "summary": "string"
    },
    "summary": "string"
  },
  "updated_at": "string"
}