Interface StartChatRunParams

interface StartChatRunParams {
    appSource?: string;
    clientMessageId?: string;
    confirmCost?: boolean;
    idempotencyKey?: string;
    maxEstimatedCapacityUnits?: number;
    mediaContext?: {
        audio: string[];
        images: string[];
        uploadedAudio?: string[];
        uploadedImages?: string[];
        uploadedVideos?: string[];
        videos: string[];
    };
    mediaReferences?: unknown[];
    messages: unknown[];
    model?: string;
    sampling?: Record<string, unknown>;
    sessionId?: string;
    tokenType?: "sogni" | "spark";
    toolChoice?: unknown;
    tools?: unknown[];
}

Properties

appSource? clientMessageId? confirmCost? idempotencyKey? maxEstimatedCapacityUnits? mediaContext? mediaReferences? messages model? sampling? sessionId? tokenType? toolChoice? tools?

Properties

OptionalappSource

appSource?: string

App source label for attribution.

OptionalclientMessageId

clientMessageId?: string

Stable client message id for pairing with the assistant response.

OptionalconfirmCost

confirmCost?: boolean

Set true to confirm higher-cost work.

OptionalidempotencyKey

idempotencyKey?: string

Idempotency key (also accepted via Idempotency-Key header).

OptionalmaxEstimatedCapacityUnits

maxEstimatedCapacityUnits?: number

Cost ceiling for this run (capacity units).

OptionalmediaContext

mediaContext?: {
    audio: string[];
    images: string[];
    uploadedAudio?: string[];
    uploadedImages?: string[];
    uploadedVideos?: string[];
    videos: string[];
}

Full chat media context snapshot for generated + uploaded source indexing. Durable runs require uploaded HTTP(S) URLs, not inline data URIs.

OptionalmediaReferences

mediaReferences?: unknown[]

Inbound media references attached to the run. Durable runs require uploaded HTTP(S) URLs, not inline data URIs.

messages

messages: unknown[]

OpenAI-style messages array. Required.

Optionalmodel

model?: string

Model id requested for the run.

Optionalsampling

sampling?: Record<string, unknown>

Sampling defaults captured with the run for reproducibility.

OptionalsessionId

sessionId?: string

Stable session id for browser-side rehydration queries.

OptionaltokenType

tokenType?: "sogni" | "spark"

Token type for billing.

OptionaltoolChoice

toolChoice?: unknown

OpenAI-style tool choice (auto, none, or specific tool).

Optionaltools

tools?: unknown[]

OpenAI-style tools array.

Settings

Member Visibility

On This Page

Properties