Skip to main content

​
API Server Introduction

The Voiceflow CLI now includes an HTTP API server that exposes test execution functionality as REST endpoints with auto-generated OpenAPI/Swagger documentation.

​
Features

  • HTTP API: Execute test suites via REST endpoints
  • Real-time Logging: Capture and return test execution logs in API responses
  • OpenAPI/Swagger: Auto-generated API documentation at /swagger/index.html
  • Asynchronous Execution: Non-blocking test execution with status tracking
  • CORS Support: Enable cross-origin requests for web frontends
  • Health Checks: Built-in health check endpoints

​
OpenAPI Specifications

The server provides OpenAPI specifications in both YAML and JSON formats: These specifications can be used to generate client libraries, import into API testing tools, or integrate with other OpenAPI-compatible tooling.

​
Starting the Server

​
Basic Usage

# Start server on default port (8080)
voiceflow server

# Start server on custom port
voiceflow server --port 9090

# Start server with debug mode
voiceflow server --debug

# Start server with custom host
voiceflow server --host 127.0.0.1 --port 8080

​
Command Line Options

FlagShortDefaultDescription
--port-p8080Port to run the server on
--host-H0.0.0.0Host to bind the server to
--debug-dfalseEnable debug mode
--corstrueEnable CORS middleware
--swaggertrueEnable Swagger documentation endpoint

​
Configuration

​
Environment Variables

The server respects all existing Voiceflow CLI environment variables:
  • VF_API_KEY: Voiceflow API Key (from the Settings tab)
  • OPENAI_API_KEY: OpenAI API Key (for similarity validations)

​
CORS Configuration

CORS is enabled by default. To disable CORS: 
voiceflow server --cors=false

​
Debug Mode

Enable debug mode for detailed logging: 
voiceflow server --debug