VocalDocscontracts 1.65.0

List the Agent versions that use a Prompt template

GET /v1/prompt-templates/{prompt_template_id}/pins

PropertyValue
Operationlist_prompt_template_pins
GroupPrompt templates
Scopeprompts:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A configuration read; a Prompt template is not Call content.
Released in1.58.0
Phase 0 hostServed (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"

Parameters

NameInTypeRequiredDescription
prompt_template_idpathPromptTemplateIdyesThe id of a Prompt template: ptpl_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
activequeryone of "true", "false"noOnly the active versions (true) or only the others (false).

Responses

StatusContent typeShapeError codes
200application/jsonPromptTemplatePinList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
404application/jsonErrorEnvelopenot_found
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is PromptTemplatePinList.

FieldTypeRequiredDescription
dataarray of PromptTemplatePinyesThe Agent versions that use a Prompt template of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes