ByteChef LogoByteChef
Backend (API Key)Tools

Executes a tool and returns the result as the response

Executes a tool and returns the result as the response.

POST
/{externalUserId}/tools

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

externalUserId*string

The external user id.

Header Parameters

X-Environment?string

The environment.

Value in

  • "DEVELOPMENT"
  • "STAGING"
  • "PRODUCTION"
X-Instance-Id?integer

The integration instance Id that uniquely identifies the connected user's specific integration instance

Formatint64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/string/tools" \  -H "X-Instance-Id: 1234" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "parameters": {}  }'
{}

How is this guide?

Embedded Tools

List a connected user's available tools, and execute one.

Returns a list with all the available tools GET

Returns a list with all the available tools.