List the Agent versions that use a Prompt template
GET /v1/prompt-templates/{prompt_template_id}/pins
| Property | Value |
|---|---|
| Operation | list_prompt_template_pins |
| Group | Prompt templates |
| Scope | prompts:read |
| Route class | read |
| Idempotency | No Idempotency-Key |
| Audit | Not audited: A configuration read; a Prompt template is not Call content. |
| Released in | 1.58.0 |
| Phase 0 host | Served (the hosted api pins 1.65.0) |
Lists the published Agent versions of the Organization that pin a version of the template as their Agent layer or name it as their Organization layer, newest first, with whether each is its Agent's active version (1.58.0). An Agent that names no layer and receives the default one is not listed. A template of another Organization is not found.
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the prompts:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.
curl "$VOCAL_API/v1/prompt-templates/ptpl_.../pins" \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/prompt-templates/ptpl_.../pins`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/prompt-templates/ptpl_.../pins",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
prompt_template_id | path | PromptTemplateId | yes | The id of a Prompt template: ptpl_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log. |
limit | query | integer | no | The page size, 1 to 100. |
cursor | query | string | no | The opaque next_cursor of the previous page; it binds the filters it was issued under. |
active | query | one of "true", "false" | no | Only the active versions (true) or only the others (false). |
Responses
| Status | Content type | Shape | Error codes |
|---|---|---|---|
200 | application/json | PromptTemplatePinList | |
400 | application/json | ErrorEnvelope | invalid_request, invalid_cursor |
401 | application/json | ErrorEnvelope | unauthenticated |
403 | application/json | ErrorEnvelope | forbidden |
404 | application/json | ErrorEnvelope | not_found |
429 | application/json | ErrorEnvelope | rate_limited |
500 | application/json | ErrorEnvelope | internal_error |
Fields of the 200 answer
The shape is PromptTemplatePinList.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of PromptTemplatePin | yes | The Agent versions that use a Prompt template of this page, newest first. |
has_more | boolean | yes | True when a further page exists. |
next_cursor | string or null | yes | The cursor of the next page, or null on the last page. |
object | "list" | yes |