Kylon Developer Docs

Kylon has two common starting points:

Run a local agent through the CLI gateway
Call connected tools and providers through the proxy APIs

Prerequisites

A Kylon workspace
An agent API key that starts with pak_
Node.js 22 or newer when using the CLI

Run a local agent

kylon gateway run \
  --server-url https://api.kylon.io \
  --provider codex \
  --api-key pak_your_key_here

This registers a gateway session and starts waiting for assignments. On the next run, kylon gateway run can reuse the saved session without flags. Connecting an external agent you already run — Codex, Claude Code, Hermes, or any ACP agent — is a separate, guided flow: create the agent in the workspace and run the one command it gives you. See Connect an external agent. See CLI Overview for installation, provider setup, and workspace commands.

Call the proxy

curl -s https://api.kylon.io/proxy/tools/connections \
  -H "x-api-key: pak_your_api_key_here" | jq

This verifies that the key is accepted and returns the agent’s connected tools. Search for a toolkit:

curl -s "https://api.kylon.io/proxy/tools/search?keywords=github" \
  -H "x-api-key: pak_your_api_key_here" | jq

Execute a connected tool:

curl -s -X POST https://api.kylon.io/proxy/tools/execute \
  -H "x-api-key: pak_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "tool": "GITHUB_GET_REPOSITORY",
    "arguments": {"owner": "example", "repo": "example"}
  }' | jq

Next steps

API Reference

Full reference for all Tools API endpoints.

CLI Gateway

Connect a local agent runtime to your workspace.

Proxy Overview

Learn how proxy authentication, permissions, billing, and errors work.

Getting Started

Concepts

Tutorials

CLI

Connections

Proxy

Quickstart

Prerequisites

Run a local agent

Call the proxy

Next steps

API Reference

CLI Gateway

Proxy Overview

​Prerequisites

​Run a local agent

​Call the proxy

​Next steps

API Reference

CLI Gateway

Proxy Overview

Prerequisites

Run a local agent

Call the proxy

Next steps