Upsert Flow

Create or update a Flow.

Flows can also be identified by the ID or their path.

You can provide version_name and version_description to identify and describe your versions. Version names must be unique within a Flow - attempting to create a version with a name that already exists will result in a 409 Conflict error.

Request

This endpoint expects an object.

attributesmap from strings to anyRequired

A key-value object identifying the Flow Version.

pathstringOptional

Path of the Flow, including the name. This locates the Flow in the Humanloop filesystem and is used as as a unique identifier. For example: folder/name or just name.

idstringOptional

ID for an existing Flow.

version_namestringOptional

Unique name for the Flow version. Version names must be unique for a given Flow.

version_descriptionstringOptional

Description of the version, e.g., the changes made in this version.

Response

Successful Response

pathstring

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

idstring

Unique identifier for the Flow.

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

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.

version_namestringOptional

Unique name for the Flow version. Version names must be unique for a given Flow.

version_descriptionstringOptional

Description of the Version.

descriptionstringOptional

Description of the Flow.

readmestringOptional

Long description of the file.

tagslist of stringsOptional

List of tags associated with the file.

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.

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	curl -X POST https://api.humanloop.com/v5/flows \
2	-H "X-API-KEY: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"attributes": {
6	"prompt": {
7	"template": "You are a helpful medical assistant helping with medical anamnesis. Answer {{question}}",
8	"model": "gpt-4o",
9	"temperature": 0.8
10	},
11	"tool": {
12	"name": "retrieval_tool_v3",
13	"description": "Retrieval tool for MedQA.",
14	"source_code": "def retrieval_tool(question: str) -> str:\n pass\n"
15	},
16	"version_name": "medqa-flow-v1",
17	"version_description": "Initial version"
18	},
19	"path": "Personal Projects/MedQA Flow"
20	}'

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	"last_used_at": "2024-07-08T22:40:35.656915",
21	"version_logs_count": 0,
22	"version_name": "medqa-flow-v1",
23	"version_description": "Initial version",
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	"evaluator_aggregates": null
39	}

Headers

Request

Response

Errors