Skip to main content
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

authorization
string
header
required

Voiceflow API key

Path Parameters

projectID
string
required

ID of the project that owns the environments.

projectEnvironmentIDorAlias
string
required

ID or alias of the environment to publish.

Body

application/json
name
string
required
Minimum string length: 1
description
string | null
required

Response

201 - application/json

The updated environment and created release.

data
object
required