Tela SDK for JavaScript
    Preparing search index...

    Interface RunAgentParams

    Parameters for Agents.run — starting or continuing an agent session via the Tela gateway (POST /agent/:id/run).

    Start a new session with just agentId (+ message); continue an existing one by also passing its sessionId.

    interface RunAgentParams {
        agentId: string;
        environmentVariables?: Record<string, string>;
        inputs?: AgentRunInputs;
        message: string;
        sessionId?: string;
        webhooks?: {}[];
    }
    Index

    Properties

    agentId environmentVariables? inputs? message sessionId? webhooks?

    Properties

    agentId: string

    The Tela agent id (path param). Always required — /agent/:id/run.

    environmentVariables?: Record<string, string>

    Key/value environment variables for the run.

    inputs?: AgentRunInputs

    Per-variable inputs, flattened into the wire inputSchema array.

    message: string

    The turn message (required by the API for both new and continued sessions).

    sessionId?: string

    Continue an existing session by id; omit to start a new one.

    webhooks?: {}[]

    Optional session webhook registrations. On continuation, passing this replaces the existing set; omitting it keeps the current registration.

    Settings

    Member Visibility

    On This Page

    Properties