Interface ToolExecutionOptions

Options for chat.tools.execute() and chat.tools.executeAll().

interface ToolExecutionOptions {
    network?: "fast" | "relaxed";
    numberOfMedia?: number;
    onProgress?: (progress: ToolExecutionProgress) => void;
    timeout?: number;
    tokenType?: "sogni" | "spark";
}

Properties

network? numberOfMedia? onProgress? timeout? tokenType?

Properties

Optionalnetwork

network?: "fast" | "relaxed"

Network to use for media generation.

OptionalnumberOfMedia

numberOfMedia?: number

Number of media items to generate per tool call. Default: 1.

OptionalonProgress

onProgress?: (progress: ToolExecutionProgress) => void

Progress callback fired during media generation.

Optionaltimeout

timeout?: number

Timeout in milliseconds for media generation. If the project does not complete within this time, the tool call will fail with a timeout error and the project will be canceled.

Default: 600000 (10 minutes).

OptionaltokenType

tokenType?: "sogni" | "spark"

Token type to use for billing the generated media.

Settings

Member Visibility

On This Page

Properties