Tela SDK for JavaScript
    Preparing search index...

    Type Alias WakeAgentParams

    WakeAgentParams:
        | {
            agentId: string;
            environmentVariables?: Record<string, string>;
            ref?: WakeAgentRequest["ref"];
            sessionId?: never;
            webhooks?: WakeAgentRequest["webhooks"];
        }
        | {
            agentId: string;
            environmentVariables?: never;
            ref?: never;
            sessionId: NonNullable<WakeAgentRequest["sessionId"]>;
            webhooks?: never;
        }

    Parameters for warming an agent session. The Tela agentId is resolved to the organization and repository required by the Agent API.

    Type Declaration

    • {
          agentId: string;
          environmentVariables?: Record<string, string>;
          ref?: WakeAgentRequest["ref"];
          sessionId?: never;
          webhooks?: WakeAgentRequest["webhooks"];
      }
      • agentId: string

        The Tela agent id to warm.

      • OptionalenvironmentVariables?: Record<string, string>

        Runtime environment variables to inject before the sandbox is primed.

      • Optionalref?: WakeAgentRequest["ref"]

        Branch, tag, or commit to prepare.

      • OptionalsessionId?: never
      • Optionalwebhooks?: WakeAgentRequest["webhooks"]

        Webhooks to bake into the warmed session; the claiming run must match them exactly.

    • {
          agentId: string;
          environmentVariables?: never;
          ref?: never;
          sessionId: NonNullable<WakeAgentRequest["sessionId"]>;
          webhooks?: never;
      }
      • agentId: string

        The Tela agent id that owns the paused session.

      • OptionalenvironmentVariables?: never

        A re-woken session always reuses its stored runtime environment.

      • Optionalref?: never

        A re-woken session always reuses its stored ref and webhooks.

      • sessionId: NonNullable<WakeAgentRequest["sessionId"]>

        Existing paused session to re-wake before its next message.

      • Optionalwebhooks?: never

        A re-woken session always reuses its stored ref and webhooks.