Sign in
Agents

Get agent

Retrieve agent details by its unique key.

Observed gateway behavior (localhost integration tests): Unknown agentKey, lookup after soft-delete, and other AI-backend failures currently return HTTP 500 with an ErrorResponse body (message often mentions the agent or "not found"), not 404. The Python query service may return 404 when called directly; the Node proxy surfaces 500 instead.

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