Skip to main content
POST
/
prompt-templates
/
{identifier}
Get Prompt Template by ID
curl --request POST \
  --url https://api.promptlayer.com/prompt-templates/{identifier} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '{
  "version": 1,
  "workspace_id": 123,
  "label": "<string>",
  "provider": "openai",
  "input_variables": {},
  "metadata_filters": {},
  "model": "<string>",
  "model_parameter_overrides": {}
}'
{
  "id": 123,
  "prompt_name": "<string>",
  "prompt_template": {
    "content": [
      {
        "type": "text",
        "text": "<string>"
      }
    ],
    "input_variables": [],
    "template_format": "f-string",
    "type": "completion"
  },
  "metadata": {
    "model": {
      "provider": "<string>",
      "name": "<string>",
      "parameters": {}
    },
    "customField": "<string>"
  },
  "commit_message": "<string>",
  "llm_kwargs": {},
  "version": 123
}
Retrieve a prompt template using either the prompt_name or prompt_id. Optionally, specify version (version number) or label (release label like “prod”) to retrieve a specific version. If not specified, the latest version is returned. PromptLayer will try to read the model provider from the parameters you attached to the prompt template. You can optionally pass in a provider to override the one set in the Prompt Registry. This will return LLM-specific arguments that can be passed directly into your LLM client. To format the template with input variables, use input_variables.

Headers

​
X-API-KEY
string
required

Path Parameters

​
identifier
string
required

The identifier can be either the prompt name or the prompt id.

Body

application/json
​
version
integer | null
Required range: x > 0
​
workspace_id
integer | null
​
label
string | null
​
provider
enum<string> | null
Available options:
openai,
anthropic
​
input_variables
object | null
​
metadata_filters
object | null

Optional dictionary of key values used for A/B release labels.

​
model
string | null

Optional model name used for returning default parameters with llm_kwargs.

​
model_parameter_overrides
object | null

Optional dictionary of model parameter overrides to use with the prompt template. This will override the parameters at runtime for the specified model and will try to make sure the model supports these parameters. For example, if you supply maxOutputTokens for OpenAI, it will be converted to max_completion_tokens.

Response

Successful Response

​
id
integer
required
​
prompt_name
string
required
​
prompt_template
object
required
  • Completion Template
  • Chat Template
​
metadata
object | null
​
commit_message
string | null
​
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.

​
version
integer
⌘I