Interface HostedToolExecutionParams

interface HostedToolExecutionParams {
    app_source?: string;
    appSource?: string;
    arguments: Record<string, unknown>;
    attribution?: WorkloadAttributionInput;
    safe_content_filter?: boolean;
    safeContentFilter?: boolean;
    token_type?: "auto" | "sogni" | "spark";
    tokenType?: "auto" | "sogni" | "spark";
    tool: string;
}

Properties

app_source? appSource? arguments attribution? safe_content_filter? safeContentFilter? token_type? tokenType? tool

Properties

Optionalapp_source

app_source?: string

Optional source label for this hosted REST request. Defaults to the client appSource when configured.

OptionalappSource

appSource?: string

camelCase alias for HostedToolExecutionParams.app_source.

arguments

arguments: Record<string, unknown>

Exact JSON arguments for the selected tool.

Optionalattribution

attribution?: WorkloadAttributionInput

Optional workload attribution overriding this client's defaults.

Optionalsafe_content_filter

safe_content_filter?: boolean

Public snake_case safe-content filter state.

OptionalsafeContentFilter

safeContentFilter?: boolean

camelCase alias for HostedToolExecutionParams.safe_content_filter.

Optionaltoken_type

token_type?: "auto" | "sogni" | "spark"

Token type to use for hosted REST billing.

OptionaltokenType

tokenType?: "auto" | "sogni" | "spark"

camelCase alias for HostedToolExecutionParams.token_type.

tool

tool: string

Synchronous hosted composition/planning tool to execute directly.

Settings

Member Visibility

On This Page

Properties