Publish environment
curl --request POST \
--url https://realtime-api.voiceflow.com/v1alpha1/project/{projectID}/environment/{projectEnvironmentIDorAlias}/publish \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>"
}
'{
"data": {
"projectEnvironment": {
"id": "<string>",
"name": "<string>",
"alias": "<string>",
"isMain": true,
"releases": [
{
"name": "<string>",
"backupID": 123,
"createdAt": "<string>",
"versionID": "<string>",
"description": "<string>",
"autogenerated": true,
"createdByUserID": 123
}
],
"createdAt": "<string>",
"draftVersionID": "<string>",
"createdByUserID": 123,
"trafficPercentage": 50,
"nextReleaseNumber": 123,
"publishedVersionID": "<string>",
"draftVersionIDsHistory": [
"<string>"
]
},
"projectEnvironmentRelease": {
"name": "<string>",
"backupID": 123,
"createdAt": "<string>",
"versionID": "<string>",
"description": "<string>",
"autogenerated": true,
"createdByUserID": 123
}
}
}Publish environment
Publish the target environment’s draft as its new published version. The environment can be targeted by ID or alias.
POST
/
v1alpha1
/
project
/
{projectID}
/
environment
/
{projectEnvironmentIDorAlias}
/
publish
Publish environment
curl --request POST \
--url https://realtime-api.voiceflow.com/v1alpha1/project/{projectID}/environment/{projectEnvironmentIDorAlias}/publish \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>"
}
'{
"data": {
"projectEnvironment": {
"id": "<string>",
"name": "<string>",
"alias": "<string>",
"isMain": true,
"releases": [
{
"name": "<string>",
"backupID": 123,
"createdAt": "<string>",
"versionID": "<string>",
"description": "<string>",
"autogenerated": true,
"createdByUserID": 123
}
],
"createdAt": "<string>",
"draftVersionID": "<string>",
"createdByUserID": 123,
"trafficPercentage": 50,
"nextReleaseNumber": 123,
"publishedVersionID": "<string>",
"draftVersionIDsHistory": [
"<string>"
]
},
"projectEnvironmentRelease": {
"name": "<string>",
"backupID": 123,
"createdAt": "<string>",
"versionID": "<string>",
"description": "<string>",
"autogenerated": true,
"createdByUserID": 123
}
}
}Authorizations
Voiceflow API key
Path Parameters
ID of the project that owns the environments.
ID or alias of the environment to publish.
Response
201 - application/json
The updated environment and created release.
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Required range:
0 <= x <= 100Hide child attributes
Hide child attributes
Was this page helpful?
⌘I