Reference
Get All Prompt Templates (Deprecated)
- Prompt CMS
- Advanced Search
Evaluations
- Fine-Tuning
- Analytics
- Scoring & Ranking Prompts
- Playground
- Shared Workspaces
- How PromptLayer Works
- REST API Reference
- POSTTrack Request
- POSTGet Prompt Template
- GETGet Prompt Template (Deprecated)
- POSTPublish Prompt Template
- POSTPublish Prompt Template (Deprecated)
- GETGet Prompt Template Labels
- POSTTrack Score
- POSTTrack Prompt
- POSTTrack Group
- POSTTrack Metadata
- GETGet All Prompt Templates
- GETGet All Prompt Templates (Deprecated)
- POSTCreate Dataset from History
- DELDelete Datasets by Name
- POSTCreate Evaluation Pipeline
- DELDelete Reports by Name
Why PromptLayer?
Reference
Reference
Get All Prompt Templates (Deprecated)
GET
/
rest
/
prompts
X-API-KEY
X-Api-Key · string
*
X-API-KEY
Required
string
page
Page · integer
page
integer
per_page
Per Page · integer
per_page
integer
curl --request GET \
--url https://api.promptlayer.com/rest/prompts \
--header 'X-API-KEY: <x-api-key>'
{
"page": 123,
"per_page": 123,
"total": 123,
"pages": 123,
"items": [
{
"id": 123,
"version_number": 123,
"prompt_name": "<string>",
"prompt_template": {
"input_variables": [
"<string>"
],
"messages": [
{
"prompt": {
"input_variables": [
"<string>"
],
"template": "<string>",
"template_format": "<string>",
"validate_template": true
},
"additional_kwargs": {},
"role": "<string>"
}
],
"functions": [
{
"name": "<string>",
"description": "<string>",
"parameters": {}
}
],
"function_call": "none"
},
"tags": [
"<string>"
],
"commit_message": "<string>",
"metadata": {
"model": {
"provider": "<string>",
"name": "<string>",
"parameters": {}
},
"customField": "<string>"
}
}
]
}
Get a list of all prompt templates.
Headers
X-API-KEY
string
requiredQuery Parameters
page
integer
per_page
integer
Response
200 - application/json
page
integer
default: 1per_page
integer
default: 30total
integer
requiredpages
integer
requireditems
object[]
requireditems.id
integer
requiredThe id of the prompt
items.version_number
integer
The version number of the prompt
items.prompt_name
string
requiredPrompt name has to be less than 128 characters and can only contain letters, numbers, and underscores. If a prompt exists with this name it will be pushed into an older version
items.prompt_template
object
requiredChat Prompt Template
items.prompt_template.input_variables
string[]
requireditems.prompt_template.messages
object[]
requireditems.prompt_template.messages.prompt
object
requiredCompletion Prompt Template
items.prompt_template.messages.prompt.input_variables
string[]
requireditems.prompt_template.messages.prompt.template
string
requireditems.prompt_template.messages.prompt.template_format
string
default: f-stringitems.prompt_template.messages.prompt.validate_template
boolean
default: trueitems.prompt_template.messages.additional_kwargs
object
items.prompt_template.messages.role
string
requireditems.prompt_template.functions
object[]
items.prompt_template.functions.name
string
requireditems.prompt_template.functions.description
string
default: items.prompt_template.functions.parameters
object
items.prompt_template.function_call
Available options:
none
, auto
items.tags
string[]
Array of string tags for a template
items.commit_message
string
Commit message for the prompt version
items.metadata
object
items.metadata.model
object
items.metadata.model.provider
string
requireditems.metadata.model.name
string
requireditems.metadata.model.parameters
object
items.metadata.customField
string
Was this page helpful?
curl --request GET \
--url https://api.promptlayer.com/rest/prompts \
--header 'X-API-KEY: <x-api-key>'
{
"page": 123,
"per_page": 123,
"total": 123,
"pages": 123,
"items": [
{
"id": 123,
"version_number": 123,
"prompt_name": "<string>",
"prompt_template": {
"input_variables": [
"<string>"
],
"messages": [
{
"prompt": {
"input_variables": [
"<string>"
],
"template": "<string>",
"template_format": "<string>",
"validate_template": true
},
"additional_kwargs": {},
"role": "<string>"
}
],
"functions": [
{
"name": "<string>",
"description": "<string>",
"parameters": {}
}
],
"function_call": "none"
},
"tags": [
"<string>"
],
"commit_message": "<string>",
"metadata": {
"model": {
"provider": "<string>",
"name": "<string>",
"parameters": {}
},
"customField": "<string>"
}
}
]
}