Skip to navigation
API do GatewayServices

Run a read tool of a connected service

View as Markdown

Run a read-only tool of a connected service (for example SAP, Jira or GLPI). Give the tool slug (service__tool) and its arguments: list_service_tools gives both, and a read tool has mode read there. This tool refuses a tool that changes data. 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 slug of a read tool from list_service_tools, e.g. sap__read_source

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