Skip to content

fix(sdk): finish agentToken doc cleanup in types.ts #822

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

Merged
khaliqgant merged 1 commit into from
May 8, 2026
Merged

fix(sdk): finish agentToken doc cleanup in types.ts #822

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
27 changes: 21 additions & 6 deletions packages/sdk/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,13 @@ export interface SpawnPtyInput {
restartPolicy?: RestartPolicy;
continueFrom?: string;
skipRelayPrompt?: boolean;
/** JWT token for relayauth/relayfile permissions. When set, the broker
* injects RELAY_AGENT_TOKEN into the agent's environment. */
/** Optional pre-minted relaycast agent token (`at_live_<hex>`, from
* `registerAgent(workspaceKey, name)` in `@agent-relay/sdk/http`). The
* broker plumbs this as `RELAY_AGENT_TOKEN`, which the relaycast MCP
* authenticates with. When omitted, the relaycast MCP auto-mints a token
* using `RELAY_API_KEY` + the spawn name; that is the recommended path.
* Note: this is a relaycast credential, NOT a relayfile/relayauth token —
* override `env.RELAYFILE_TOKEN` on the constructor for relayfile auth. */
agentToken?: string;
}

Expand All @@ -31,8 +36,13 @@ export interface SpawnHeadlessInput {
channels?: string[];
task?: string;
skipRelayPrompt?: boolean;
/** JWT token for relayauth/relayfile permissions. When set, the broker
* injects RELAY_AGENT_TOKEN into the agent's environment. */
/** Optional pre-minted relaycast agent token (`at_live_<hex>`, from
* `registerAgent(workspaceKey, name)` in `@agent-relay/sdk/http`). The
* broker plumbs this as `RELAY_AGENT_TOKEN`, which the relaycast MCP
* authenticates with. When omitted, the relaycast MCP auto-mints a token
* using `RELAY_API_KEY` + the spawn name; that is the recommended path.
* Note: this is a relaycast credential, NOT a relayfile/relayauth token —
* override `env.RELAYFILE_TOKEN` on the constructor for relayfile auth. */
agentToken?: string;
}

Expand All @@ -54,8 +64,13 @@ export interface SpawnProviderInput {
restartPolicy?: RestartPolicy;
continueFrom?: string;
skipRelayPrompt?: boolean;
/** JWT token for relayauth/relayfile permissions. When set, the broker
* injects RELAY_AGENT_TOKEN into the agent's environment. */
/** Optional pre-minted relaycast agent token (`at_live_<hex>`, from
* `registerAgent(workspaceKey, name)` in `@agent-relay/sdk/http`). The
* broker plumbs this as `RELAY_AGENT_TOKEN`, which the relaycast MCP
* authenticates with. When omitted, the relaycast MCP auto-mints a token
* using `RELAY_API_KEY` + the spawn name; that is the recommended path.
* Note: this is a relaycast credential, NOT a relayfile/relayauth token —
* override `env.RELAYFILE_TOKEN` on the constructor for relayfile auth. */
agentToken?: string;
}

Expand Down
Loading