Skip to main content
The Tools API is the primary proxy surface for connected integrations.

List connections

curl -s https://api.kylon.io/proxy/tools/connections \
  -H "x-api-key: pak_your_key_here" | jq
Returns the connections currently linked to the calling agent.

Search toolkits

curl -s "https://api.kylon.io/proxy/tools/search?keywords=gmail&limit=10" \
  -H "x-api-key: pak_your_key_here" | jq
Query parameters:
ParameterDescription
keywordsRequired search string
limitOptional result limit
cursorOptional pagination cursor

Start toolkit authorization

curl -s -X POST https://api.kylon.io/proxy/tools/auth \
  -H "x-api-key: pak_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "toolkit": "gmail",
    "redirect_url": "https://example.com/connected"
  }' | jq
The response includes a redirect URL. Open it in a browser so the user can authorize the toolkit.

Get toolkit details

curl -s "https://api.kylon.io/proxy/tools/toolkit/gmail?limit=20" \
  -H "x-api-key: pak_your_key_here" | jq
Returns toolkit metadata and available tools, including input schemas where available.

Search tools within a toolkit

curl -s "https://api.kylon.io/proxy/tools/toolkit/gmail/search?q=draft&limit=10" \
  -H "x-api-key: pak_your_key_here" | jq
Query parameters:
ParameterDescription
qSearch query
limitOptional result limit
cursorOptional pagination cursor
connection_idOptional connection filter

Execute a tool

curl -s -X POST https://api.kylon.io/proxy/tools/execute \
  -H "x-api-key: pak_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "tool": "GMAIL_SEND_EMAIL",
    "arguments": {
      "to": "person@example.com",
      "subject": "Hello from Kylon",
      "body": "This was sent through a connected tool."
    }
  }' | jq
Request body:
FieldRequiredDescription
toolYesTool slug/name
argumentsNoTool input object
connection_idNoSpecific connection to use

Proxy a native toolkit request

curl -s -X POST https://api.kylon.io/proxy/tools/proxy \
  -H "x-api-key: pak_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "toolkit": "github",
    "method": "GET",
    "url": "https://api.github.com/user/repos"
  }' | jq
This endpoint is for toolkit-native API calls where Kylon manages the connection credentials. Request body:
FieldRequiredDescription
toolkitYesToolkit slug
methodYesHTTP method
urlYesTarget provider URL
headersNoAdditional request headers
bodyNoRequest body
connection_idNoSpecific connection to use

Upload media for tool use

curl -s -X POST https://api.kylon.io/proxy/tools/upload \
  -H "x-api-key: pak_your_key_here" \
  -F "file=@./image.png" | jq
Uploads media to Kylon staging and returns a reference usable by supported tool calls.

OpenAPI reference

The current generated API reference covers each Tools API endpoint: