Interface management

Manage Botpress interfaces

View and manage interfaces in your Botpress workspace.

Get interface

Retrieve details about a specific interface:

bp interfaces get <interface>

Interface reference

Specify interface name and version:

bp interfaces get llm@5.1.0

List interfaces

List all available interfaces:

bp interfaces list

Alias: bp interfaces ls

Delete interface

Delete an interface:

bp interfaces delete <interface>

Alias: bp interfaces rm

Usage

bp interfaces delete llm@5.1.0

Deleting an interface is permanent and cannot be undone.

Options

Authentication

All commands support authentication options:

bp interfaces list --token YOUR_TOKEN
bp interfaces list --workspaceId abc123
bp interfaces list --apiUrl https://api.botpress.cloud

Global options

All global options are available:

bp interfaces list --json
bp interfaces list --verbose

Examples

List all interfaces

bp interfaces list

Get interface details

bp interfaces get llm@5.1.0

Delete interface

bp interfaces delete llm@5.0.0

JSON output

bp interfaces list --json > interfaces.json

Skip confirmation

bp interfaces delete llm@5.0.0 -y

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

bp interfaces list

Check interface version

bp interfaces get llm@5.1.0

Export interface list

bp interfaces list --json > workspace-interfaces.json

Clean up old versions

bp interfaces delete llm@5.0.0

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:

bp interfaces list

Install integrations that implement interfaces:

bp add gpt --interface llm@5.1.0

Related commands

• bp add - Install integrations and interfaces
• bp integrations list - List integrations implementing interfaces