Kylon Developer Docs

POST

proxy

tools

execute

Execute tool

curl --request POST \
  --url https://api.kylon.io/proxy/tools/execute \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "tool": "<string>",
  "arguments": {},
  "connection_id": "<string>"
}
'

{
  "data": "<unknown>",
  "error": "<string>",
  "successful": true
}

Authorizations

x-api-key

string

header

required

API key for authentication. Can also be passed as Authorization: Bearer <token>.

Body

application/json

tool

string

required

Tool slug (from toolkit details).

arguments

object

Tool-specific arguments.

connection_id

string

Specify which connection to use. Required if multiple connections exist for the same toolkit.

Response

Successful response

data

any

required

Tool execution result data.

error

string | null

required

Error message if execution failed.

successful

boolean

required

Proxy RequestMake an authenticated HTTP request through a native toolkit's API. The system injects the connection's credentials automatically.

Execute tool

curl --request POST \
  --url https://api.kylon.io/proxy/tools/execute \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "tool": "<string>",
  "arguments": {},
  "connection_id": "<string>"
}
'

{
  "data": "<unknown>",
  "error": "<string>",
  "successful": true
}