Skip to main content
GET
/
prompt-templates
/
{identifier}
/
snippet-usage
Get Snippet Usage
curl --request GET \
  --url https://api.promptlayer.com/prompt-templates/{identifier}/snippet-usage \
  --header 'X-API-KEY: <x-api-key>'
{
  "success": true,
  "message": "<string>",
  "snippet_name": "<string>",
  "snippet_usage": [
    {
      "prompt_registry_id": 123,
      "prompt_name": "<string>",
      "version_numbers": [
        123
      ]
    }
  ],
  "total_prompts_using_snippet": 123,
  "label_usage": [
    {
      "prompt_registry_id": 123,
      "prompt_name": "<string>",
      "label_name": "<string>"
    }
  ],
  "total_labels_using_snippet": 123
}
Get all prompts that use a given snippet (prompt template). Returns a list of prompts and their version numbers that reference this snippet, as well as any release labels that reference it. The identifier can be either the prompt name or the prompt id.

Headers

​
X-API-KEY
string
required

Path Parameters

​
identifier
string
required

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

Query Parameters

​
prompt_version_number
integer

Optional specific version number to check usage for

Response

Successful Response

​
success
boolean
​
message
string
​
snippet_name
string

The name of the snippet prompt template

​
snippet_usage
object[]

List of prompts using this snippet

​
total_prompts_using_snippet
integer

Total number of prompts using this snippet

​
label_usage
object[]

List of labels using this snippet

​
total_labels_using_snippet
integer

Total number of labels using this snippet