Voiceflow bearer token
curl --request GET \
--url https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/export \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/export?projectID=<projectID>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/export?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf environment export --environment-alias <environmentAlias> --project-id <projectID>{
"secrets": [
{
"id": "<string>",
"name": "<string>",
"visibility": "<SecretVisibility>",
"hasValue": true,
"assistantID": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0
}
],
"project": {
"_id": "<string>",
"nlu": "<string>",
"type": "<string>",
"name": "<string>",
"image": "<string>",
"teamID": "<string>",
"members": [
"<ProjectMember>"
],
"privacy": "<ProjectPrivacy>",
"platform": "<string>",
"_version": 0,
"linkType": "<string>",
"stickers": [
"<ProjectSticker>"
],
"creatorID": 0,
"updatedBy": 0,
"createdAt": "<string>",
"updatedAt": "<string>",
"prototype": "<ProjectPrototype>",
"apiPrivacy": "<ProjectPrivacy>",
"reportTags": {},
"nluSettings": "<ProjectNLUSettings>",
"environments": {},
"platformData": {},
"customThemes": [
"<ProjectCustomTheme>"
],
"aiAssistSettings": "<ProjectAIAssistSettings>",
"transcriptSettings": "<ProjectTranscriptSettings>",
"objective": "<ProjectObjective>",
"devVersion": "<string>",
"liveVersion": "<string>",
"stagingVersion": "<string>",
"previewVersion": "<string>",
"knowledgeBase": "<VersionKnowledgeBase>"
},
"_version": "<string>",
"programs": {},
"assistant": {
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"version": 0,
"folderID": null,
"isDeleted": true,
"description": null,
"workspaceID": "<string>",
"activeEnvironmentID": "<string>"
},
"variableStates": [
{
"_id": "<string>",
"name": "<string>",
"projectID": "<string>",
"variables": {},
"startFrom": "<VariableStateStartFrom>"
}
],
"transcriptEvaluations": [
{
"name": "<string>",
"description": "<string>",
"enabled": true,
"prompt": "<string>",
"settings": {
"model": "gpt-3.5-turbo-1106",
"realtime": {
"voice": "<string>",
"eagerness": "<string>"
},
"maxTokens": 0,
"temperature": 0,
"reasoningEffort": "off"
},
"runScope": "both",
"type": "boolean",
"truePrompt": "<string>",
"falsePrompt": "<string>",
"systemTag": "<string>",
"id": "<string>",
"default": true
}
],
"version": {
"_id": "<string>",
"name": "<string>",
"model": "<VersionModel>",
"legacyID": "<string>",
"updatedAt": "<string>",
"updatedBy": 0,
"settings": "<VersionSettings>",
"_version": 0,
"creatorID": 0,
"projectID": "<string>",
"manualSave": true,
"publishedAt": "<string>",
"platformData": {
"slots": [
"<VersionSlot>"
],
"intents": [
"<VersionIntent>"
],
"settings": "<VersionPlatformSettings>",
"publishing": {}
},
"customBlocks": {},
"rootDiagramID": "<string>",
"canvasTemplates": [
"<VersionCanvasTemplate>"
],
"programResources": "<VersionProgramResources>",
"templateDiagramID": "<string>",
"defaultStepColors": {},
"autoSaveFromRestore": true,
"notes": {},
"topics": [
"<VersionFolderItem>"
],
"folders": {},
"domains": [
"<VersionDomain>"
],
"prototype": "<VersionPrototype>",
"components": [
"<VersionFolderItem>"
],
"variables": [
"<string>"
],
"knowledgeBase": "<VersionKnowledgeBase>",
"secondaryVersionID": 0
},
"diagrams": {},
"intents": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"description": "<string>",
"entityOrder": [
"<string>"
],
"automaticReprompt": true,
"automaticRepromptSettings": "<AutomaticReprompt>"
}
],
"utterances": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"text": "<UtteranceText>",
"language": "<Language>",
"intentID": "<string>"
}
],
"requiredEntities": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"intentID": "<string>",
"entityID": "<string>",
"repromptID": "<string>"
}
],
"responses": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"name": "<string>",
"type": null,
"draft": null
}
],
"responseMessages": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"text": "<Markup>",
"delay": 0,
"condition": "<AnyCondition>",
"discriminatorID": "<string>"
}
],
"responseDiscriminators": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"channel": "<Channel>",
"language": "<Language>",
"responseID": "<string>",
"variantOrder": [
"<string>"
]
}
],
"functions": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"code": "<string>",
"image": "<string>",
"pathOrder": [
"<string>"
],
"description": "<string>",
"settings": "<FunctionSettings>"
}
],
"functionPaths": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"label": "<string>",
"functionID": "<string>"
}
],
"functionVariables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"type": "<FunctionVariableKind>",
"functionID": "<string>",
"description": "<string>"
}
],
"flows": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"name": "<string>",
"diagramID": "<string>",
"description": "<string>"
}
],
"agents": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"endTool": null,
"settings": "<AgentSettings>",
"cardTool": null,
"isOperator": false,
"buttonTool": null,
"description": "<string>",
"instructions": "<Markup>",
"skipTurnTool": null,
"carouselTool": null,
"pathToolOrder": [
"<string>"
],
"webSearchTool": "<AgentWebSearchTool>",
"callForwardTool": null,
"knowledgeBaseTool": "<AgentKnowledgeBaseTool>"
}
],
"agentAPITools": [],
"agentFlowTools": [],
"agentPathTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"agentID": "<string>",
"description": "<string>",
"variableOrder": [
"<string>"
],
"messages": null
}
],
"agentFunctionTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"functionID": "<string>",
"description": "<string>",
"inputVariables": {},
"captureResponse": {},
"toolSound": null,
"agentID": "<string>",
"messages": null,
"asyncExecution": false,
"captureInputVariables": {}
}
],
"agentIntegrationTools": [],
"agentFlowToolVariables": [],
"agentPathToolVariables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"kind": "<AgentToolVariableKind>",
"entityID": "<string>",
"variableID": "<string>",
"description": "<string>",
"agentPathToolID": "<string>"
}
],
"agentMcpIntegrationTools": [],
"events": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"name": "<string>",
"flowID": null,
"goesTo": null,
"isSystem": true,
"requestName": "<string>",
"description": "<string>"
}
],
"entities": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"color": "<string>",
"isArray": true,
"classifier": "<string>",
"description": "<string>"
}
],
"entityVariants": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"value": "<string>",
"language": "<Language>",
"synonyms": [
"<string>"
],
"entityID": "<string>"
}
],
"folders": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"scope": "<FolderScope>",
"parentID": "<string>"
}
],
"prompts": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"draft": null,
"settings": "<PromptSettings>",
"description": "<string>",
"messageOrder": [
"<string>"
]
}
],
"promptMessages": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"type": "<PromptMessageType>",
"data": "<PromptMessageData>",
"pairID": "<string>",
"promptID": "<string>"
}
],
"apiTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"url": "<Markup>",
"body": "<APIToolBody>",
"image": "<string>",
"headers": [
"<APIToolKeyValue>"
],
"httpMethod": "<APIToolHTTPMethodType>",
"description": "<string>",
"queryParameters": [
"<APIToolKeyValue>"
],
"settings": "<APIToolSettings>"
}
],
"apiToolInputVariables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"apiToolID": "<string>",
"description": "<string>"
}
],
"simulations": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"settings": "<SimulationSettings>",
"turnOrder": [
"<string>"
]
}
],
"simulationTurns": [
"<UserSimulationTurn>"
],
"simulationTurnTests": [
"<ToolSimulationTurnTest>"
],
"variables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"color": "<string>",
"isArray": true,
"isSystem": true,
"datatype": "<VariableDatatype>",
"description": "<string>",
"defaultValue": "<string>",
"resetAfter": "never"
}
],
"workflows": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"status": "<WorkflowStatus>",
"name": "<string>",
"isStart": true,
"diagramID": "<string>",
"assigneeID": 0,
"description": "<string>"
}
],
"attachments": [
"<CardAttachment>"
],
"cardButtons": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"label": "<Markup>",
"cardID": "<string>"
}
],
"integrationTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"toolName": "<IntegrationToolName>",
"description": "<string>",
"toolProvider": "<IntegrationToolProvider>"
}
],
"mcpIntegrationTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"description": "<string>",
"mcpServerToolID": "<string>"
}
],
"mcpServers": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"image": null,
"description": null,
"specification": "2025-03-26",
"url": null,
"headers": null,
"authType": "custom",
"oauthMetadata": null
}
],
"mcpServerTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"toolName": "<string>",
"description": "<string>",
"inputSchema": "<JsonSchema>",
"mcpServerID": "<string>"
}
],
"personas": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"items": [
"<PersonaItem>"
]
}
],
"kbDocumentVersions": [
{
"id": "<string>",
"documentID": "<string>",
"versionID": "<string>",
"folderID": "<string>"
}
],
"kbSettings": {
"id": "<string>",
"versionID": "<string>",
"summarization": "<KnowledgeBaseSummarization>",
"chunkStrategy": "<KnowledgeBaseChunkStrategy>",
"search": "<KnowledgeBaseSearch>",
"embeddingModel": "<KnowledgeBaseEmbeddingModel>"
},
"kbDocumentMetadataM2M": [
{
"id": "<string>",
"metadataFieldID": "<string>",
"documentID": "<string>",
"versionID": "<string>"
}
]
}Export environment
Serialises the whole environment - its agent, playbooks, tools and knowledge base - into a single document you can archive or move to another project.
curl --request GET \
--url https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/export \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/export?projectID=<projectID>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/export?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf environment export --environment-alias <environmentAlias> --project-id <projectID>{
"secrets": [
{
"id": "<string>",
"name": "<string>",
"visibility": "<SecretVisibility>",
"hasValue": true,
"assistantID": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0
}
],
"project": {
"_id": "<string>",
"nlu": "<string>",
"type": "<string>",
"name": "<string>",
"image": "<string>",
"teamID": "<string>",
"members": [
"<ProjectMember>"
],
"privacy": "<ProjectPrivacy>",
"platform": "<string>",
"_version": 0,
"linkType": "<string>",
"stickers": [
"<ProjectSticker>"
],
"creatorID": 0,
"updatedBy": 0,
"createdAt": "<string>",
"updatedAt": "<string>",
"prototype": "<ProjectPrototype>",
"apiPrivacy": "<ProjectPrivacy>",
"reportTags": {},
"nluSettings": "<ProjectNLUSettings>",
"environments": {},
"platformData": {},
"customThemes": [
"<ProjectCustomTheme>"
],
"aiAssistSettings": "<ProjectAIAssistSettings>",
"transcriptSettings": "<ProjectTranscriptSettings>",
"objective": "<ProjectObjective>",
"devVersion": "<string>",
"liveVersion": "<string>",
"stagingVersion": "<string>",
"previewVersion": "<string>",
"knowledgeBase": "<VersionKnowledgeBase>"
},
"_version": "<string>",
"programs": {},
"assistant": {
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"version": 0,
"folderID": null,
"isDeleted": true,
"description": null,
"workspaceID": "<string>",
"activeEnvironmentID": "<string>"
},
"variableStates": [
{
"_id": "<string>",
"name": "<string>",
"projectID": "<string>",
"variables": {},
"startFrom": "<VariableStateStartFrom>"
}
],
"transcriptEvaluations": [
{
"name": "<string>",
"description": "<string>",
"enabled": true,
"prompt": "<string>",
"settings": {
"model": "gpt-3.5-turbo-1106",
"realtime": {
"voice": "<string>",
"eagerness": "<string>"
},
"maxTokens": 0,
"temperature": 0,
"reasoningEffort": "off"
},
"runScope": "both",
"type": "boolean",
"truePrompt": "<string>",
"falsePrompt": "<string>",
"systemTag": "<string>",
"id": "<string>",
"default": true
}
],
"version": {
"_id": "<string>",
"name": "<string>",
"model": "<VersionModel>",
"legacyID": "<string>",
"updatedAt": "<string>",
"updatedBy": 0,
"settings": "<VersionSettings>",
"_version": 0,
"creatorID": 0,
"projectID": "<string>",
"manualSave": true,
"publishedAt": "<string>",
"platformData": {
"slots": [
"<VersionSlot>"
],
"intents": [
"<VersionIntent>"
],
"settings": "<VersionPlatformSettings>",
"publishing": {}
},
"customBlocks": {},
"rootDiagramID": "<string>",
"canvasTemplates": [
"<VersionCanvasTemplate>"
],
"programResources": "<VersionProgramResources>",
"templateDiagramID": "<string>",
"defaultStepColors": {},
"autoSaveFromRestore": true,
"notes": {},
"topics": [
"<VersionFolderItem>"
],
"folders": {},
"domains": [
"<VersionDomain>"
],
"prototype": "<VersionPrototype>",
"components": [
"<VersionFolderItem>"
],
"variables": [
"<string>"
],
"knowledgeBase": "<VersionKnowledgeBase>",
"secondaryVersionID": 0
},
"diagrams": {},
"intents": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"description": "<string>",
"entityOrder": [
"<string>"
],
"automaticReprompt": true,
"automaticRepromptSettings": "<AutomaticReprompt>"
}
],
"utterances": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"text": "<UtteranceText>",
"language": "<Language>",
"intentID": "<string>"
}
],
"requiredEntities": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"intentID": "<string>",
"entityID": "<string>",
"repromptID": "<string>"
}
],
"responses": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"name": "<string>",
"type": null,
"draft": null
}
],
"responseMessages": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"text": "<Markup>",
"delay": 0,
"condition": "<AnyCondition>",
"discriminatorID": "<string>"
}
],
"responseDiscriminators": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"channel": "<Channel>",
"language": "<Language>",
"responseID": "<string>",
"variantOrder": [
"<string>"
]
}
],
"functions": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"code": "<string>",
"image": "<string>",
"pathOrder": [
"<string>"
],
"description": "<string>",
"settings": "<FunctionSettings>"
}
],
"functionPaths": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"label": "<string>",
"functionID": "<string>"
}
],
"functionVariables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"type": "<FunctionVariableKind>",
"functionID": "<string>",
"description": "<string>"
}
],
"flows": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"name": "<string>",
"diagramID": "<string>",
"description": "<string>"
}
],
"agents": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"endTool": null,
"settings": "<AgentSettings>",
"cardTool": null,
"isOperator": false,
"buttonTool": null,
"description": "<string>",
"instructions": "<Markup>",
"skipTurnTool": null,
"carouselTool": null,
"pathToolOrder": [
"<string>"
],
"webSearchTool": "<AgentWebSearchTool>",
"callForwardTool": null,
"knowledgeBaseTool": "<AgentKnowledgeBaseTool>"
}
],
"agentAPITools": [],
"agentFlowTools": [],
"agentPathTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"agentID": "<string>",
"description": "<string>",
"variableOrder": [
"<string>"
],
"messages": null
}
],
"agentFunctionTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"functionID": "<string>",
"description": "<string>",
"inputVariables": {},
"captureResponse": {},
"toolSound": null,
"agentID": "<string>",
"messages": null,
"asyncExecution": false,
"captureInputVariables": {}
}
],
"agentIntegrationTools": [],
"agentFlowToolVariables": [],
"agentPathToolVariables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"kind": "<AgentToolVariableKind>",
"entityID": "<string>",
"variableID": "<string>",
"description": "<string>",
"agentPathToolID": "<string>"
}
],
"agentMcpIntegrationTools": [],
"events": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"name": "<string>",
"flowID": null,
"goesTo": null,
"isSystem": true,
"requestName": "<string>",
"description": "<string>"
}
],
"entities": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"color": "<string>",
"isArray": true,
"classifier": "<string>",
"description": "<string>"
}
],
"entityVariants": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"value": "<string>",
"language": "<Language>",
"synonyms": [
"<string>"
],
"entityID": "<string>"
}
],
"folders": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"scope": "<FolderScope>",
"parentID": "<string>"
}
],
"prompts": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"draft": null,
"settings": "<PromptSettings>",
"description": "<string>",
"messageOrder": [
"<string>"
]
}
],
"promptMessages": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"type": "<PromptMessageType>",
"data": "<PromptMessageData>",
"pairID": "<string>",
"promptID": "<string>"
}
],
"apiTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"url": "<Markup>",
"body": "<APIToolBody>",
"image": "<string>",
"headers": [
"<APIToolKeyValue>"
],
"httpMethod": "<APIToolHTTPMethodType>",
"description": "<string>",
"queryParameters": [
"<APIToolKeyValue>"
],
"settings": "<APIToolSettings>"
}
],
"apiToolInputVariables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"apiToolID": "<string>",
"description": "<string>"
}
],
"simulations": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"settings": "<SimulationSettings>",
"turnOrder": [
"<string>"
]
}
],
"simulationTurns": [
"<UserSimulationTurn>"
],
"simulationTurnTests": [
"<ToolSimulationTurnTest>"
],
"variables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"color": "<string>",
"isArray": true,
"isSystem": true,
"datatype": "<VariableDatatype>",
"description": "<string>",
"defaultValue": "<string>",
"resetAfter": "never"
}
],
"workflows": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"status": "<WorkflowStatus>",
"name": "<string>",
"isStart": true,
"diagramID": "<string>",
"assigneeID": 0,
"description": "<string>"
}
],
"attachments": [
"<CardAttachment>"
],
"cardButtons": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"label": "<Markup>",
"cardID": "<string>"
}
],
"integrationTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"toolName": "<IntegrationToolName>",
"description": "<string>",
"toolProvider": "<IntegrationToolProvider>"
}
],
"mcpIntegrationTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"description": "<string>",
"mcpServerToolID": "<string>"
}
],
"mcpServers": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"image": null,
"description": null,
"specification": "2025-03-26",
"url": null,
"headers": null,
"authType": "custom",
"oauthMetadata": null
}
],
"mcpServerTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"toolName": "<string>",
"description": "<string>",
"inputSchema": "<JsonSchema>",
"mcpServerID": "<string>"
}
],
"personas": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"items": [
"<PersonaItem>"
]
}
],
"kbDocumentVersions": [
{
"id": "<string>",
"documentID": "<string>",
"versionID": "<string>",
"folderID": "<string>"
}
],
"kbSettings": {
"id": "<string>",
"versionID": "<string>",
"summarization": "<KnowledgeBaseSummarization>",
"chunkStrategy": "<KnowledgeBaseChunkStrategy>",
"search": "<KnowledgeBaseSearch>",
"embeddingModel": "<KnowledgeBaseEmbeddingModel>"
},
"kbDocumentMetadataM2M": [
{
"id": "<string>",
"metadataFieldID": "<string>",
"documentID": "<string>",
"versionID": "<string>"
}
]
}Authorizations
Response
200 - application/jsonReturns 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. Most sections appear only when the environment has something of that kind.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
@deprecated not used anymore
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The model settings passed when invoking this evaluation.
Show child attributes
gpt-3.5-turbo-1106, gpt-3.5-turbo, gpt-4, gpt-4o, gpt-4o-mini, gpt-4.1-2025-04-14, gpt-4.1-mini-2025-04-14, gpt-4.1-nano-2025-04-14, gpt-o3-mini, o3-2025-04-16, o4-mini-2025-04-16, gpt-5, gpt-5-mini, gpt-5-nano, gpt-5.2, gpt-5.4, gpt-5.4-mini, gpt-5.5, gpt-5.6-sol, gpt-5.6-terra, gpt-5.6-luna, gpt-realtime, gpt-live-1, claude-4-opus, claude-4-sonnet, claude-4.5-sonnet, claude-4.6-sonnet, claude-4.5-haiku, claude-4.5-opus, claude-4.7-opus, bedrock-claude-4-sonnet, bedrock-claude-4.5-sonnet, bedrock-claude-4.6-sonnet, bedrock-claude-5-sonnet, bedrock-claude-4.5-haiku, bedrock-claude-4.5-opus, bedrock-claude-4.7-opus, bedrock-claude-4.8-opus, voiceflow-core-4.0, voiceflow-core-4.1, voiceflow-flash-4.2, kimi-k3, gemini-2.5-pro, gemini-2.5-flash, gemini-live-2.5-flash, gemini-3-flash, gemini-3.5-flash, gemini-3.1-pro, gpt-oss-20b, gpt-oss-120b, llama-guard-4, llama-3.1-instant, llama-3.3-versatile, qwen3.6-27b, grok-4.6, voiceflow-flash-4.1, gemini-flash-2, gpt-4-turbo, claude-3.5-haiku, claude-3-opus, claude-3.7-sonnet, claude-v2, llama-3.2-1b-preview, gemini-pro-1.5, claude-3-haiku, claude-3-sonnet, text-davinci-003, claude-v1, claude-instant-v1, deep-seek-r1-distill-llama-70B, claude-3.5-sonnetShow child attributes
The model settings passed when invoking this evaluation.
Show child attributes
gpt-3.5-turbo-1106, gpt-3.5-turbo, gpt-4, gpt-4o, gpt-4o-mini, gpt-4.1-2025-04-14, gpt-4.1-mini-2025-04-14, gpt-4.1-nano-2025-04-14, gpt-o3-mini, o3-2025-04-16, o4-mini-2025-04-16, gpt-5, gpt-5-mini, gpt-5-nano, gpt-5.2, gpt-5.4, gpt-5.4-mini, gpt-5.5, gpt-5.6-sol, gpt-5.6-terra, gpt-5.6-luna, gpt-realtime, gpt-live-1, claude-4-opus, claude-4-sonnet, claude-4.5-sonnet, claude-4.6-sonnet, claude-4.5-haiku, claude-4.5-opus, claude-4.7-opus, bedrock-claude-4-sonnet, bedrock-claude-4.5-sonnet, bedrock-claude-4.6-sonnet, bedrock-claude-5-sonnet, bedrock-claude-4.5-haiku, bedrock-claude-4.5-opus, bedrock-claude-4.7-opus, bedrock-claude-4.8-opus, voiceflow-core-4.0, voiceflow-core-4.1, voiceflow-flash-4.2, kimi-k3, gemini-2.5-pro, gemini-2.5-flash, gemini-live-2.5-flash, gemini-3-flash, gemini-3.5-flash, gemini-3.1-pro, gpt-oss-20b, gpt-oss-120b, llama-guard-4, llama-3.1-instant, llama-3.3-versatile, qwen3.6-27b, grok-4.6, voiceflow-flash-4.1, gemini-flash-2, gpt-4-turbo, claude-3.5-haiku, claude-3-opus, claude-3.7-sonnet, claude-v2, llama-3.2-1b-preview, gemini-pro-1.5, claude-3-haiku, claude-3-sonnet, text-davinci-003, claude-v1, claude-instant-v1, deep-seek-r1-distill-llama-70B, claude-3.5-sonnetShow child attributes
The model settings passed when invoking this evaluation.
Show child attributes
gpt-3.5-turbo-1106, gpt-3.5-turbo, gpt-4, gpt-4o, gpt-4o-mini, gpt-4.1-2025-04-14, gpt-4.1-mini-2025-04-14, gpt-4.1-nano-2025-04-14, gpt-o3-mini, o3-2025-04-16, o4-mini-2025-04-16, gpt-5, gpt-5-mini, gpt-5-nano, gpt-5.2, gpt-5.4, gpt-5.4-mini, gpt-5.5, gpt-5.6-sol, gpt-5.6-terra, gpt-5.6-luna, gpt-realtime, gpt-live-1, claude-4-opus, claude-4-sonnet, claude-4.5-sonnet, claude-4.6-sonnet, claude-4.5-haiku, claude-4.5-opus, claude-4.7-opus, bedrock-claude-4-sonnet, bedrock-claude-4.5-sonnet, bedrock-claude-4.6-sonnet, bedrock-claude-5-sonnet, bedrock-claude-4.5-haiku, bedrock-claude-4.5-opus, bedrock-claude-4.7-opus, bedrock-claude-4.8-opus, voiceflow-core-4.0, voiceflow-core-4.1, voiceflow-flash-4.2, kimi-k3, gemini-2.5-pro, gemini-2.5-flash, gemini-live-2.5-flash, gemini-3-flash, gemini-3.5-flash, gemini-3.1-pro, gpt-oss-20b, gpt-oss-120b, llama-guard-4, llama-3.1-instant, llama-3.3-versatile, qwen3.6-27b, grok-4.6, voiceflow-flash-4.1, gemini-flash-2, gpt-4-turbo, claude-3.5-haiku, claude-3-opus, claude-3.7-sonnet, claude-v2, llama-3.2-1b-preview, gemini-pro-1.5, claude-3-haiku, claude-3-sonnet, text-davinci-003, claude-v1, claude-instant-v1, deep-seek-r1-distill-llama-70B, claude-3.5-sonnetShow child attributes
The model settings passed when invoking this evaluation.
Show child attributes
gpt-3.5-turbo-1106, gpt-3.5-turbo, gpt-4, gpt-4o, gpt-4o-mini, gpt-4.1-2025-04-14, gpt-4.1-mini-2025-04-14, gpt-4.1-nano-2025-04-14, gpt-o3-mini, o3-2025-04-16, o4-mini-2025-04-16, gpt-5, gpt-5-mini, gpt-5-nano, gpt-5.2, gpt-5.4, gpt-5.4-mini, gpt-5.5, gpt-5.6-sol, gpt-5.6-terra, gpt-5.6-luna, gpt-realtime, gpt-live-1, claude-4-opus, claude-4-sonnet, claude-4.5-sonnet, claude-4.6-sonnet, claude-4.5-haiku, claude-4.5-opus, claude-4.7-opus, bedrock-claude-4-sonnet, bedrock-claude-4.5-sonnet, bedrock-claude-4.6-sonnet, bedrock-claude-5-sonnet, bedrock-claude-4.5-haiku, bedrock-claude-4.5-opus, bedrock-claude-4.7-opus, bedrock-claude-4.8-opus, voiceflow-core-4.0, voiceflow-core-4.1, voiceflow-flash-4.2, kimi-k3, gemini-2.5-pro, gemini-2.5-flash, gemini-live-2.5-flash, gemini-3-flash, gemini-3.5-flash, gemini-3.1-pro, gpt-oss-20b, gpt-oss-120b, llama-guard-4, llama-3.1-instant, llama-3.3-versatile, qwen3.6-27b, grok-4.6, voiceflow-flash-4.1, gemini-flash-2, gpt-4-turbo, claude-3.5-haiku, claude-3-opus, claude-3.7-sonnet, claude-v2, llama-3.2-1b-preview, gemini-pro-1.5, claude-3-haiku, claude-3-sonnet, text-davinci-003, claude-v1, claude-instant-v1, deep-seek-r1-distill-llama-70B, claude-3.5-sonnetShow child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
@deprecated prefer adding version-level compiled artifacts to `programResources
Show child attributes
Show child attributes
Show child attributes
@deprecated not used
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
entity, variableShow child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
example_dynamic_schema, zendesk_find_user, zendesk_find_group, zendesk_find_ticket, zendesk_create_ticket, zendesk_update_ticket, zendesk_add_ticket_comment, zendesk_update_organization, zendesk_find_latest_comment, salesforce_create_lead, salesforce_update_lead, salesforce_create_contact, salesforce_update_contact, salesforce_create_case, salesforce_update_case, salesforce_add_comment_to_case, shopify_get_products, shopify_get_order, shopify_cancel_order, shopify_update_order, google_sheets_create_spreadsheet, google_sheets_update_spreadsheet, google_sheets_read_spreadsheet, google_sheets_append_spreadsheet, google_sheets_read_row, google_gmail_send_email, airtable_create_records, airtable_delete_records, airtable_get_record, airtable_list_records, airtable_update_records, make_run_scenario, twilio_send_sms, hubspot_create_contact, hubspot_create_lead, hubspot_create_ticketShow child attributes
Show child attributes
Show child attributes
Show child attributes
prompt, memory, memory_promptShow child attributes
recursive_text_splitterWas this page helpful?
Thanks for your feedback.