Type Alias AddPlayerInput

AddPlayerInput: PlatformAgentInformation & {
    agent: LangChainAgentRegistration;
    agentId: string;
    enableP2a?: P2aEnableFlag;
    mainNodeId?: string;
}

Register a player (agent) in the world.

Type declaration

  • agent: LangChainAgentRegistration

    Registration from langchainRegistration.

  • agentId: string

    Registered agent id (or session-local id without Redis).

  • OptionalenableP2a?: P2aEnableFlag

    When "on", registration enables OpenAI Realtime provisioning for this agent. Omitted or "off" disables realtime voice for this registration.

    Same semantics as AddAgentInput enableP2a.

  • OptionalmainNodeId?: string

    Main node id that owns the agent (required on repository-backed servers).

Deprecated

Prefer AddAgentInput and RemotePlayWorld.prototype.addAgent for SDK and automation; use nodeId there instead of agentId.

Use langchainRegistration(agent) for agent (requires a chat_tool tool; assist_* tools are indexed for the watch UI).

agentId is required: use an id from agent-play create when the server uses a repository (with account password from RemotePlayWorld), or any stable string for local dev without Redis.

Settings

Member Visibility