Interface ChatRequestMessage

Per-operation attribution input.

Every property is optional so a request can override only one client default. When attribution is present, the SDK supplies an operation ID from the underlying project/job request when one is not provided.

interface ChatRequestMessage {
    agentFramework?: string;
    agentFrameworkVersion?: string;
    agentSurface?: AgentSurface;
    agentSurfaceVersion?: string;
    appSource?: string;
    billingMode?: BillingMode;
    chat_template_kwargs?: Record<string, unknown>;
    executionMode?: ExecutionMode;
    frequency_penalty?: number;
    jobID: string;
    max_tokens?: number;
    messages: ChatMessage[];
    min_p?: number;
    model: string;
    operationId?: string;
    operationScope?: OperationScope;
    parentOperationId?: string;
    presence_penalty?: number;
    repetition_penalty?: number;
    response_format?: ChatResponseFormat;
    rootOperationId?: string;
    safeContentFilter?: boolean;
    sogni_tool_execution?: boolean;
    sogni_tools?: SogniToolsMode;
    stop?: string | string[];
    stream?: boolean;
    taskProfile?: "general" | "coding" | "reasoning";
    temperature?: number;
    tokenType?: "sogni" | "spark";
    tool_choice?: ToolChoice;
    tools?: ToolDefinition[];
    top_k?: number;
    top_p?: number;
    type: "llm";
    workloadKind?: WorkloadKind;
}

Hierarchy (View Summary)

Properties

agentFramework? agentFrameworkVersion? agentSurface? agentSurfaceVersion? appSource? billingMode? chat_template_kwargs? executionMode? frequency_penalty? jobID max_tokens? messages min_p? model operationId? operationScope? parentOperationId? presence_penalty? repetition_penalty? response_format? rootOperationId? safeContentFilter? sogni_tool_execution? sogni_tools? stop? stream? taskProfile? temperature? tokenType? tool_choice? tools? top_k? top_p? type workloadKind?

Properties

OptionalagentFramework

agentFramework?: string

Canonical agent host, for example codex, claude-code, or sogni-chat.

OptionalagentFrameworkVersion

agentFrameworkVersion?: string

Version of the agent host when known.

OptionalagentSurface

agentSurface?: AgentSurface

How the agent host integrated with Sogni.

OptionalagentSurfaceVersion

agentSurfaceVersion?: string

Version of the integration surface when known.

OptionalappSource

appSource?: string

OptionalbillingMode

billingMode?: BillingMode

Billing mode read by the socket server (data.billingMode) — see ChatCompletionParams.billingMode.

Optionalchat_template_kwargs

chat_template_kwargs?: Record<string, unknown>

Per-request chat template arguments (e.g. { enable_thinking: false } for llama.cpp).

OptionalexecutionMode

executionMode?: ExecutionMode

Product execution detail, such as browser or durable execution.

Optionalfrequency_penalty

frequency_penalty?: number

jobID

jobID: string

Optionalmax_tokens

max_tokens?: number

messages

messages: ChatMessage[]

Optionalmin_p

min_p?: number

model

model: string

OptionaloperationId

operationId?: string

OptionaloperationScope

operationScope?: OperationScope

OptionalparentOperationId

parentOperationId?: string

Optionalpresence_penalty

presence_penalty?: number

Optionalrepetition_penalty

repetition_penalty?: number

Optionalresponse_format

response_format?: ChatResponseFormat

Per-request structured-output constraint (OpenAI-compatible).

OptionalrootOperationId

rootOperationId?: string

OptionalsafeContentFilter

safeContentFilter?: boolean

Safe-content filter state forwarded to the socket server.

Optionalsogni_tool_execution

sogni_tool_execution?: boolean

Optionalsogni_tools

sogni_tools?: SogniToolsMode

Optionalstop

stop?: string | string[]

Optionalstream

stream?: boolean

OptionaltaskProfile

taskProfile?: "general" | "coding" | "reasoning"

Optionaltemperature

temperature?: number

OptionaltokenType

tokenType?: "sogni" | "spark"

Optionaltool_choice

tool_choice?: ToolChoice

Optionaltools

tools?: ToolDefinition[]

Optionaltop_k

top_k?: number

Optionaltop_p

top_p?: number

type

type: "llm"

OptionalworkloadKind

workloadKind?: WorkloadKind

Settings

Member Visibility

On This Page

Properties