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 a Flow
      • PATCHUpdate Flow Log
      • GETGet Flow
      • DELDelete Flow
      • PATCHMove Flow
      • GETList Flows
      • POSTUpsert Flow
      • GETList Versions of a Flow
      • DELDelete Flow Version
      • PATCHUpdate Flow Version
      • POSTDeploy Flow
      • DELRemove Deployment
      • GETList a Flow's Environments
      • POSTUpdate Monitoring
LogoLogo
Sign inBook a demo
APIFlows

List a Flow's Environments

GET
https://api.humanloop.com/v5/flows/:id/environments
GET
/v5/flows/:id/environments
$curl https://api.humanloop.com/v5/flows/fl_6o701g4jmcanPVHxdqD0O/environments \
>     -H "X-API-KEY: <apiKey>"
1[
2  {
3    "id": "fl_6o701g4jmcanPVHxdqD0O",
4    "created_at": "2024-05-01T12:00:00Z",
5    "name": "production",
6    "tag": "default",
7    "file": {
8      "path": "Personal Projects/MedQA",
9      "id": "fl_6o701g4jmcanPVHxdqD0O",
10      "name": "MedQA Flow",
11      "version_id": "flv_7ZNQREaScH0JkhUwtXrLN",
12      "type": "flow",
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      "attributes": {
22        "prompt": {
23          "template": "You are a helpful assistant helping with medical anamnesis",
24          "model": "gpt-4o",
25          "temperature": 0.8
26        },
27        "tool": {
28          "name": "retrieval_tool_v3",
29          "description": "Retrieval tool for MedQA.",
30          "source_code": "def retrieval_tool(question: str) -> str:\n    pass\n"
31        }
32      },
33      "created_at": "2024-07-08T22:40:35.656915",
34      "updated_at": "2024-07-08T22:40:35.656915",
35      "created_by": {
36        "id": "usr_01RJO1k2spBVqNUt1ASef",
37        "email_address": "raza@humanloop.com",
38        "full_name": "Raza Habib"
39      },
40      "last_used_at": "2024-07-08T22:40:35.656915",
41      "version_logs_count": 0,
42      "evaluator_aggregates": null,
43      "version_name": "medqa-flow-v1",
44      "version_description": "Initial version"
45    }
46  }
47]
List all Environments and their deployed versions for the Flow.
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 Flow.

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 Flows ID Environments Get Request Unprocessable Entity Error