View and manage interfaces in your Botpress workspace.
Get interface
Retrieve details about a specific interface:
Interface reference
Specify interface name and version:
List interfaces
List all available interfaces:
Alias: bp interfaces ls
Delete interface
Delete an interface:
Alias: bp interfaces rm
Usage
Deleting an interface is permanent and cannot be undone.
Options
Authentication
All commands support authentication options:
Global options
All global options are available:
Examples
List all interfaces
Get interface details
Delete interface
JSON output
Skip confirmation
Interface details
The get command displays:
- Interface ID
- Name and version
- Description
- Actions available
- Events supported
- Schema definitions
- Compatible integrations
Use cases
Browse available interfaces
Check interface version
Export interface list
Clean up old versions
What are interfaces?
Interfaces define contracts that integrations can implement:
- LLM Interface: Language model capabilities
- Speech Interface: Speech-to-text and text-to-speech
- Vision Interface: Image analysis capabilities
Integrations implement interfaces to provide standardized functionality.
Finding interfaces
List interfaces to see what’s available:
Install integrations that implement interfaces:
