Interface Interaction

The Interaction resource.

interface Interaction {
    agent?: string & {} | "deep-research-pro-preview-12-2025";
    created?: string;
    id: string;
    model?: GeminiNextGenAPIClient.Interactions.Model;
    object?: "interaction";
    outputs?: (
        | 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
    )[];
    previous_interaction_id?: string;
    role?: string;
    status: | "failed"
    | "completed"
    | "cancelled"
    | "in_progress"
    | "requires_action";
    updated?: string;
    usage?: GeminiNextGenAPIClient.Interactions.Usage;
}

Properties

agent? created? id model? object? outputs? previous_interaction_id? role? status updated? usage?

Properties

Optionalagent

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

The name of the Agent used for generating the interaction.

Optionalcreated

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.

Optionalmodel

model?: GeminiNextGenAPIClient.Interactions.Model

The name of the Model used for generating the interaction.

Optionalobject

object?: "interaction"

Output only. The object type of the interaction. Always set to interaction.

Optionaloutputs

outputs?: (
    | 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
)[]

Output only. Responses from the model.

Optionalprevious_interaction_id

previous_interaction_id?: string

The ID of the previous interaction, if any.

Optionalrole

role?: string

Output only. The role of the interaction.

status

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

Output only. The status of the interaction.

Optionalupdated

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