Skip to main content
POST
/
rest
/
track-metadata
Track Metadata
curl --request POST \
  --url https://api.promptlayer.com/rest/track-metadata \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "request_id": 123,
  "metadata": {}
}
'
{
  "success": true,
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.promptlayer.com/llms.txt

Use this file to discover all available pages before exploring further.

Associate a metadata dictionary with a request. This can be used for things like session_ids, user_ids, location, etc.

​
Example Code

import requests
response = requests.post(
  "https://api.promptlayer.com/rest/track-metadata",
  headers={"X-API-KEY": "<YOUR_API_KEY>"},
  json={
      "request_id": "<REQUEST_ID>",
      "metadata": {"session_id": "abc123", "user_id": "user123"}
  },
)

Headers

​
X-API-KEY
string
required

Your PromptLayer API Key.

Body

application/json
​
request_id
integer
required

The unique identifier for the request to which the metadata is associated.

​
metadata
object
required

A dictionary of metadata items to associate with the request. Can include session_ids, user_ids, location, etc.

Response

Metadata tracked successfully

​
success
boolean
required
​
message
string
required