Skip to main content
GET
/
v1alpha1
/
project
/
{projectID}
/
environment
/
{projectEnvironmentAlias}
/
export-json
Export environment JSON
curl --request GET \
  --url https://realtime-api.voiceflow.com/v1alpha1/project/{projectID}/environment/{projectEnvironmentAlias}/export-json \
  --header 'authorization: <api-key>'
{
  "project": {
    "_id": "<string>",
    "name": "<string>",
    "teamID": "<string>",
    "members": [
      {
        "creatorID": 123,
        "platformData": {}
      }
    ],
    "platform": "<string>",
    "creatorID": 123,
    "platformData": {},
    "nlu": "<string>",
    "type": "<string>",
    "image": "<string>",
    "_version": 123,
    "linkType": "<string>",
    "stickers": [
      {
        "id": "<string>",
        "url": "<string>"
      }
    ],
    "updatedBy": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "reportTags": {},
    "nluSettings": {
      "classifyStrategy": "<string>"
    },
    "environments": {},
    "customThemes": [
      {
        "palette": {
          "50": "<string>",
          "100": "<string>",
          "200": "<string>",
          "300": "<string>",
          "400": "<string>",
          "500": "<string>",
          "600": "<string>",
          "700": "<string>",
          "800": "<string>",
          "900": "<string>"
        },
        "standardColor": "<string>",
        "name": "<string>"
      }
    ],
    "aiAssistSettings": {
      "aiPlayground": true,
      "generateStep": true,
      "generativeTasks": true,
      "generateNoMatch": true
    },
    "transcriptSettings": {
      "saveTestTranscripts": true,
      "inactiveTimeout": 10,
      "saveTranscriptsWithNoInteraction": true
    },
    "devVersion": "<string>",
    "liveVersion": "<string>",
    "stagingVersion": "<string>",
    "previewVersion": "<string>",
    "knowledgeBase": {
      "faqSets": {},
      "settings": {
        "summarization": {
          "prompt": "<string>",
          "system": "<string>",
          "maxTokens": 123,
          "temperature": 123
        },
        "chunkStrategy": {
          "size": 123,
          "overlap": 123
        },
        "search": {
          "limit": 123,
          "metric": "<string>"
        },
        "embeddingModel": {
          "model": "<string>",
          "size": 123
        }
      },
      "documents": {}
    }
  },
  "version": {
    "_id": "<string>",
    "name": "<string>",
    "_version": 123,
    "creatorID": 123,
    "projectID": "<string>",
    "platformData": {
      "slots": [
        {
          "key": "<string>",
          "name": "<string>",
          "type": {
            "value": "<string>"
          },
          "inputs": [
            "<string>"
          ],
          "color": "<string>"
        }
      ],
      "intents": [
        {
          "key": "<string>",
          "name": "<string>",
          "inputs": [
            {
              "text": "<string>",
              "slots": [
                "<string>"
              ],
              "voice": "<string>"
            }
          ],
          "slots": [
            {
              "id": "<string>",
              "dialog": {
                "prompt": [
                  "<unknown>"
                ],
                "confirm": [
                  "<unknown>"
                ],
                "utterances": [
                  {
                    "text": "<string>",
                    "slots": [
                      "<string>"
                    ],
                    "voice": "<string>"
                  }
                ],
                "confirmEnabled": true
              },
              "required": true
            }
          ],
          "noteID": "<string>",
          "description": "<string>"
        }
      ],
      "settings": {
        "locales": [
          "<string>"
        ],
        "deepgramASR": {
          "punctuationWaitMS": 123,
          "partialWaitMS": 123,
          "silenceWaitMS": 123,
          "interruptionWaitWords": 123,
          "audioCue": 123,
          "backgroundAudio": "<string>",
          "keywords": "<string>"
        },
        "globalNoReply": {
          "delay": 123,
          "prompt": null,
          "enabled": true,
          "maxRetries": 123
        },
        "defaultVoice": "<string>",
        "globalNoMatch": {
          "prompt": null
        },
        "messageDelay": {
          "durationMilliseconds": 123
        }
      },
      "publishing": {}
    },
    "rootDiagramID": "<string>",
    "variables": [
      "<string>"
    ],
    "model": {
      "modelID": "<string>"
    },
    "legacyID": "<string>",
    "updatedAt": "<string>",
    "updatedBy": 123,
    "settings": {
      "intentClassification": {
        "params": {
          "temperature": 123
        },
        "promptWrapper": {
          "content": "<string>"
        }
      },
      "ui": {
        "transcripts": {
          "sectionsOrderIDs": [
            "<string>"
          ]
        },
        "analytics": {
          "sectionsOrderIDs": [
            "<string>"
          ]
        }
      },
      "llm": {
        "globalPrompts": {
          "persona": [
            "<string>"
          ],
          "guidelines": [
            "<string>"
          ]
        },
        "defaultModels": {
          "global": {
            "maxTokens": 123,
            "temperature": 123
          }
        },
        "globalAgentID": "<string>",
        "priorityProcessing": true
      },
      "time": {},
      "voice": {
        "stt": {
          "vadSilenceThresholdSecs": 1.65,
          "vadThreshold": 0.5,
          "minSpeechDurationMS": 1025,
          "minSilenceDurationMS": 1025
        },
        "tts": {
          "voice": "<string>"
        },
        "pronunciationDictionary": [
          {
            "from": "<string>",
            "to": "<string>"
          }
        ],
        "failureMessage": "<string>",
        "hasCallRecording": true,
        "audioCue": 123,
        "backgroundAudio": "<string>",
        "audioSync": true,
        "keypadInput": {
          "enabled": true,
          "delimiter": [],
          "timeoutInSeconds": 123
        },
        "silenceTimeoutMs": 123
      },
      "widget": {
        "chat": {
          "headerImage": {
            "enabled": true,
            "url": "<string>"
          },
          "agentImage": {
            "enabled": true,
            "url": "<string>"
          },
          "banner": {
            "title": "<string>",
            "description": "<string>",
            "enabled": true,
            "imageURL": "<string>"
          },
          "placeholderText": "<string>",
          "aiDisclaimer": {
            "text": "<string>",
            "enabled": true
          },
          "voiceInput": true,
          "voiceOutput": true,
          "disclaimer": {
            "enabled": true,
            "title": "<string>",
            "description": "<string>",
            "primaryButtonText": "<string>",
            "secondaryButtonText": "<string>",
            "secondaryButtonURL": "<string>"
          },
          "handoffToAgentImageURL": "<string>",
          "streamingDisabled": true,
          "responseLoader": {},
          "voiceOutputMuted": true,
          "voiceMode": true,
          "fileUpload": {
            "enabled": true
          }
        },
        "voice": {
          "content": {
            "talkingText": "<string>",
            "endButtonText": "<string>",
            "listeningText": "<string>",
            "startButtonText": "<string>",
            "callToActionText": "<string>",
            "imageURL": "<string>"
          }
        },
        "common": {
          "sideSpacing": "<string>",
          "bottomSpacing": "<string>",
          "fontFamily": "<string>",
          "primaryColor": {
            "color": "<string>",
            "palette": {
              "50": "<string>",
              "100": "<string>",
              "200": "<string>",
              "300": "<string>",
              "400": "<string>",
              "500": "<string>",
              "600": "<string>",
              "700": "<string>",
              "800": "<string>",
              "900": "<string>"
            }
          },
          "poweredBy": true,
          "launcher": {
            "text": "<string>",
            "imageURL": "<string>"
          },
          "footerLink": {
            "enabled": true,
            "text": "<string>",
            "url": "<string>"
          },
          "featureFlags": {}
        },
        "security": {
          "approvedDomains": {
            "enabled": true,
            "domains": "<string>"
          },
          "disableTranscript": true,
          "isTranscriptDownloadEnabled": true
        }
      },
      "memory": {
        "turns": 10
      },
      "session": {
        "idleTimeout": {
          "enabled": true,
          "timeoutMs": 123
        }
      },
      "security": {
        "transcriptsPII": false
      },
      "framework": {
        "conversationInitializeComponentID": "<string>",
        "agenticInitializeComponentID": null
      },
      "analytics": {
        "estimatedSavings": {
          "resolutionRate": {
            "minutes": 123,
            "dollars": 123
          },
          "deflectionRate": {
            "minutes": 123,
            "dollars": 123
          }
        }
      },
      "globalCrew": {
        "agentID": "<string>",
        "subFlows": [
          {
            "flowID": "<string>",
            "description": "<string>"
          }
        ],
        "subAgents": [
          {
            "agentID": "<string>",
            "description": "<string>"
          }
        ],
        "agentDescription": "<string>"
      },
      "llmFallback": {
        "models": {}
      },
      "globalNoReply": {
        "delay": 123,
        "enabled": true,
        "prompt": [
          "<string>"
        ],
        "maxRetries": 123
      },
      "globalNoMatch": {
        "prompt": [
          "<string>"
        ]
      },
      "shareableLink": {
        "password": "<string>",
        "variableStateID": "<string>"
      },
      "automaticReprompt": {
        "params": {
          "system": "<string>",
          "maxTokens": 123,
          "temperature": 123
        }
      }
    },
    "manualSave": true,
    "publishedAt": "<string>",
    "customBlocks": {},
    "canvasTemplates": [
      {
        "id": "<string>",
        "name": "<string>",
        "color": "<string>",
        "nodeIDs": [
          "<string>"
        ]
      }
    ],
    "programResources": {
      "messages": {},
      "flows": {},
      "agents": {},
      "prompts": {},
      "apiTools": {},
      "globalCrew": {
        "agentID": "<string>",
        "nodeID": "<string>",
        "subFlows": [
          {
            "flowID": "<string>",
            "description": "<string>"
          }
        ],
        "diagramID": "<string>",
        "subAgents": [
          {
            "agentID": "<string>",
            "description": "<string>"
          }
        ],
        "agentDescription": "<string>"
      },
      "globalPrompts": {
        "persona": "<string>",
        "guidelines": "<string>"
      },
      "secretNameToId": {},
      "mcpServerTools": {},
      "integrationTools": {},
      "mcpIntegrationTools": {}
    },
    "templateDiagramID": "<string>",
    "defaultStepColors": {},
    "autoSaveFromRestore": true,
    "notes": {},
    "topics": [
      {
        "type": "<string>",
        "sourceID": "<string>"
      }
    ],
    "folders": {},
    "domains": [
      {
        "id": "<string>",
        "name": "<string>",
        "live": true,
        "topicIDs": [
          "<string>"
        ],
        "rootDiagramID": "<string>",
        "status": "<string>",
        "updatedBy": 123,
        "updatedAt": "<string>",
        "updatedByCreatorID": 123
      }
    ],
    "components": [
      {
        "type": "<string>",
        "sourceID": "<string>"
      }
    ],
    "knowledgeBase": {
      "faqSets": {},
      "settings": {
        "summarization": {
          "prompt": "<string>",
          "system": "<string>",
          "maxTokens": 123,
          "temperature": 123
        },
        "chunkStrategy": {
          "size": 123,
          "overlap": 123
        },
        "search": {
          "limit": 123,
          "metric": "<string>"
        },
        "embeddingModel": {
          "model": "<string>",
          "size": 123
        }
      },
      "documents": {}
    },
    "secondaryVersionID": 123
  },
  "diagrams": {},
  "secrets": [
    {
      "id": "<string>",
      "name": "<string>",
      "assistantID": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "hasValue": true
    }
  ],
  "_version": "<string>",
  "programs": {},
  "assistant": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedByID": 123,
    "name": "<string>",
    "version": 4503599627370495,
    "workspaceID": "<string>",
    "activeEnvironmentID": "<string>",
    "assistantID": "<string>",
    "environmentID": "<string>",
    "folderID": null,
    "isDeleted": true,
    "description": null
  },
  "variableStates": [
    {
      "_id": "<string>",
      "name": "<string>",
      "projectID": "<string>",
      "variables": {},
      "startFrom": {
        "stepID": "<string>",
        "diagramID": "<string>"
      }
    }
  ],
  "transcriptEvaluations": [
    {
      "name": "<string>",
      "enabled": true,
      "prompt": "<string>",
      "truePrompt": "<string>",
      "falsePrompt": "<string>",
      "default": true,
      "description": "<string>",
      "settings": {
        "realtime": {
          "voice": "<string>",
          "eagerness": "<string>"
        },
        "maxTokens": 123,
        "temperature": 123
      },
      "systemTag": "<string>",
      "id": "<string>"
    }
  ],
  "intents": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "name": "<string>",
      "folderID": "<string>",
      "createdByID": 123,
      "description": "<string>",
      "entityOrder": [
        "<string>"
      ],
      "automaticReprompt": true,
      "automaticRepromptSettings": {
        "params": {
          "system": "<string>",
          "maxTokens": 123,
          "temperature": 123
        }
      },
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "utterances": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "text": [
        "<string>"
      ],
      "intentID": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "requiredEntities": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "intentID": "<string>",
      "entityID": "<string>",
      "repromptID": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "responses": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "folderID": "<string>",
      "createdByID": 123,
      "name": "<string>",
      "assistantID": "<string>",
      "environmentID": "<string>",
      "type": null,
      "draft": null
    }
  ],
  "responseMessages": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "text": [
        "<string>"
      ],
      "delay": 123,
      "condition": {
        "code": [
          "<string>"
        ]
      },
      "discriminatorID": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "responseDiscriminators": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "responseID": "<string>",
      "variantOrder": [
        "<string>"
      ],
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "functions": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "name": "<string>",
      "folderID": "<string>",
      "createdByID": 123,
      "code": "<string>",
      "image": "<string>",
      "pathOrder": [
        "<string>"
      ],
      "description": "<string>",
      "assistantID": "<string>",
      "environmentID": "<string>",
      "settings": {
        "timeoutMs": 300000
      }
    }
  ],
  "functionPaths": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "label": "<string>",
      "functionID": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "functionVariables": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "functionID": "<string>",
      "description": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "flows": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "folderID": "<string>",
      "createdByID": 123,
      "name": "<string>",
      "diagramID": "<string>",
      "description": "<string>",
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "agents": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "name": "<string>",
      "folderID": "<string>",
      "createdByID": 123,
      "settings": {
        "realtime": {
          "voice": "<string>",
          "eagerness": "<string>"
        },
        "maxTokens": 123,
        "temperature": 123
      },
      "description": "<string>",
      "instructions": [
        "<string>"
      ],
      "pathToolOrder": [
        "<string>"
      ],
      "webSearchTool": {
        "enabled": true,
        "messages": null,
        "toolSound": null,
        "description": "<string>",
        "allowedDomains": [
          "<string>"
        ],
        "sourceUrlsCount": 3
      },
      "knowledgeBaseTool": {
        "enabled": true,
        "description": "<string>",
        "query": [
          "<string>"
        ],
        "filters": [
          {
            "description": "<string>",
            "defaultValue": [
              "<string>"
            ],
            "key": "<string>"
          }
        ],
        "messages": null,
        "toolSound": null,
        "chunkLimit": 123,
        "sourceUrlsCount": 3
      },
      "assistantID": "<string>",
      "environmentID": "<string>",
      "endTool": null,
      "cardTool": null,
      "isOperator": false,
      "buttonTool": null,
      "skipTurnTool": null,
      "carouselTool": null,
      "callForwardTool": null
    }
  ],
  "agentAPITools": [],
  "agentFlowTools": [],
  "agentPathTools": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "agentID": "<string>",
      "description": "<string>",
      "variableOrder": [
        "<string>"
      ],
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>",
      "messages": null
    }
  ],
  "agentFunctionTools": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "functionID": "<string>",
      "description": "<string>",
      "inputVariables": {},
      "agentID": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>",
      "captureResponse": null,
      "toolSound": null,
      "messages": null,
      "asyncExecution": false,
      "captureInputVariables": null
    }
  ],
  "agentIntegrationTools": [],
  "agentFlowToolVariables": [],
  "agentPathToolVariables": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "entityID": "<string>",
      "variableID": "<string>",
      "description": "<string>",
      "agentPathToolID": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "agentMcpIntegrationTools": [],
  "events": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "folderID": "<string>",
      "createdByID": 123,
      "name": "<string>",
      "isSystem": true,
      "requestName": "<string>",
      "description": "<string>",
      "assistantID": "<string>",
      "environmentID": "<string>",
      "flowID": null,
      "goesTo": null
    }
  ],
  "entities": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "name": "<string>",
      "folderID": "<string>",
      "createdByID": 123,
      "color": "<string>",
      "isArray": true,
      "classifier": "<string>",
      "description": "<string>",
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "entityVariants": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "value": "<string>",
      "synonyms": [
        "<string>"
      ],
      "entityID": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "folders": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "parentID": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "prompts": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "name": "<string>",
      "folderID": "<string>",
      "createdByID": 123,
      "settings": {
        "maxTokens": 123,
        "temperature": 123,
        "responseFormat": "<string>",
        "useStructuredOutput": true
      },
      "description": "<string>",
      "messageOrder": [
        "<string>"
      ],
      "assistantID": "<string>",
      "environmentID": "<string>",
      "draft": null
    }
  ],
  "promptMessages": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "data": {
        "content": [
          "<string>"
        ]
      },
      "pairID": "<string>",
      "promptID": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "apiTools": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "name": "<string>",
      "folderID": "<string>",
      "createdByID": 123,
      "url": [
        "<string>"
      ],
      "body": {
        "content": [
          "<string>"
        ]
      },
      "image": "<string>",
      "headers": [
        {
          "id": "<string>",
          "key": "<string>",
          "value": [
            "<string>"
          ]
        }
      ],
      "description": "<string>",
      "queryParameters": [
        {
          "id": "<string>",
          "key": "<string>",
          "value": [
            "<string>"
          ]
        }
      ],
      "assistantID": "<string>",
      "environmentID": "<string>",
      "settings": {
        "timeoutMs": 300000
      }
    }
  ],
  "apiToolInputVariables": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "apiToolID": "<string>",
      "description": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "simulations": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "name": "<string>",
      "folderID": "<string>",
      "createdByID": 123,
      "settings": {
        "launchEvent": "<string>",
        "variableStates": "<string>"
      },
      "turnOrder": [
        "<string>"
      ],
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "simulationTurns": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "payload": {
        "response": "<string>",
        "variableStates": "<string>"
      },
      "testOrder": [
        "<string>"
      ],
      "simulationID": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "environmentID": "<string>"
    }
  ],
  "simulationTurnTests": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "turnID": "<string>",
      "payload": {
        "tool": {},
        "shouldCall": true
      },
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "environmentID": "<string>"
    }
  ],
  "variables": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "name": "<string>",
      "folderID": "<string>",
      "createdByID": 123,
      "color": "<string>",
      "isArray": true,
      "isSystem": true,
      "description": "<string>",
      "defaultValue": "<string>",
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "workflows": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "folderID": "<string>",
      "createdByID": 123,
      "name": "<string>",
      "isStart": true,
      "diagramID": "<string>",
      "assigneeID": 123,
      "description": "<string>",
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "attachments": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "title": [
        "<string>"
      ],
      "mediaID": "<string>",
      "description": [
        "<string>"
      ],
      "buttonOrder": [
        "<string>"
      ],
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "cardButtons": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "label": [
        "<string>"
      ],
      "cardID": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "integrationTools": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "name": "<string>",
      "folderID": "<string>",
      "createdByID": 123,
      "description": "<string>",
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "mcpIntegrationTools": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "name": "<string>",
      "folderID": "<string>",
      "createdByID": 123,
      "description": "<string>",
      "mcpServerToolID": "<string>",
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "mcpServers": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "assistantID": "<string>",
      "name": "<string>",
      "folderID": "<string>",
      "createdByID": 123,
      "environmentID": "<string>",
      "image": null,
      "description": null
    }
  ],
  "mcpServerTools": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "name": "<string>",
      "folderID": "<string>",
      "createdByID": 123,
      "toolName": "<string>",
      "inputSchema": {},
      "mcpServerID": "<string>",
      "assistantID": "<string>",
      "environmentID": "<string>",
      "description": "<string>"
    }
  ],
  "personas": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByID": 123,
      "name": "<string>",
      "items": [
        {
          "id": "<string>",
          "variableID": "<string>",
          "value": "<string>"
        }
      ],
      "assistantID": "<string>",
      "environmentID": "<string>"
    }
  ],
  "kbDocumentVersions": [
    {
      "id": "<string>",
      "documentID": "<string>",
      "versionID": "<string>",
      "folderID": "<string>"
    }
  ],
  "kbSettings": {
    "id": "<string>",
    "versionID": "<string>",
    "summarization": {
      "prompt": "<string>",
      "system": "<string>",
      "maxTokens": 123,
      "temperature": 123
    },
    "chunkStrategy": {
      "size": 123,
      "overlap": 123
    },
    "search": {
      "limit": 123,
      "metric": "<string>"
    },
    "embeddingModel": {
      "model": "<string>",
      "size": 123
    }
  },
  "kbDocumentMetadataM2M": [
    {
      "id": "<string>",
      "metadataFieldID": "<string>",
      "documentID": "<string>",
      "versionID": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.voiceflow.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

authorization
string
header
required

Voiceflow API key

Path Parameters

projectID
string
required

ID of the project that owns the environments.

projectEnvironmentAlias
string
required

ID or alias of the environment to export.

Query Parameters

version
enum<string>
default:draft
Available options:
draft,
published

Response

200 - application/json
project
object
required
version
object
required
diagrams
object
required
secrets
object[]
_version
string
programs
object
assistant
object
variableStates
object[]
transcriptEvaluations
object[]
intents
object[]
utterances
object[]
requiredEntities
object[]
responses
object[]
responseMessages
object[]
responseDiscriminators
object[]
functions
object[]
functionPaths
object[]
functionVariables
object[]
flows
object[]
agents
object[]
agentAPITools
object[]
agentFlowTools
object[]
agentPathTools
object[]
agentFunctionTools
object[]
agentIntegrationTools
object[]
agentFlowToolVariables
object[]
agentPathToolVariables
object[]
agentMcpIntegrationTools
object[]
events
object[]
entities
object[]
entityVariants
object[]
folders
object[]
prompts
object[]
promptMessages
object[]
apiTools
object[]
apiToolInputVariables
object[]
simulations
object[]
simulationTurns
object[]
simulationTurnTests
object[]
variables
object[]
workflows
object[]
attachments
object[]
cardButtons
object[]
integrationTools
object[]
mcpIntegrationTools
object[]
mcpServers
object[]
mcpServerTools
object[]
personas
object[]
kbDocumentVersions
object[]
kbSettings
object
kbDocumentMetadataM2M
object[]