Interface Interaction

The Interaction resource.

interface Interaction {
    agent?: string & {} | "deep-research-pro-preview-12-2025";
    agent_config?:
        | GeminiNextGenAPIClient.Interactions.DynamicAgentConfig
        | GeminiNextGenAPIClient.Interactions.DeepResearchAgentConfig;
    created: string;
    id: string;
    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.FileSearchCallContent
    | GeminiNextGenAPIClient.Interactions.FileSearchResultContent
    | GeminiNextGenAPIClient.Interactions.Content[]
    | GeminiNextGenAPIClient.Interactions.Turn[];
    model?: GeminiNextGenAPIClient.Interactions.Model;
    outputs?: GeminiNextGenAPIClient.Interactions.Content[];
    previous_interaction_id?: string;
    response_format?: unknown;
    response_mime_type?: string;
    response_modalities?: ("audio" | "image" | "text")[];
    role?: string;
    status:
        | "failed"
        | "completed"
        | "cancelled"
        | "in_progress"
        | "requires_action"
        | "incomplete";
    system_instruction?: string;
    tools?: GeminiNextGenAPIClient.Interactions.Tool[];
    updated: string;
    usage?: GeminiNextGenAPIClient.Interactions.Usage;
}

Properties

agent? agent_config? created id input? model? outputs? previous_interaction_id? response_format? response_mime_type? response_modalities? role? status system_instruction? tools? updated usage?

Properties

Optionalagent

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

The name of the Agent used for generating the interaction.

Optionalagent_config

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

Configuration for the agent.

created

created: string

Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

id

id: string

Output only. A unique identifier for the interaction completion.

Optionalinput

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.FileSearchCallContent
    | GeminiNextGenAPIClient.Interactions.FileSearchResultContent
    | GeminiNextGenAPIClient.Interactions.Content[]
    | GeminiNextGenAPIClient.Interactions.Turn[]

The inputs for the interaction.

Optionalmodel

model?: GeminiNextGenAPIClient.Interactions.Model

The name of the Model used for generating the interaction.

Optionaloutputs

outputs?: GeminiNextGenAPIClient.Interactions.Content[]

Output only. Responses from the model.

Optionalprevious_interaction_id

previous_interaction_id?: string

The ID of the previous interaction, if any.

Optionalresponse_format

response_format?: unknown

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

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

Optionalresponse_modalities

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

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

Optionalrole

role?: string

Output only. The role of the interaction.

status

status:
    | "failed"
    | "completed"
    | "cancelled"
    | "in_progress"
    | "requires_action"
    | "incomplete"

Output only. The status of the interaction.

Optionalsystem_instruction

system_instruction?: string

System instruction for the interaction.

Optionaltools

tools?: GeminiNextGenAPIClient.Interactions.Tool[]

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

updated

updated: string

Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

Optionalusage

usage?: GeminiNextGenAPIClient.Interactions.Usage

Output only. Statistics on the interaction request's token usage.

Settings

On This Page

Properties