GET /v1/prompt-bases/{version}
Property Value Operation get_prompt_baseGroup Prompt templates Scope prompts:readRoute class readIdempotency No Idempotency-Key Audit Not audited: A configuration read of platform rows; they carry no Call content. Released in 1.55.0 Phase 0 host Served (the hosted api pins 1.65.0)
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 Node.js Python
curl "$VOCAL_API/v1/prompt-bases/1" \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/prompt-bases/1`, {
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-bases/1",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)
Parameters
Name In Type Required Description versionpath integer yes A base number, from 1.
Responses
Fields of the 200 answer
The shape is PromptBase .
Field Type Required Description bodiesarray of PromptBaseBody yes The base of each purpose, conversation first. changelogstring yes What changed from the previous base. deprecated_atTimestamp or nullyes object"prompt_base"yes published_atTimestamp yes statusPromptBaseStatus yes sunset_atTimestamp or nullyes For a deprecated base, when it stops serving the Agent versions that pin it. versioninteger yes The base number, from 1.