Voiceflow bearer token
Update prompt
curl --request PATCH \
--url https://realtime-api.voiceflow.com/v1/stable/prompt/<promptID> \
--header 'Authorization: Bearer <token>'
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"system": "<string>",
"settings": {
"model": "<AIModel>",
"maxTokens": 0,
"temperature": 0,
"responseFormat": "<string>",
"reasoningEffort": "<AIReasoningEffort>",
"serviceTier": "<AIParamsServiceTier>",
"useStructuredOutput": true
}
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/prompt/<promptID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "<string>",
"system": "<string>",
"settings": {
"model": "<AIModel>",
"maxTokens": 0,
"temperature": 0,
"responseFormat": "<string>",
"reasoningEffort": "<AIReasoningEffort>",
"serviceTier": "<AIParamsServiceTier>",
"useStructuredOutput": true
}
}),
});
const data = await response.json();import requests
response = requests.patch(
'https://realtime-api.voiceflow.com/v1/stable/prompt/<promptID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"name": "<string>",
"system": "<string>",
"settings": {
"model": "<AIModel>",
"maxTokens": 0,
"temperature": 0,
"responseFormat": "<string>",
"reasoningEffort": "<AIReasoningEffort>",
"serviceTier": "<AIParamsServiceTier>",
"useStructuredOutput": True
}
},
)
data = response.json()vf prompt update --prompt-id <promptID> --project-id <projectID> --environment-alias <environmentAlias> \
< body.json{
"message": "<string>",
"unresolvedReferences": [
{
"path": "<string>",
"token": "<string>",
"reason": "unknown"
}
]
}Changes a prompt’s name, its system text, or its whole settings object, and edits it in place so the step that uses it keeps pointing at the same ID. The `settings` value you send replaces the stored one, and an empty object returns it to the project defaults.
PATCH
/v1/stable/prompt/{promptID}
Update prompt
curl --request PATCH \
--url https://realtime-api.voiceflow.com/v1/stable/prompt/<promptID> \
--header 'Authorization: Bearer <token>'
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"system": "<string>",
"settings": {
"model": "<AIModel>",
"maxTokens": 0,
"temperature": 0,
"responseFormat": "<string>",
"reasoningEffort": "<AIReasoningEffort>",
"serviceTier": "<AIParamsServiceTier>",
"useStructuredOutput": true
}
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/prompt/<promptID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "<string>",
"system": "<string>",
"settings": {
"model": "<AIModel>",
"maxTokens": 0,
"temperature": 0,
"responseFormat": "<string>",
"reasoningEffort": "<AIReasoningEffort>",
"serviceTier": "<AIParamsServiceTier>",
"useStructuredOutput": true
}
}),
});
const data = await response.json();import requests
response = requests.patch(
'https://realtime-api.voiceflow.com/v1/stable/prompt/<promptID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"name": "<string>",
"system": "<string>",
"settings": {
"model": "<AIModel>",
"maxTokens": 0,
"temperature": 0,
"responseFormat": "<string>",
"reasoningEffort": "<AIReasoningEffort>",
"serviceTier": "<AIParamsServiceTier>",
"useStructuredOutput": True
}
},
)
data = response.json()vf prompt update --prompt-id <promptID> --project-id <projectID> --environment-alias <environmentAlias> \
< body.json{
"message": "<string>",
"unresolvedReferences": [
{
"path": "<string>",
"token": "<string>",
"reason": "unknown"
}
]
}Authorizations
Query Parameters
Body
Show child attributes
Response
200 - application/jsonConfirms the prompt was updated. The body is a message, with unresolvedReferences for any variable or reference in the new system text that did not resolve.
References this write kept as literal text instead of binding, each with the reason. The write still succeeded.
Show child attributes
unknown: no variable or entity of that name. secret-not-allowed: the name is a project secret and this field does not accept one. path-on-non-variable: only a variable has fields. resource-id: a bare resource id, not a name. invalid-name: outside the ^\w{1,64}$ name grammar. dangling: the reference rendered as a bare id, because its row is gone or its name is outside the name grammar.
Available options:
unknown, secret-not-allowed, path-on-non-variable, resource-id, invalid-name, danglingWas this page helpful?
Thanks for your feedback.