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 an Agent's Environments

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

Update Monitoring

Next
Built with

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired
Unique identifier for Agent.

Response

Successful Response
idstring
created_atdatetime
namestring
tagenum
An enumeration.
Allowed values:
fileobject
The version of the File that is deployed to the Environment, if one is deployed.

Errors

422
List Environments Agents ID Environments Get Request Unprocessable Entity Error