Voiceflow bearer token
Create run
curl --request POST \
--url https://realtime-api.voiceflow.com/v1/stable/test-run \
--header 'Authorization: Bearer <token>'
--header 'Content-Type: application/json' \
--data '{
"testID": "<string>"
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/test-run?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"testID": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/test-run?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"testID": "<string>"
},
)
data = response.json()vf test run create --project-id <projectID> --environment-alias <environmentAlias> \
< body.json{
"run": {
"id": "<string>",
"logs": [
"<SimulationRunEndLog>"
],
"status": "idle",
"testID": "<string>",
"failReason": "<string>",
"totalChecks": 0,
"passedChecks": 0,
"totalCredits": 0,
"createdAt": "2026-09-10T00:00:00.000Z",
"startedAt": "2026-09-10T00:00:00.000Z",
"finishedAt": "2026-09-10T00:00:00.000Z"
}
}Adds a test run to the environment, one execution of a test, carrying how many of its checks passed. The response carries the ID that later calls address it by.
POST
/v1/stable/test-run
Create run
curl --request POST \
--url https://realtime-api.voiceflow.com/v1/stable/test-run \
--header 'Authorization: Bearer <token>'
--header 'Content-Type: application/json' \
--data '{
"testID": "<string>"
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/test-run?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"testID": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/test-run?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"testID": "<string>"
},
)
data = response.json()vf test run create --project-id <projectID> --environment-alias <environmentAlias> \
< body.json{
"run": {
"id": "<string>",
"logs": [
"<SimulationRunEndLog>"
],
"status": "idle",
"testID": "<string>",
"failReason": "<string>",
"totalChecks": 0,
"passedChecks": 0,
"totalCredits": 0,
"createdAt": "2026-09-10T00:00:00.000Z",
"startedAt": "2026-09-10T00:00:00.000Z",
"finishedAt": "2026-09-10T00:00:00.000Z"
}
}Authorizations
Query Parameters
Response
201 - application/jsonCreates a run of the test named in the body and returns it, possibly still queued: startedAt is null until execution begins and passedChecks is null until the run finishes. Read the run back by id to follow it through to passed, failed, or canceled.
Show child attributes
The trace, tool-call, and end events recorded as the run executed.
Show child attributes
Option 1 · SimulationRunEndLog
Option 2 · SimulationRunTraceLog
Was this page helpful?
Thanks for your feedback.