List Prompts

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

Successful Response

recordslist of objects

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

Upsert Prompt

Up Next

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