Tela SDK for JavaScript
    Preparing search index...

    Type Alias RunAgentParams

    RunAgentParams: RunAgentBaseParams & (
        | {
            model?: string;
            provider?: never;
            sessionId: string;
            wakeSessionId?: never;
        }
        | {
            model?: never;
            provider?: never;
            sessionId?: never;
            wakeSessionId: string;
        }
        | {
            model?: string;
            provider?: ExecuteAgentRequest["provider"];
            sessionId?: never;
            wakeSessionId?: never;
        }
    )

    Parameters for Agents.run and Agents.runDirectStream — starting, claiming a prepared wake, or continuing an agent session via the Tela gateway.

    The public contract is always addressed by agentId. Tela API owns the mapping to the organization, repository, and published ref required by Agent API.

    Type Declaration

    • { model?: string; provider?: never; sessionId: string; wakeSessionId?: never }
      • Optionalmodel?: string

        Configure the session through Agents.updateSessionModel.

      • Optionalprovider?: never

        Existing sessions retain their provider; start a cold session to change it.

      • sessionId: string

        Continue an existing session by id.

      • OptionalwakeSessionId?: never
    • { model?: never; provider?: never; sessionId?: never; wakeSessionId: string }
      • Optionalmodel?: never

        Prepared sessions must be configured through Agents.updateSessionModel.

      • Optionalprovider?: never

        Prepared sessions retain their provider.

      • OptionalsessionId?: never
      • wakeSessionId: string

        Claim the exact session returned by Agents.wake.

    • {
          model?: string;
          provider?: ExecuteAgentRequest["provider"];
          sessionId?: never;
          wakeSessionId?: never;
      }
      • Optionalmodel?: string

        Configure a prepared session through Agents.updateSessionModel.

      • Optionalprovider?: ExecuteAgentRequest["provider"]

        Explicit Claude provider for a new session; omitted uses the workspace default.

      • OptionalsessionId?: never

        Omit both session ids to start a cold session.

      • OptionalwakeSessionId?: never

    Settings

    Member Visibility