Interface CreateAgentInteractionParamsStreaming

interface CreateAgentInteractionParamsStreaming {
    agent: string & {} | "deep-research-pro-preview-12-2025";
    agent_config?:
        | GeminiNextGenAPIClient.Interactions.DeepResearchAgentConfig
        | GeminiNextGenAPIClient.Interactions.DynamicAgentConfig;
    api_version?: string;
    background?: boolean;
    input: | string
    | GeminiNextGenAPIClient.Interactions.TextContent
    | GeminiNextGenAPIClient.Interactions.ImageContent
    | GeminiNextGenAPIClient.Interactions.AudioContent
    | GeminiNextGenAPIClient.Interactions.DocumentContent
    | GeminiNextGenAPIClient.Interactions.VideoContent
    | GeminiNextGenAPIClient.Interactions.ThoughtContent
    | GeminiNextGenAPIClient.Interactions.FunctionCallContent
    | GeminiNextGenAPIClient.Interactions.FunctionResultContent
    | GeminiNextGenAPIClient.Interactions.CodeExecutionCallContent
    | GeminiNextGenAPIClient.Interactions.CodeExecutionResultContent
    | GeminiNextGenAPIClient.Interactions.URLContextCallContent
    | GeminiNextGenAPIClient.Interactions.URLContextResultContent
    | GeminiNextGenAPIClient.Interactions.GoogleSearchCallContent
    | GeminiNextGenAPIClient.Interactions.GoogleSearchResultContent
    | GeminiNextGenAPIClient.Interactions.MCPServerToolCallContent
    | GeminiNextGenAPIClient.Interactions.MCPServerToolResultContent
    | GeminiNextGenAPIClient.Interactions.FileSearchResultContent
    | (
        | GeminiNextGenAPIClient.Interactions.TextContent
        | GeminiNextGenAPIClient.Interactions.ImageContent
        | GeminiNextGenAPIClient.Interactions.AudioContent
        | GeminiNextGenAPIClient.Interactions.DocumentContent
        | GeminiNextGenAPIClient.Interactions.VideoContent
        | GeminiNextGenAPIClient.Interactions.ThoughtContent
        | GeminiNextGenAPIClient.Interactions.FunctionCallContent
        | GeminiNextGenAPIClient.Interactions.FunctionResultContent
        | GeminiNextGenAPIClient.Interactions.CodeExecutionCallContent
        | GeminiNextGenAPIClient.Interactions.CodeExecutionResultContent
        | GeminiNextGenAPIClient.Interactions.URLContextCallContent
        | GeminiNextGenAPIClient.Interactions.URLContextResultContent
        | GeminiNextGenAPIClient.Interactions.GoogleSearchCallContent
        | GeminiNextGenAPIClient.Interactions.GoogleSearchResultContent
        | GeminiNextGenAPIClient.Interactions.MCPServerToolCallContent
        | GeminiNextGenAPIClient.Interactions.MCPServerToolResultContent
        | GeminiNextGenAPIClient.Interactions.FileSearchResultContent
    )[]
    | GeminiNextGenAPIClient.Interactions.Turn[];
    previous_interaction_id?: string;
    response_format?: unknown;
    response_mime_type?: string;
    response_modalities?: ("audio" | "image" | "text")[];
    store?: boolean;
    stream: true;
    system_instruction?: string;
    tools?: GeminiNextGenAPIClient.Interactions.Tool[];
}

Hierarchy (View Summary)

Properties

agent agent_config? api_version? background? input previous_interaction_id? response_format? response_mime_type? response_modalities? store? stream system_instruction? tools?

Properties

agent

agent: string & {} | "deep-research-pro-preview-12-2025"

Body param: The name of the Agent used for generating the interaction.

Optionalagent_config

agent_config?:
    | GeminiNextGenAPIClient.Interactions.DeepResearchAgentConfig
    | GeminiNextGenAPIClient.Interactions.DynamicAgentConfig

