List

GET

Get a list of all Prompts.

Query parameters

pageintegerOptional

Page number for pagination.

sizeintegerOptional

Page size for pagination. Number of Prompts to fetch.

namestringOptional

Case-insensitive filter for Prompt name.

user_filterstringOptional

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

sort_byenumOptional

Field to sort Prompts by

Allowed values: created_atupdated_atname

order"asc" or "desc"Optional

Direction to sort by.

Allowed values: ascdesc

Response

This endpoint returns an object.

recordslist of objects

Base type that all File Responses should inherit from.

Attributes defined here are common to all File Responses and should be overridden in the inheriting classes with documentation and appropriate Field definitions.

pageinteger

sizeinteger

totalinteger

Errors

GET

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

1 {
2   "records": [
3     {
4       "path": "Personal Projects/Coding Assistant",
5       "id": "pr_30gco7dx6JDq4200GVOHa",
6       "name": "Coding Assistant",
7       "version_id": "prv_7ZlQREDScH0xkhUwtXruN",
8       "type": "prompt",
9       "environments": [
10         {
11           "id": "env_ffSVxEBzJcBZ1H5jcNMVj",
12           "created_at": "2023-06-27T23:16:07.992339",
13           "name": "development",
14           "tag": "default"
15         }
16       ],
17       "created_at": "2024-07-08T22:40:35.656915",
18       "updated_at": "2024-07-08T22:40:35.656915",
19       "created_by": {
20         "id": "usr_01RJO1k2spBVqNUt1ASef",
21         "email_address": "raza@humanloop.com",
22         "full_name": "Raza Habib"
23       },
24       "status": "committed",
25       "last_used_at": "2024-07-08T22:40:35.656915",
26       "model": "gpt-4o",
27       "endpoint": "chat",
28       "template": [
29         {
30           "content": "You are a helpful coding assistant specialising in {{language}}",
31           "role": "system"
32         }
33       ],
34       "provider": "openai",
35       "max_tokens": -1,
36       "temperature": 0.7,
37       "top_p": 1,
38       "presence_penalty": 0,
39       "frequency_penalty": 0,
40       "other": {},
41       "tools": [],
42       "linked_tools": [],
43       "commit_message": "Initial commit",
44       "version_logs_count": 0,
45       "total_logs_count": 0,
46       "inputs": [
47         {
48           "name": "messages"
49         }
50       ]
51     }
52   ],
53   "page": 0,
54   "size": 1,
55   "total": 1
56 }

Built with

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

1	{
2	"records": [
3	{
4	"path": "Personal Projects/Coding Assistant",
5	"id": "pr_30gco7dx6JDq4200GVOHa",
6	"name": "Coding Assistant",
7	"version_id": "prv_7ZlQREDScH0xkhUwtXruN",
8	"type": "prompt",
9	"environments": [
10	{
11	"id": "env_ffSVxEBzJcBZ1H5jcNMVj",
12	"created_at": "2023-06-27T23:16:07.992339",
13	"name": "development",
14	"tag": "default"
15	}
16	],
17	"created_at": "2024-07-08T22:40:35.656915",
18	"updated_at": "2024-07-08T22:40:35.656915",
19	"created_by": {
20	"id": "usr_01RJO1k2spBVqNUt1ASef",
21	"email_address": "raza@humanloop.com",
22	"full_name": "Raza Habib"
23	},
24	"status": "committed",
25	"last_used_at": "2024-07-08T22:40:35.656915",
26	"model": "gpt-4o",
27	"endpoint": "chat",
28	"template": [
29	{
30	"content": "You are a helpful coding assistant specialising in {{language}}",
31	"role": "system"
32	}
33	],
34	"provider": "openai",
35	"max_tokens": -1,
36	"temperature": 0.7,
37	"top_p": 1,
38	"presence_penalty": 0,
39	"frequency_penalty": 0,
40	"other": {},
41	"tools": [],
42	"linked_tools": [],
43	"commit_message": "Initial commit",
44	"version_logs_count": 0,
45	"total_logs_count": 0,
46	"inputs": [
47	{
48	"name": "messages"
49	}
50	]
51	}
52	],
53	"page": 0,
54	"size": 1,
55	"total": 1
56	}