Skip to main content
POST
/
rest
/
track-prompt
Track Prompt
curl --request POST \
  --url https://api.promptlayer.com/rest/track-prompt \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_key": "<string>",
  "prompt_name": "<string>",
  "request_id": 123,
  "prompt_input_variables": {},
  "version": 123,
  "label": "<string>"
}
'
{
  "success": true,
  "message": "<string>"
}
Associate a prompt template with a request.

​
Example Code

import requests
response = requests.post(
  "https://api.promptlayer.com/rest/track-prompt",
  json={
      "api_key": "<YOUR_API_KEY>",
      "prompt_name": "<PROMPT_NAME>",
      "prompt_input_variables": {"variable1": "value1", "variable2": "value2"},
      "request_id": "<REQUEST_ID>",
      "version": "<VERSION>"
  },
)

Body

application/json
​
api_key
string
required

Your PromptLayer API Key.

Minimum string length: 1
​
prompt_name
string
required

The name of the prompt template.

Minimum string length: 1
​
request_id
integer
required

The unique identifier for the request.

​
prompt_input_variables
object

Input variables for the prompt template.

​
version
integer

The version of the prompt template. Both version and label cannot be specified. Only one or none.

​
label
string

The label of the prompt template version. Both version and label cannot be specified. Only one or none.

Required string length: 1 - 512

Response

Prompt tracked successfully

​
success
boolean
required
​
message
string
required