List Prompts

1 import { HumanloopClient } from "humanloop"; 2 3 const client = new HumanloopClient({ apiKey: "YOUR_API_KEY" }); 4 const response = await client.prompts.list({ 5 size: 1 6 }); 7 for await (const item of response) { 8 console.log(item); 9 } 10 11 // Or you can manually iterate page-by-page 12 const page = await client.prompts.list({ 13 size: 1 14 }); 15 while (page.hasNextPage()) { 16 page = page.getNextPage(); 17 }

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 "evaluator_aggregates": null 46 } 47 ], 48 "page": 0, 49 "size": 1, 50 "total": 1 51 }

Get a list of all Prompts.

Query parameters

pageintegerOptional>=1Defaults to 1

Page number for pagination.

sizeintegerOptional>=0Defaults to 10

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:

orderenumOptional

Direction to sort by.

Allowed values:

Response

Successful Response

recordslist of objects

pageinteger

sizeinteger

totalinteger

Headers

Query parameters

Response

Errors