Interface Interaction

The Interaction resource.

interface Interaction {
    agent?:
        | string & {}
        | "deep-research-pro-preview-12-2025"
        | "deep-research-preview-04-2026"
        | "deep-research-max-preview-04-2026";
    agent_config?: | GeminiNextGenAPIClient.Interactions.DeepResearchAgentConfig
    | GeminiNextGenAPIClient.Interactions.DynamicAgentConfig;
    created: string;
    environment?: string
    | GeminiNextGenAPIClient.Interactions.Environment;
    environment_id?: string;
    id: string;
    input?:
        | string
        | GeminiNextGenAPIClient.Interactions.Step[]
        | GeminiNextGenAPIClient.Interactions.TextContent
        | GeminiNextGenAPIClient.Interactions.ImageContent
        | GeminiNextGenAPIClient.Interactions.AudioContent
        | GeminiNextGenAPIClient.Interactions.DocumentContent
        | GeminiNextGenAPIClient.Interactions.VideoContent
        | GeminiNextGenAPIClient.Interactions.Content[];
    model?: GeminiNextGenAPIClient.Interactions.Model;
    output_audio?: GeminiNextGenAPIClient.Interactions.AudioContent;
    output_image?: GeminiNextGenAPIClient.Interactions.ImageContent;
    output_text?: string;
    output_video?: GeminiNextGenAPIClient.Interactions.VideoContent;
    previous_interaction_id?: string;
    response_format?: unknown;
    response_mime_type?: string;
    response_modalities?: ("audio" | "video" | "image" | "text" | "document")[];
    role?: string;
    service_tier?: "flex" | "priority" | "standard";
    status:
        | "failed"
        | "completed"
        | "cancelled"
        | "in_progress"
        | "requires_action"
        | "incomplete"
        | "budget_exceeded";
    steps: GeminiNextGenAPIClient.Interactions.Step[];
    system_instruction?: string;
    tools?: GeminiNextGenAPIClient.Interactions.Tool[];
    updated: string;
    usage?: GeminiNextGenAPIClient.Interactions.Usage;
    webhook_config?: GeminiNextGenAPIClient.Interactions.WebhookConfig;
}

Properties

agent? agent_config? created environment? environment_id? id input? model? output_audio? output_image? output_text? output_video? previous_interaction_id? response_format? response_mime_type? response_modalities? role? service_tier? status steps system_instruction? tools? updated usage? webhook_config?

Properties

Optionalagent

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

The name of the Agent used for generating the interaction.

Optionalagent_config

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

Configuration parameters for the agent interaction.

created

created: string

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

Optionalenvironment

environment?: string | GeminiNextGenAPIClient.Interactions.Environment

The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.

Optionalenvironment_id

environment_id?: string

Output only. The environment ID for the interaction. Only populated if environment config is set in the request.

id

id: string

Required. Output only. A unique identifier for the interaction completion.

Optionalinput

input?:
    | string
    | GeminiNextGenAPIClient.Interactions.Step[]
    | GeminiNextGenAPIClient.Interactions.TextContent
    | GeminiNextGenAPIClient.Interactions.ImageContent
    | GeminiNextGenAPIClient.Interactions.AudioContent
    | GeminiNextGenAPIClient.Interactions.DocumentContent
    | GeminiNextGenAPIClient.Interactions.VideoContent
    | GeminiNextGenAPIClient.Interactions.Content[]

The input for the interaction.

Optionalmodel

model?: GeminiNextGenAPIClient.Interactions.Model

The name of the Model used for generating the interaction.

Optionaloutput_audio

output_audio?: GeminiNextGenAPIClient.Interactions.AudioContent

The last audio generated by the model in response to the current request.

Note: this is added by the SDK.

Optionaloutput_image

output_image?: GeminiNextGenAPIClient.Interactions.ImageContent

The last image generated by the model in response to the current request.

Note: this is added by the SDK.

Optionaloutput_text

output_text?: string

Concatenated text from the last model output in response to the current request.

Note: this is added by the SDK.

Optionaloutput_video

output_video?: GeminiNextGenAPIClient.Interactions.VideoContent

The last video generated by the model in response to the current request.

Note: this is added by the SDK.

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

Deprecated

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

Optionalresponse_modalities

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

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

Optionalrole

role?: string

Deprecated

Output only. The role of the interaction.

Optionalservice_tier

service_tier?: "flex" | "priority" | "standard"

The service tier for the interaction.

status

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

Required. Output only. The status of the interaction.

steps

steps: GeminiNextGenAPIClient.Interactions.Step[]

Required. Output only. The steps that make up 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

Required. 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.

Optionalwebhook_config

webhook_config?: GeminiNextGenAPIClient.Interactions.WebhookConfig

Optional. Webhook configuration for receiving notifications when the interaction completes.

Settings

On This Page

Properties