List Flows

GET

Get a list of Flows.

Query parameters

pageintegerOptional

Page number for pagination.

sizeintegerOptional

Page size for pagination. Number of Flows to fetch.

namestringOptional

Case-insensitive filter for Flow name.

user_filterstringOptional

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

sort_byenumOptional

Field to sort Flows by

Allowed values: created_atupdated_atname

order"asc" or "desc"Optional

Direction to sort by.

Allowed values: ascdesc

Response

Successful Response

recordslist of objects

pageinteger

sizeinteger

totalinteger

Errors

GET

1 curl -G https://api.humanloop.com/v5/flows \
2      -H "X-API-KEY: <apiKey>" \
3      -d size=1

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

Upsert Flow

Up Next

Built with

1	curl -G https://api.humanloop.com/v5/flows \
2	-H "X-API-KEY: <apiKey>" \
3	-d size=1

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