For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inBook a demo
DocsReferenceChangelog
DocsReferenceChangelog
  • Introduction
    • Overview
    • Errors
  • SDK
    • Overview
    • Decorators
    • Run Evaluation
  • API
      • POSTLog to an Agent
      • PATCHUpdate Agent Log
      • STREAMCall Agent
      • STREAMContinue Agent Call
      • GETList Agents
      • POSTUpsert Agent
      • DELDelete Agent Version
      • PATCHUpdate Agent Version
      • GETGet Agent
      • DELDelete Agent
      • PATCHMove Agent
      • GETList Versions of a Agent
      • POSTDeploy Agent
      • DELRemove Deployment
      • GETList an Agent's Environments
      • POSTUpdate Monitoring
      • GETSerialize
      • POSTDeserialize
LogoLogo
Sign inBook a demo
APIAgents

List Agents

GET
https://api.humanloop.com/v5/agents
GET
/v5/agents
$curl -G https://api.humanloop.com/v5/agents \
>     -H "X-API-KEY: <apiKey>" \
>     -d size=1
1{
2  "records": [
3    {
4      "path": "Banking/Teller Agent",
5      "id": "ag_1234567890",
6      "model": "claude-3-7-sonnet-latest",
7      "tools": [
8        {
9          "type": "file",
10          "link": {
11            "file_id": "pr_1234567890",
12            "version_id": "prv_1234567890"
13          },
14          "on_agent_call": "continue"
15        },
16        {
17          "type": "inline",
18          "json_schema": {
19            "name": "stop",
20            "description": "Call this tool when you have finished your task.",
21            "strict": true,
22            "parameters": {
23              "type": "object",
24              "properties": {
25                "output": {
26                  "type": "string"
27                }
28              },
29              "additionalProperties": false,
30              "required": [
31                "output"
32              ]
33            }
34          },
35          "on_agent_call": "stop"
36        }
37      ],
38      "name": "Teller Agent",
39      "version_id": "agv_1234567890",
40      "created_at": "2024-05-01T12:00:00Z",
41      "updated_at": "2024-05-01T12:00:00Z",
42      "status": "committed",
43      "last_used_at": "2024-05-01T12:00:00Z",
44      "version_logs_count": 1,
45      "total_logs_count": 1,
46      "inputs": [],
47      "endpoint": "chat",
48      "template": [
49        {
50          "role": "system",
51          "content": "You are a helpful digital assistant, helping users navigate our digital banking platform."
52        }
53      ],
54      "provider": "anthropic",
55      "reasoning_effort": 1024,
56      "max_iterations": 3,
57      "type": "agent",
58      "environments": [
59        {
60          "id": "env_ffSVxEBzJcBZ1H5jcNMVj",
61          "created_at": "2023-06-27T23:16:07.992339",
62          "name": "development",
63          "tag": "default"
64        }
65      ],
66      "created_by": {
67        "id": "usr_01RJO1k2spBVqNUt1ASef",
68        "email_address": "raza@humanloop.com",
69        "full_name": "Raza Habib"
70      },
71      "evaluator_aggregates": null
72    }
73  ],
74  "page": 0,
75  "size": 1,
76  "total": 1
77}
Get a list of all Agents.
Was this page helpful?
Previous

Upsert Agent

Next
Built with

Authentication

X-API-KEYstring
API Key authentication via header

Query parameters

pageintegerOptional>=1Defaults to 1
Page number for pagination.
sizeintegerOptional>=0Defaults to 10
Page size for pagination. Number of Agents to fetch.
namestringOptional

Case-insensitive filter for Agent name.

user_filterstringOptional

Case-insensitive filter for users in the Agent. This filter matches against both email address and name of users.

sort_byenumOptional
Field to sort Agents by
Allowed values:
orderenumOptional
Direction to sort by.
Allowed values:

Response

Successful Response
recordslist of objects
pageinteger
sizeinteger
totalinteger

Errors

422
List Agents Get Request Unprocessable Entity Error