Current - 2026/07
Endpoint
GET
/v1/stable/environment

Returns every environment in the project. An environment is one draft-and-published copy of the agent. The call takes no paging parameters, so one request yields the whole set.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

Response

200 - application/json

Returns every environment in the project, each with its name, alias, release history, whether it is the project's main environment, and the percentage of live traffic it currently takes.

environments
object[]
required
StableEnvironment — see its attributes above
Endpoint
PUT
/v1/stable/environment/merge

Folds the contents of one environment into another, so work done in a clone can be brought back to the environment it was cloned from.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

Request body

sourceEnvironmentAlias
string
required

The alias of the environment whose changes are merged.

targetEnvironmentAlias
string
required

The alias of the environment that receives the merged changes.

removeSourceEnvironment
boolean
default:false

If true, the source environment is deleted after the merge.

Response

200 - application/json

Returns the source and target environments as they stand after the merge, plus the resulting release on the target, with its name, description, and the ID of the backup that snapshots it.

sourceEnvironment
object
required
StableEnvironment — see its attributes above
targetEnvironment
object
required
StableEnvironment — see its attributes above
targetRelease
object
required
Current - 2026/07
Endpoint
PUT
/v1/stable/environment/update-traffic-split

Changes an existing environment in place. The response carries only a confirmation message, so refetch the environment to read its new values.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

Request body

traffic
object
required

Map of environmentAlias → traffic percentage (0-100). Values must sum to 100.

Response

200 - application/json

Confirms the new split was saved. The body is a message only, so read the environments back to see the trafficPercentage now recorded against each one.

message
string
required

A human-readable message confirming the update.

Current - 2026/07
Endpoint
GET
/v1/stable/environment/{environmentAlias}

Returns a single environment by ID, with the fields that define it. An environment is one draft-and-published copy of the agent.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Query parameters

projectID
string
required

The ID of the project to operate on.

Response

200 - application/json

Returns the one environment the alias resolves to, including its release history and the share of live traffic routed to it.

environment
object
required
StableEnvironment — see its attributes above
Endpoint
PATCH
/v1/stable/environment/{environmentAlias}

Changes an existing environment in place. The response carries only a confirmation message, so refetch the environment to read its new values.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Query parameters

projectID
string
required

The ID of the project to operate on.

Request body

name
string

Response

200 - application/json

Confirms the environment was updated. The body carries a message, not the environment, so fetch it again to see the change alongside its releases and traffic percentage.

message
string
required

A human-readable message confirming the update.

Current - 2026/07
Endpoint
DELETE
/v1/stable/environment/{environmentAlias}

Deletes a single environment by ID. An environment is one draft-and-published copy of the agent. The response carries only a confirmation message, so refetch the environments to see what is left.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Query parameters

projectID
string
required

The ID of the project to operate on.

Response

200 - application/json

Confirms the environment was deleted. Only a message comes back, so list the project's environments again to see which aliases remain.

message
string
required

A human-readable message confirming the deletion.

Endpoint
GET
/v1/stable/environment/{environmentAlias}/diff

Compare an environment's draft with its last publish.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

environmentAlias
string
required

Query parameters

projectID
string
required

The ID of the project to operate on.

Response

200 - application/json
diff
object
required
StableEnvironmentDiffReport — see its attributes above
Endpoint
GET
/v1/stable/environment/{environmentAlias}/audit-wiring

Check how tools, functions and variables connect.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

environmentAlias
string
required

Query parameters

projectID
string
required

The ID of the project to operate on.

Response

200 - application/json
audit
object
required

One list per check. Each entry names the function, agent or tool it is about and says why.

StableEnvironmentAuditReport — see its attributes above
Current - 2026/09
Endpoint
GET
/v2/stable/environment/{environmentAlias}/export

Serializes the whole environment - its agent, playbooks, tools and knowledge base - into a single document you can archive or move to another project. Rich text comes back as plain strings with {name} references.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Query parameters

projectID
string
required

The ID of the project to operate on.

Response

200 - application/json

Returns the whole environment as one JSON document: its project and version records, every workflow, agent, tool, function, variable and knowledge base document version, and its secrets. Rich text is a string, and most sections appear only when the environment has something of that kind.

