VocalDocscontracts 1.65.0

Read a platform base

GET /v1/prompt-bases/{version}

PropertyValue
Operationget_prompt_base
GroupPrompt templates
Scopeprompts:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A configuration read of platform rows; they carry no Call content.
Released in1.55.0
Phase 0 hostServed (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 "$VOCAL_API/v1/prompt-bases/1" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
versionpathintegeryesA base number, from 1.

Responses

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

Fields of the 200 answer

The shape is PromptBase.

FieldTypeRequiredDescription
bodiesarray of PromptBaseBodyyesThe base of each purpose, conversation first.
changelogstringyesWhat changed from the previous base.
deprecated_atTimestamp or nullyes
object"prompt_base"yes
published_atTimestampyes
statusPromptBaseStatusyes
sunset_atTimestamp or nullyesFor a deprecated base, when it stops serving the Agent versions that pin it.
versionintegeryesThe base number, from 1.