Botpress Tools

Botpress Get Public Interface

Tool to get a public interface by name and version from the Botpress Hub. Use when you need to retrieve interface specifications, schemas, or metadata for integrations.

Write ActionRisk level 2 of 5API key connectionFree Action

Use Botpress Get Public Interface

Owner App

Botpress ToolsApp

Required inputs

nameRequiredstring

Interface name to retrieve

versionRequiredstring

Interface version. Either a semver version, semver version range, or the constant string 'latest'

xMultipleIntegrationsstring

Whether the client supports bots with multiple instances of the same integration. Set to 'true' to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Observable output

dataRequired
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulRequiredboolean
Whether or not the action execution was successful or not

Setup and approval

API key connection. Risk level 2 of 5.

Pricing and limits

Free Action

Unified payment: Not currently supported

Skills that use this Action

No published Skills explicitly reference this Action yet.

Official source

Provider source