Body param: Configuration for the agent.

Optionalapi_version

api_version?: string

Path param: Which version of the API to use.

Optionalbackground

background?: boolean

Body param: Whether to run the model interaction in the background.

input

input:
    | string
    | GeminiNextGenAPIClient.Interactions.TextContent
    | GeminiNextGenAPIClient.Interactions.ImageContent
    | GeminiNextGenAPIClient.Interactions.AudioContent
    | GeminiNextGenAPIClient.Interactions.DocumentContent
    | GeminiNextGenAPIClient.Interactions.VideoContent
    | GeminiNextGenAPIClient.Interactions.ThoughtContent
    | GeminiNextGenAPIClient.Interactions.FunctionCallContent
    | GeminiNextGenAPIClient.Interactions.FunctionResultContent
    | GeminiNextGenAPIClient.Interactions.CodeExecutionCallContent
    | GeminiNextGenAPIClient.Interactions.CodeExecutionResultContent
    | GeminiNextGenAPIClient.Interactions.URLContextCallContent
    | GeminiNextGenAPIClient.Interactions.URLContextResultContent
    | GeminiNextGenAPIClient.Interactions.GoogleSearchCallContent
    | GeminiNextGenAPIClient.Interactions.GoogleSearchResultContent
    | GeminiNextGenAPIClient.Interactions.MCPServerToolCallContent
    | GeminiNextGenAPIClient.Interactions.MCPServerToolResultContent
    | GeminiNextGenAPIClient.Interactions.FileSearchResultContent
    | (
        | GeminiNextGenAPIClient.Interactions.TextContent
        | GeminiNextGenAPIClient.Interactions.ImageContent
        | GeminiNextGenAPIClient.Interactions.AudioContent
        | GeminiNextGenAPIClient.Interactions.DocumentContent
        | GeminiNextGenAPIClient.Interactions.VideoContent
        | GeminiNextGenAPIClient.Interactions.ThoughtContent
        | GeminiNextGenAPIClient.Interactions.FunctionCallContent
        | GeminiNextGenAPIClient.Interactions.FunctionResultContent
        | GeminiNextGenAPIClient.Interactions.CodeExecutionCallContent
        | GeminiNextGenAPIClient.Interactions.CodeExecutionResultContent
        | GeminiNextGenAPIClient.Interactions.URLContextCallContent
        | GeminiNextGenAPIClient.Interactions.URLContextResultContent
        | GeminiNextGenAPIClient.Interactions.GoogleSearchCallContent
        | GeminiNextGenAPIClient.Interactions.GoogleSearchResultContent
        | GeminiNextGenAPIClient.Interactions.MCPServerToolCallContent
        | GeminiNextGenAPIClient.Interactions.MCPServerToolResultContent
        | GeminiNextGenAPIClient.Interactions.FileSearchResultContent
    )[]
    | GeminiNextGenAPIClient.Interactions.Turn[]

Body param: The inputs for the interaction.

Optionalprevious_interaction_id

previous_interaction_id?: string

Body param: The ID of the previous interaction, if any.

Optionalresponse_format

response_format?: unknown

Body param: Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.

Optionalresponse_mime_type

response_mime_type?: string

Body param: The mime type of the response. This is required if response_format is set.

Optionalresponse_modalities

response_modalities?: ("audio" | "image" | "text")[]

Body param: The requested modalities of the response (TEXT, IMAGE, AUDIO).

Optionalstore

store?: boolean

Body param: Input only. Whether to store the response and request for later retrieval.

stream

stream: true

Body param: Input only. Whether the interaction will be streamed.

Optionalsystem_instruction

system_instruction?: string

Body param: System instruction for the interaction.

Optionaltools

tools?: GeminiNextGenAPIClient.Interactions.Tool[]

Body param: A list of tool declarations the model may call during interaction.

Settings

On This Page

Properties