Skip to navigation
Gateway APIServices

Run a tool of a connected service

View as Markdown

Execute a tool of a connected service for this organization. Give the tool slug (service__tool, from list_service_tools) and its arguments. To use a specific connection, give its connectionId.

Authentication

AuthorizationBearer

A Basement key (bsmt_...), from Agents, Connect in the app.

Request

This endpoint expects an object.
toolSlugstringRequired

The tool slug from list_service_tools, e.g. jira__create_issue

toolkitSlugstringOptional
Ignored. Basement always takes the service from toolSlug
connectionIdstringOptional

Optional connectionId from list_connected_services, to use a specific connected account. Default: the most recently updated connection of the service

argumentsobjectOptional
Arguments object that matches the tool's input schema

Response

The tool's answer.
contentlist of objectsOptional
structuredContentobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error