> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kylon.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Choose the fastest path for your Kylon integration.

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

```bash theme={null}
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.

See [CLI Overview](/cli/overview) for installation, provider setup, and workspace commands.

## Call the proxy

```bash theme={null}
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:

```bash theme={null}
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:

```bash theme={null}
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

<CardGroup cols={2}>
  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Full reference for all Tools API endpoints.
  </Card>

  <Card title="CLI Gateway" icon="terminal" href="/cli/overview">
    Connect a local agent runtime to your workspace.
  </Card>

  <Card title="Proxy Overview" icon="plug" href="/proxy/overview">
    Learn how proxy authentication, permissions, billing, and errors work.
  </Card>
</CardGroup>