Humanloop Documentation and API Reference

Deploy Flow to an Environment.

Set the deployed version for the specified Environment. This Flow will be used for calls made to the Flow in this Environment.

Path parameters

idstringRequired

Unique identifier for Flow.

environment_idstringRequired

Unique identifier for the Environment to deploy the Version to.

Query parameters

version_idstringRequired

Unique identifier for the specific version of the Flow.

Response

Successful Response

pathstring

Path of the Flow, including the name, which is used as a unique identifier.

idstring

Unique identifier for the Flow. Starts with fl_.

attributesmap from strings to any

A key-value object identifying the Flow Version.

namestring

Name of the Flow.

version_idstring

Unique identifier for the specific Flow Version. If no query params provided, the default deployed Flow Version is returned.

created_atdatetime

updated_atdatetime

statusenum

Allowed values: uncommittedcommitteddeleted

The status of the Flow Version.

last_used_atdatetime

version_logs_countinteger

The number of logs that have been generated for this Flow Version

directory_idstringOptional

ID of the directory that the file is in on Humanloop.

commit_messagestringOptional

Message describing the changes made. If provided, a committed version of the Flow is created. Otherwise, an uncommitted version is created.

type"flow"OptionalDefaults to flow

environmentslist of objectsOptional

The list of environments the Flow Version is deployed to.

created_byanyOptional

The user who created the Flow.

committed_byanyOptional

The user who committed the Flow Version.

committed_atdatetimeOptional

The date and time the Flow Version was committed.

evaluator_aggregateslist of objectsOptional

Aggregation of Evaluator results for the Flow Version.

evaluatorslist of objectsOptional

The list of Monitoring Evaluators associated with the Flow Version.

1	{
2	"path": "Personal Projects/MedQA",
3	"id": "fl_6o701g4jmcanPVHxdqD0O",
4	"attributes": {
5	"prompt": {
6	"template": "You are a helpful assistant helping with medical anamnesis",
7	"model": "gpt-4o",
8	"temperature": 0.8
9	},
10	"tool": {
11	"name": "retrieval_tool_v3",
12	"description": "Retrieval tool for MedQA.",
13	"source_code": "def retrieval_tool(question: str) -> str:\n pass\n"
14	}
15	},
16	"name": "MedQA Flow",
17	"version_id": "flv_7ZNQREaScH0JkhUwtXrLN",
18	"created_at": "2024-07-08T22:40:35.656915",
19	"updated_at": "2024-07-08T22:40:35.656915",
20	"status": "committed",
21	"last_used_at": "2024-07-08T22:40:35.656915",
22	"version_logs_count": 0,
23	"commit_message": "Initial commit",
24	"type": "flow",
25	"environments": [
26	{
27	"id": "env_ffSVxEBzJcBZ1H5jcNMVj",
28	"created_at": "2023-06-27T23:16:07.992339",
29	"name": "development",
30	"tag": "default"
31	}
32	],
33	"created_by": {
34	"id": "usr_01RJO1k2spBVqNUt1ASef",
35	"email_address": "raza@humanloop.com",
36	"full_name": "Raza Habib"
37	}
38	}

1	curl -X POST "https://api.humanloop.com/v5/flows/fl_6o701g4jmcanPVHxdqD0O/environments/staging?version_id=flv_6o701g4jmcanPVHxdqD0O" \
2	-H "X-API-KEY: <apiKey>"

Path parameters

Query parameters

Response

Errors