agents

Get Agents

Example usage:

curl -X GET "http://localhost:4000/v1/agents"       -H "Content-Type: application/json"       -H "Authorization: Bearer your-key"     ```

Pass `?health_check=true` to filter out agents whose URL is unreachable:

curl -X GET "http://localhost:4000/v1/agents?health_check=true" -H "Content-Type: application/json" -H "Authorization: Bearer your-key" ```

Pass ?query=<task> to get the best matching agents ranked by semantic similarity:

curl -X GET "http://localhost:4000/v1/agents?query=translate+a+PDF+document&top_k=5"       -H "Content-Type: application/json"       -H "Authorization: Bearer your-key"     ```

Returns: List[AgentResponse]
get/v1/agents

Request

  • Base URL: https://docs.litellm.com.cn (the document declares no server; this is the origin it was published from)
  • URL: https://docs.litellm.com.cn/v1/agents
  • Auth: API key in header x-litellm-api-key

Query parameters

health_checkboolean

When true, performs a GET request to each agent's URL. Agents with reachable URLs (HTTP status < 500) and agents without a URL are returned; unreachable agents are filtered out.

querystring nullable

Describe the task in natural language to rank the agents you can reach by semantic similarity over their name, description, and skills. Each result carries a search_score. Requires litellm_settings.agent_search_embedding_model.

top_kinteger

With query: the maximum number of ranked agents to return.

Response

Successful Response

identity_managedboolean
enabledboolean
execution_mode'autonomous' | 'delegated' | 'both'
jwt_auth_configuredboolean
agent_idstring required
agent_namestring required
litellm_paramsobject nullable
agent_card_paramsobject required
object_permissionobject nullable
spendnumber nullable
tpm_limitinteger nullable
rpm_limitinteger nullable
session_tpm_limitinteger nullable
session_rpm_limitinteger nullable
static_headersobject nullable
extra_headersstring[] nullable
access_group_idsstring[] nullable
search_scorenumber nullable
created_atstring date-time nullable
updated_atstring date-time nullable
created_bystring nullable
updated_bystring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.