Reference
Get All Prompt Templates
- 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
GET
/
prompt-templates
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/prompt-templates \
--header 'X-API-KEY: <x-api-key>'
{
"has_next": true,
"has_prev": true,
"items": [
{
"id": 123,
"prompt_name": "<string>",
"prompt_template": {
"content": [
{
"type": "<any>",
"text": "<string>"
}
],
"input_variables": [
"<string>"
],
"template_format": "f-string",
"type": "<any>"
},
"metadata": {
"model": {
"provider": "<string>",
"name": "<string>",
"parameters": {}
},
"customField": "<string>"
},
"commit_message": "<string>",
"llm_kwargs": {},
"version": 123
}
],
"next_num": 123,
"prev_num": 123,
"page": 123,
"pages": 123,
"total": 123
}
Get a list of all prompt templates.
Headers
X-API-KEY
string
requiredQuery Parameters
page
integer
per_page
integer
Response
200 - application/json
has_next
boolean
requiredhas_prev
boolean
requireditems
object[]
requireditems.id
integer
requireditems.prompt_name
string
requireditems.prompt_template
object
requiredCompletion Prompt Template
items.prompt_template.content
object[]
requireditems.prompt_template.content.type
any
items.prompt_template.content.text
string
requireditems.prompt_template.input_variables
string[]
items.prompt_template.template_format
enum<string>
default: f-stringAvailable options:
f-string
, jinja2
items.prompt_template.type
any
items.metadata
object | null
items.metadata.model
object
items.metadata.model.provider
string
requireditems.metadata.model.name
string
requireditems.metadata.model.parameters
object
items.metadata.customField
string
items.commit_message
string | null
items.llm_kwargs
object | null
When you optionally specify provider
in the body, llm_kwargs
will be returned for that specific provider and you can pass these kwargs to the provider's API directly.
items.version
integer
next_num
integer
requiredprev_num
integer
requiredpage
integer
requiredpages
integer
requiredtotal
integer
requiredWas this page helpful?
curl --request GET \
--url https://api.promptlayer.com/prompt-templates \
--header 'X-API-KEY: <x-api-key>'
{
"has_next": true,
"has_prev": true,
"items": [
{
"id": 123,
"prompt_name": "<string>",
"prompt_template": {
"content": [
{
"type": "<any>",
"text": "<string>"
}
],
"input_variables": [
"<string>"
],
"template_format": "f-string",
"type": "<any>"
},
"metadata": {
"model": {
"provider": "<string>",
"name": "<string>",
"parameters": {}
},
"customField": "<string>"
},
"commit_message": "<string>",
"llm_kwargs": {},
"version": 123
}
],
"next_num": 123,
"prev_num": 123,
"page": 123,
"pages": 123,
"total": 123
}