Agents

Get agent

Retrieve agent details by its unique key.

Gateway not-found behavior: Unknown agentKey, lookup after soft-delete, and other AI-backend failures that return 404 from the Python query service are surfaced by the Node gateway as HTTP 404 with an ErrorResponse body.

get/agents/{agentKey}

Path parameters

agentKeystring required

Unique agent identifier

Response

Agent details

statusstring required

messagestring required

Example response

{
  "status": "success",
  "message": "Agent retrieved successfully",
  "agent": {
    "_id": "agentInstances/e6f848ca-e2ab-4594-9925-e1136629f474",
    "_key": "e6f848ca-e2ab-4594-9925-e1136629f474",
    "_rev": "_lkNlcOm---",
    "name": "Customer Support Assistant",
    "models": [
      {
        "modelType": "llm",
        "provider": "azureOpenAI",
        "modelName": "gpt-5.4-mini",
        "modelKey": "f3a4b5b6-5b6c-4e85-9097-3202cfe696fc",
        "isMultimodal": true,
        "isReasoning": true,
        "isDefault": true,
        "modelFriendlyName": "GPT 5.4 mini"
      }
    ],
    "webSearch": {
      "provider": "serper"
    },
    "access_type": "INDIVIDUAL",
    "user_role": "OWNER"
  }
}

Changes

Changed in 5 of the 15 revisions of this API.1119

Aug 13, 202657e2b0860dd41See the full diff
- ○
  added the optional property agent/usesOrgDefault to the response with the 200 status
  response-optional-property-added
Aug 12, 202611f5086fcbb81See the full diff
- ○
  added the required property agent/mcpServers to the response with the 200 status
  response-required-property-added
Aug 12, 20265798f431973a22See the full diff
- ●
  added the new confluencedatacenter enum value to the agent/toolsets/items/name/allOf[AgentCreateToolsetName]/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new jiradatacenter enum value to the agent/toolsets/items/name/allOf[AgentCreateToolsetName]/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property agent/defaultReasoningEffort to the response with the 200 status
  response-optional-property-added
- ○
  added the required property agent/skills to the response with the 200 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 29, 2026911a57b55d18115See the full diff
- ▲
  the agent/createdBy response's property type/format changed from string/objectId to string/ for status 200
  response-property-type-changed
- ●
  removed the optional property agent/toolsets/items/iconPath from the response with the 200 status
  response-optional-property-removed
- ○
  added the non-success response with the status 404
  response-non-success-status-added
- ○
  added the optional property agent/toolsets/items/_key to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property agent/toolsets/items/selectedTools to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property agent/toolsets/items/tools/items/_key to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property agent/toolsets/items/tools/items/toolsetName to the response with the 200 status
  response-optional-property-added
Jun 2, 2026665fd5fc34dd8See the full diff
- ●
  removed the optional property agent/agentKey from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property agent/createdAt from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property agent/isPublic from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property agent/knowledgeBases from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property agent/modelConfig from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property agent/orgId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property agent/tools from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property agent/updatedAt from the response with the 200 status
  response-optional-property-removed

Full history