secrets
object[]
Secret — see its attributes above
project
object
required
Project — see its attributes above
_version
string
programs
object
assistant
object
variableStates
object[]
VariableState — see its attributes above
transcriptEvaluations
object[]
version
object
required
StableExportVersion — see its attributes above
diagrams
object
required
intents
object[]
Intent — see its attributes above
utterances
object[]
StableExportUtterance — see its attributes above
requiredEntities
object[]
RequiredEntity — see its attributes above
functions
object[]
Function — see its attributes above
functionPaths
object[]
FunctionPath — see its attributes above
functionVariables
object[]
FunctionVariable — see its attributes above
flows
object[]
agents
object[]
StableExportAgent — see its attributes above
agentAPITools
object[]
StableExportAgentAPITool — see its attributes above
agentFlowTools
object[]
AgentFlowTool — see its attributes above
agentPathTools
object[]
StableExportAgentPathTool — see its attributes above
agentFunctionTools
object[]
StableExportAgentFunctionTool — see its attributes above
agentIntegrationTools
object[]
StableExportAgentIntegrationTool — see its attributes above
agentFlowToolVariables
object[]
AgentFlowToolVariable — see its attributes above
agentPathToolVariables
object[]
AgentPathToolVariable — see its attributes above
agentMcpIntegrationTools
object[]
StableExportAgentMcpIntegrationTool — see its attributes above
events
object[]
Event — see its attributes above
entities
object[]
Entity — see its attributes above
entityVariants
object[]
EntityVariant — see its attributes above
folders
object[]
Folder — see its attributes above
apiTools
object[]
StableExportAPITool — see its attributes above
apiToolInputVariables
object[]
APIToolInputVariable — see its attributes above
simulations
object[]
Simulation — see its attributes above
simulationTurns
object[]
SimulationTurn — see its attributes above
simulationTurnTests
object[]
SimulationTurnTest — see its attributes above
variables
object[]
Variable — see its attributes above
workflows
object[]
Workflow — see its attributes above
attachments
object[]
StableExportAnyAttachment — see its attributes above
cardButtons
object[]
StableExportCardButton — see its attributes above
integrationTools
object[]
IntegrationTool — see its attributes above
mcpIntegrationTools
object[]
McpIntegrationTool — see its attributes above
mcpServers
object[]
mcpServerTools
object[]
McpServerTool — see its attributes above
personas
object[]
Persona — see its attributes above
kbDocumentVersions
object[]
KBDocumentVersionBackup — see its attributes above
kbSettings
object
kbDocumentMetadataM2M
object[]
KBDocumentMetadataM2MBackup — see its attributes above
messages
object[]
required
StableMessage — see its attributes above
prompts
object[]
required
StablePrompt — see its attributes above
Endpoint
POST
/v1/stable/environment/{environmentAlias}/search

Finds a word, phrase, ID or regular expression across the text of the whole environment and returns where each match is. Results are paged with limit and offset: pass the previous response's nextOffset as offset to get the next page.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

environmentAlias
string
required

The alias of the environment to search (e.g. main).

Query parameters

projectID
string
required

The ID of the project to operate on.

Request body

pattern
string
required

The word, phrase or ID to find. With regex, a JavaScript regular expression.

Minimum length: 1 · Maximum length: 256
regex
boolean

Read pattern as a regular expression. Default false: literal text.

ignoreCase
boolean

Ignore case. Default true.

wholeWord
boolean

Match only where no letter, digit or underscore touches the match on either side. Default false.

resourceTypes
object[]

Search only these kinds of resource. Default: all of them.

Minimum items: 1
StableSearchResourceType — see its attributes above
limit
integer

Hits per page. Default 50.

Minimum: 1 · Maximum: 200
offset
integer

Hits to skip: nextOffset from the previous page.

Minimum: 0 · Maximum: 9007199254740991

Response

200 - application/json

Returns one page of matches with the resource, field and line of each, the total match count, a count per resource type, whether more pages exist, and the kinds of text that are never searched.

hits
object[]
required
StableSearchTextHit — see its attributes above
totalMatches
integer
required

Matches in everything searched, not only this page.

Minimum: -9007199254740991 · Maximum: 9007199254740991
byResourceType
object
required

Matching lines per resource type, in everything searched.

hasMore
boolean
required
nextOffset
integer
Minimum: -9007199254740991 · Maximum: 9007199254740991
incomplete
enum<boolean>

Present when the search did not read everything: it stopped at its time limit, or a regular expression read only the first 1,000 characters of a longer line. The counts cover only what it read.

Available options: true
notSearched
string[]
required

What this search never reads.

Endpoint
PUT
/v1/stable/environment/{environmentAlias}/compile

Rebuilds the environment’s runtime form from its current definition, which is what a conversation actually executes against.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Query parameters

projectID
string
required

The ID of the project to operate on.

Response

200 - application/json

Returns a confirmation message and durationMs, how long the compilation took in milliseconds. The environment itself is not part of the response.

message
string
required

A human-readable message confirming the update.

durationMs
number
required

How long the compilation took, in milliseconds.

Current - 2026/07
Endpoint
POST
/v1/stable/environment/{environmentAlias}/clone

Copies an environment into a new one under an alias you choose, giving somewhere to change the agent without touching the environment being cloned.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Query parameters

projectID
string
required

The ID of the project to operate on.

Request body

name
string
required

The display name of the new environment.

alias
string
required

Short URL-safe identifier; cannot be 'main' (reserved).

Response

201 - application/json

Returns the new environment, including the alias that subsequent calls pass as environmentAlias to target it.

environment
object
required
StableEnvironment — see its attributes above
Current - 2026/07
Endpoint
POST
/v1/stable/environment/{environmentAlias}/publish

Promotes the environment’s draft to its published version, which is the copy real traffic reaches. The request names the release so it can be told apart in the history.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Query parameters

projectID
string
required

The ID of the project to operate on.

Request body

name
string
required

The name of the release created by publishing.

description
string

An optional description of what changed in this release.

Response

201 - application/json

Returns the environment together with the release the publish produced, giving the release name, its description, when it was created, and the ID of the backup that snapshots the environment at that release.

environment
object
required
StableEnvironment — see its attributes above
release
object
required

Schemas

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.