Get Agent

Get an agent by ID.

GET /api/v1/agents/{agent_id}

Get Agent

cURL

curl --request GET \
  --url https://{tenant_id}.api.useago.com/api/v1/agents/{agent_id} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/agents/{agent_id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{tenant_id}.api.useago.com/api/v1/agents/{agent_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "id": "<string>",
  "name": "<string>",
  "status": "<string>",
  "object": "agent",
  "display_name": "<string>",
  "prompt_template_id": "<string>",
  "prompt_template_name": "<string>",
  "tools": [],
  "sources": [],
  "icon": "<string>",
  "custom_icon_id": "<string>",
  "is_background_agent": false,
  "can_be_used_as_tool": false,
  "ui_selectable": true,
  "order": 123,
  "pinned_documents": [],
  "number_docs_to_retrieve": 8,
  "number_docs_to_display": 8,
  "custom_llm_id": "<string>",
  "custom_llm_temperature": 123,
  "custom_llm_top_p": 123,
  "reranker_activated": false,
  "ignore_sources_restrictions": false,
  "is_router_agent": false,
  "default_router_agent_id": "<string>",
  "reasoning_iterations": 1,
  "tool_description": "<string>",
  "share_conversation_context": false,
  "max_call_depth": 5,
  "satisfaction_feedback_activated": false,
  "satisfaction_feedback_question": "",
  "satisfaction_feedback_helper_text": "",
  "satisfaction_feedback_no_action": "ticket_form",
  "inject_user_ticket_context": false,
  "ticket_context_days_limit": 7
}

Authorizations

X-API-Key · string · header · required

Path Parameters

agent_id · string · required

Response

200 - application/json

OK

Full agent response schema for detail views.

id · string · required

name · string · required

status · string · required

object · string · default: agent

display_name · string | null

prompt_template_id · string | null

prompt_template_name · string | null

tools · Tools · object[]

sources · Sources · object[]

icon · string | null

custom_icon_id · string | null

is_background_agent · boolean · default: false

can_be_used_as_tool · boolean · default: false

ui_selectable · boolean · default: true

order · integer | null

pinned_documents · Pinned Documents · object[]

number_docs_to_retrieve · integer · default: 8

number_docs_to_display · integer · default: 8

custom_llm_id · string | null

custom_llm_temperature · number | null

custom_llm_top_p · number | null

reranker_activated · boolean · default: false

ignore_sources_restrictions · boolean · default: false

is_router_agent · boolean · default: false

default_router_agent_id · string | null

reasoning_iterations · integer · default: 1

tool_description · string | null

share_conversation_context · boolean · default: false

max_call_depth · integer · default: 5

satisfaction_feedback_activated · boolean · default: false

satisfaction_feedback_question · string · default: ""

satisfaction_feedback_helper_text · string · default: ""

satisfaction_feedback_no_action · string · default: ticket_form

inject_user_ticket_context · boolean · default: false

ticket_context_days_limit · integer · default: 7