Skip to content

docs: Document AGENT_CONTROL_RUNTIME_TOKEN_HEADER #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sheilattran8 wants to merge 1 commit into
base: main
Choose a base branch
from
+32 −0
Open

docs: Document AGENT_CONTROL_RUNTIME_TOKEN_HEADER #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions core/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ icon: "gear"
|----------|---------|-------------|
| `AGENT_CONTROL_URL` | `http://localhost:8000` | Server URL |
| `AGENT_CONTROL_API_KEY` | — | API key for authentication |
| `AGENT_CONTROL_RUNTIME_TOKEN_HEADER` | `Authorization` | Header used to send runtime tokens. Must match the server setting. |

For server database configuration, use the `AGENT_CONTROL_DB_*` variables in the server section below.

Expand All @@ -27,6 +28,37 @@ For server database configuration, use the `AGENT_CONTROL_DB_*` variables in the
| `API_VERSION` | `v1` | API version prefix |
| `API_PREFIX` | `/api` | API path prefix |

### Runtime Token

| Variable | Default | Description |
|----------|---------|-------------|
| `AGENT_CONTROL_RUNTIME_TOKEN_HEADER` | `Authorization` | Header from which the server reads runtime tokens. Must match the SDK setting. |

By default, the SDK sends the runtime token in the `Authorization` header as `Authorization: Bearer <runtime-token>`.

If a gateway reserves `Authorization` for its own identity credential, configure the server and SDK to use a dedicated header:

```bash
export AGENT_CONTROL_RUNTIME_TOKEN_HEADER="X-Agent-Control-Runtime-Token"
```

With this setting, Agent Control SDK 8.5.0 or later sends the runtime token in `X-Agent-Control-Runtime-Token` as a raw token without a `Bearer` prefix. `Authorization` remains available for gateway authentication.

You can alternatively set the header when initializing the SDK:

```python
agent_control.init(
agent_name="my-agent",
runtime_token_header="X-Agent-Control-Runtime-Token",
)
```

If `runtime_token_header` is not provided, the SDK uses `AGENT_CONTROL_RUNTIME_TOKEN_HEADER`. If neither is configured, it defaults to `Authorization`.

<Note>
Upgrading to version 8.5.0 or later does not change the default header. A dedicated header is used only after you configure the environment variable or the SDK option.
</Note>

### CORS

| Variable | Default | Description |
Expand Down
Loading