Voiceflow bearer token
Get prompt
curl --request GET \
--url https://realtime-api.voiceflow.com/v1/stable/prompt/<promptID> \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/prompt/<promptID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/prompt/<promptID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf prompt get --prompt-id <promptID> --project-id <projectID> --environment-alias <environmentAlias>{
"prompt": {
"id": "<string>",
"name": "<string>",
"system": "<string>",
"settings": {
"model": "<AIModel>",
"maxTokens": 0,
"temperature": 0,
"responseFormat": "<string>",
"reasoningEffort": "<AIReasoningEffort>",
"serviceTier": "<AIParamsServiceTier>",
"useStructuredOutput": true
},
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"createdByID": 0,
"updatedByID": 0
}
}Returns one prompt by ID. A prompt is the system text and model settings a workflow step in prompt mode sends to the model.
GET
/v1/stable/prompt/{promptID}
Get prompt
curl --request GET \
--url https://realtime-api.voiceflow.com/v1/stable/prompt/<promptID> \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/prompt/<promptID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/prompt/<promptID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf prompt get --prompt-id <promptID> --project-id <projectID> --environment-alias <environmentAlias>{
"prompt": {
"id": "<string>",
"name": "<string>",
"system": "<string>",
"settings": {
"model": "<AIModel>",
"maxTokens": 0,
"temperature": 0,
"responseFormat": "<string>",
"reasoningEffort": "<AIReasoningEffort>",
"serviceTier": "<AIParamsServiceTier>",
"useStructuredOutput": true
},
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"createdByID": 0,
"updatedByID": 0
}
}Authorizations
Query Parameters
Response
200 - application/jsonReturns the prompt with its name, system text, settings (an empty object means the project defaults), timestamps, and the IDs of the users who created and last changed it.
Show child attributes
Plain text; markdown is not interpreted. {variable_name} inserts a variable or entity, {variable_name.path} a field of a variable. Escape a literal { or \ with a backslash. A name matching neither is stored as literal text and reported in unresolvedReferences; secrets are not available here.
Show child attributes
Was this page helpful?
Thanks for your feedback.