Gemini Triggers API  |  Gemini API  |  Google AI for Developers
Skip to main content
/
English
Deutsch
Español – América Latina
Français
Indonesia
Italiano
Polski
Português – Brasil
Shqip
Tiếng Việt
Türkçe
Русский
עברית
العربيّة
فارسی
हिंदी
বাংলা
ภาษาไทย
中文 – 简体
中文 – 繁體
日本語
한국어
Get API key
Cookbook
Community
Sign in
Docs
API reference
Gemini API
Docs
API reference
Get API key
Cookbook
Community
Overview
API versions
Core APIs
Interactions API
GenerateContent
Real time APIs
Live API
Live Music API
Platform APIs
Model API
Agents
Webhooks
Triggers
Batch API
Files API
Tokens
Caching
Embeddings
File Search API
File search stores
Documents
All methods
SDK references
Python
Go
TypeScript
Java
C#
The Interactions API is now generally available. We recommend using this API for access to all the latest features and models.
Home
Gemini API
API reference
Send feedback
Gemini Triggers API
Beta: This API is in Beta. Endpoints are under /v1beta/.
Triggers allow you to schedule agent executions on a cron schedule, enabling automated and recurring tasks.
View as markdown
View the OpenAPI Spec
CreateTrigger
post
https://generativelanguage.googleapis.com/v1beta/triggers
Creates a new trigger that will invoke the specified agent on the given cron schedule.
Request body
Response
Request body
The request body contains data with the following structure:
display_name
string
 (optional)
Optional. The display name of the trigger.
environment_id
string
 (optional)
Optional. The environment ID for the trigger execution.
execution_timeout_seconds
integer
 (optional)
Optional. The execution timeout for the triggered interaction.
interaction
CreateAgentInteractionParams or CreateModelInteractionParams
 (required)
Required. The interaction request template to be executed.
max_consecutive_failures
integer
 (optional)
Optional. The maximum number of consecutive failures allowed before the trigger is automatically paused (status becomes ERROR).
schedule
string
 (required)
Required. The cron schedule on which the trigger should run. Standard cron format.
time_zone
string
 (required)
Required. Time zone in which the schedule should be interpreted.
Response
If successful, the response body contains data with the following structure:
consecutive_failure_count
integer
 (optional)
Output only. The number of consecutive failures that have occurred
since the last successful execution.
create_time
string
 (optional)
Output only. The time when the trigger was created.
display_name
string
 (optional)
Optional. The display name of the trigger.
environment_id
string
 (optional)
Optional. The environment ID for the trigger execution.
execution_timeout_seconds
integer
 (optional)
Optional. The execution timeout for the triggered interaction.
id
string
 (optional)
Required. Output only. Identifier. The ID of the trigger.
interaction
Interaction
 (optional)
Required. The interaction request template to be executed.
The Interaction resource.
Fields
agent
AgentOption
 (optional)
The name of the `Agent` used for generating the interaction.
The agent to interact with.
Possible values
deep-research-pro-preview-12-2025
Gemini Deep Research Agent
deep-research-preview-04-2026
Gemini Deep Research Agent
deep-research-max-preview-04-2026
Gemini Deep Research Max Agent
antigravity-preview-05-2026
Use the Antigravity managed agent to perform multi-step tasks that require reasoning, file operations, and tool use.
agent_config
object
 (optional)
Configuration parameters for the agent interaction.
Possible Types
Polymorphic discriminator: type
DynamicAgentConfig
Configuration for dynamic agents.
type
object
 (required)
No description provided.
Always set to "dynamic".
DeepResearchAgentConfig
Configuration for the Deep Research agent.
collaborative_planning
boolean
 (optional)
Enables human-in-the-loop planning for the Deep Research agent. If set to
true, the Deep Research agent will provide a research plan in its response.
The agent will then proceed only if the user confirms the plan in the next
turn.
enable_bigquery_tool
boolean
 (optional)
Enables bigquery tool for the Deep Research agent.
thinking_summaries
ThinkingSummaries
 (optional)
Whether to include thought summaries in the response.
Possible values
auto
Auto thinking summaries.
none
No thinking summaries.
type
object
 (required)
No description provided.
Always set to "deep-research".
visualization
enum (string)
 (optional)
Whether to include visualizations in the response.
Possible
values:
off
Do not include visualizations.
auto
Automatically include visualizations.
CodeMenderAgentConfig
Configuration for the CodeMender agent.
find_request
FindRequest
 (optional)
Parameters for finding vulnerabilities.
Request parameters specific to FIND sessions, used for discovering
vulnerabilities in a codebase.
Fields
description
string
 (optional)
Additional context or custom instructions provided by the user to guide
the vulnerability analysis.
finding_id
string
 (optional)
The identifier of a specific finding to verify. This is primarily used in
VERIFY mode to focus the agent's execution-based validation on a single
vulnerability.
mode
enum (string)
 (optional)
The mode of the find session.
Possible
values:
scan
Fast scan using only the initial classifier.
verify
Performs classification followed by detailed investigation.
source_files
FileContent
 (optional)
A list of source files to provide as context for the scan.
Content of a single file in the codebase.
Fields
content
string
 (optional)
The UTF-8 encoded text content of the file.
path
string
 (optional)
The relative path of the file from the project root.
fix_request
FixRequest
 (optional)
Parameters for fixing vulnerabilities.
Request parameters specific to FIX sessions, used for generating and
validating security patches.
Fields
description
string
 (optional)
Additional context or custom instructions provided by the user to guide
the patch generation process.
finding_id
string
 (optional)
The identifier of the specific security finding to be remediated. This ID
maps to a previously discovered vulnerability.
source_files
FileContent
 (optional)
A list of source files providing context for the remediation. These files
are typically the ones containing the identified vulnerability.
Content of a single file in the codebase.
Fields
content
string
 (optional)
The UTF-8 encoded text content of the file.
path
string
 (optional)
The relative path of the file from the project root.
model
string
 (optional)
The name of the model to use for the CodeMender agent. One
CodeMender session will only use one model.
session_config
SessionConfig
 (optional)
Optional session-specific configurations to override default agent
behavior.
The configuration of CodeMender sessions.
Fields
max_rounds
integer
 (optional)
The maximum number of interaction rounds the agent is allowed to perform
before reaching a timeout.
session_id
string
 (optional)
Parameter for grouping multiple interactions that belong to
the same CodeMender session.
type
object
 (required)
No description provided.
Always set to "code-mender".
AntigravityAgentConfig
Configuration for the Antigravity agent runtime.
Provides server-side control over the agent's execution environment
and tool configuration.
max_total_tokens
string
 (optional)
Max total tokens for the agent run.
type
object
 (required)
No description provided.
Always set to "antigravity".
created
string
 (optional)
Output only. The time at which the response was created in ISO 8601 format
(YYYY-MM-DDThh:mm:ssZ).
environment
EnvironmentConfig
 (optional)
The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.
Configuration for a custom environment.
Fields
environment_id
string
 (optional)
Optional. The environment ID for the interaction. If specified, the request will
update the existing environment instead of creating a new one.
network
EnvironmentNetworkEgressAllowlist
 (optional)
Network configuration for the environment.
Outbound networking configuration for the sandbox. Accepts an object with an 'allowlist' array to restrict traffic, or the string 'disabled' to turn off all network access. Omit entirely to allow all outbound traffic with no header injection.
Possible Types
object
Outbound networking configuration for the sandbox. When specified, restricts which external domains the sandbox can reach. Omit entirely to allow all outbound traffic with no header injection.
allowlist
AllowlistEntry
 (optional)
List of allowed outbound domains. Only requests to listed domains are permitted. Use [{'domain': '*'}] to allow all domains while still injecting headers on specific ones.
A single domain allowlist rule with optional header injection.
Fields
domain
string
 (optional)
Domain to allow outbound requests to. Supports wildcards (e.g. '*.googleapis.com'). Use '*' to allow all domains.
transform
array (object) or object
 (optional)
Headers to inject on all outbound requests matching this domain. Accepts a single dict or a list of dicts. The egress proxy injects these automatically.
string
Turns all network off.
Possible values
disabled
Turns all network off.
sources
Source
 (optional)
No description provided.
A source to be mounted into the environment.
Fields
content
string
 (optional)
The inline content if `type` is `INLINE`.
encoding
string
 (optional)
Optional encoding for inline content (e.g. `base64`).
source
string
 (optional)
The source of the environment.
For GCS, this is the GCS path.
For GitHub, this is the GitHub path.
target
string
 (optional)
Where the source should appear in the environment.
type
enum (string)
 (optional)
No description provided.
Possible
values:
gcs
A GCS bucket.
inline
Inline content.
repository
A generic repository. The protocol prefix in the source URL
identifies the provider (e.g., github://, gcs://).
skill_registry
A skill resource from the Skill Registry Service.
Skill: projects/{project}/locations/{location}/skills/{skill}
SkillRevision:
projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}
Support mounting all skills under a project:
projects/{project}/locations/{location}/skills.
type
object
 (optional)
No description provided.
Always set to "remote".
environment_id
string
 (optional)
Output only. The environment ID for the interaction. Only populated if environment
config is set in the request.
id
string
 (optional)
Required. Output only. A unique identifier for the interaction completion.
Defaults to:
input
Content or array (Content) or array (Step) or array (Turn) or string
 (optional)
The input for the interaction.
labels
object
 (optional)
The labels with user-defined metadata for the request.
model
ModelOption
 (optional)
The name of the `Model` used for generating the interaction.
The model that will complete your prompt.\n\nSee [models](https://ai.google.dev/gemini-api/docs/models) for additional details.
Possible values
gemini-2.5-flash
Our first hybrid reasoning model which supports a 1M token context window and has thinking budgets.
gemini-2.5-pro
Our state-of-the-art multipurpose model, which excels at coding and complex reasoning tasks.
gemma-4-26b-a4b-it
Gemma 4 26B A4B IT
gemma-4-31b-it
Gemma 4 31B IT
gemini-flash-latest
Latest release of Gemini Flash
gemini-flash-lite-latest
Latest release of Gemini Flash-Lite
gemini-pro-latest
Latest release of Gemini Pro
gemini-2.5-flash-lite
Our smallest and most cost effective model, built for at scale usage.
gemini-2.5-flash-image
Our native image generation model, optimized for speed, flexibility, and contextual understanding. Text input and output is priced the same as 2.5 Flash.
gemini-3-flash-preview
Our most intelligent model built for speed, combining frontier intelligence with superior search and grounding.
gemini-3.1-pro-preview
Our latest SOTA reasoning model with unprecedented depth and nuance, and powerful multimodal understanding and coding capabilities.
gemini-3.1-pro-preview-customtools
Gemini 3.1 Pro Preview optimized for custom tool usage
gemini-3.1-flash-lite
Our most cost-efficient model, optimized for high-volume agentic tasks, translation, and simple data processing.
gemini-3-pro-image
Gemini 3 Pro Image
nano-banana-pro-preview
Gemini 3 Pro Image Preview
gemini-3.1-flash-image
Gemini 3.1 Flash Image.
gemini-3.5-flash
Our most intelligent model for sustained frontier performance in agentic and coding tasks.
lyria-3-clip-preview
Our low-latency, music generation model optimized for high-fidelity audio clips and precise rhythmic control.
lyria-3-pro-preview
Our advanced, full-song generative model with deep compositional understanding, optimized for precise structural control and complex transitions across diverse musical styles.
gemini-robotics-er-1.6-preview
Gemini Robotics-ER 1.6 Preview
output_audio
AudioContent
 (optional)
The last audio generated by the model in response to the current request.
Note: this is added by the SDK.
An audio content block.
Fields
channels
integer
 (optional)
The number of audio channels.
data
string
 (optional)
The audio content.
mime_type
enum (string)
 (optional)
The mime type of the audio.
Possible
values:
audio/wav
WAV audio format
audio/mp3
MP3 audio format
audio/aiff
AIFF audio format
audio/aac
AAC audio format
audio/ogg
OGG audio format
audio/flac
FLAC audio format
audio/mpeg
MPEG audio format
audio/m4a
M4A audio format
audio/l16
L16 audio format
audio/opus
OPUS audio format
audio/alaw
ALAW audio format
audio/mulaw
MULAW audio format
sample_rate
integer
 (optional)
The sample rate of the audio.
type
object
 (optional)
No description provided.
Always set to "audio".
uri
string
 (optional)
The URI of the audio.
output_image
ImageContent
 (optional)
The last image generated by the model in response to the current request.
Note: this is added by the SDK.
An image content block.
Fields
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (optional)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
output_text
string
 (optional)
Concatenated text from the last model output in response to the current request.
Note: this is added by the SDK.
output_video
VideoContent
 (optional)
The last video generated by the model in response to the current request.
Note: this is added by the SDK.
A video content block.
Fields
data
string
 (optional)
The video content.
mime_type
enum (string)
 (optional)
The mime type of the video.
Possible
values:
video/mp4
MP4 video format
video/mpeg
MPEG video format
video/mpg
MPG video format
video/mov
MOV video format
video/avi
AVI video format
video/x-flv
FLV video format
video/webm
WebM video format
video/wmv
WMV video format
video/3gpp
3GPP video format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (optional)
No description provided.
Always set to "video".
uri
string
 (optional)
The URI of the video.
previous_interaction_id
string
 (optional)
The ID of the previous interaction, if any.
response_format
ResponseFormat
 (optional)
Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
Possible Types
AudioResponseFormat
Configuration for audio output format.
bit_rate
integer
 (optional)
Bit rate in bits per second (bps). Only applicable for compressed formats
(MP3, Opus).
delivery
enum (string)
 (optional)
The delivery mode for the audio output.
Possible
values:
inline
Audio data is returned inline in the response.
uri
Audio data is returned as a URI.
mime_type
enum (string)
 (optional)
The MIME type of the audio output.
Possible
values:
audio/mp3
MP3 audio format.
audio/ogg_opus
OGG Opus audio format.
audio/l16
Raw PCM (L16) audio format.
audio/wav
WAV audio format.
audio/alaw
A-law audio format.
audio/mulaw
Mu-law audio format.
sample_rate
integer
 (optional)
Sample rate in Hz.
type
object
 (required)
No description provided.
Always set to "audio".
TextResponseFormat
Configuration for text output format.
mime_type
enum (string)
 (optional)
The MIME type of the text output.
Possible
values:
application/json
JSON output format.
text/plain
Plain text output format.
schema
object
 (optional)
The JSON schema that the output should conform to. Only applicable when
mime_type is application/json.
type
object
 (required)
No description provided.
Always set to "text".
ImageResponseFormat
Configuration for image output format.
aspect_ratio
enum (string)
 (optional)
The aspect ratio for the image output.
Possible
values:
1:1
1:1 aspect ratio.
2:3
2:3 aspect ratio.
3:2
3:2 aspect ratio.
3:4
3:4 aspect ratio.
4:3
4:3 aspect ratio.
4:5
4:5 aspect ratio.
5:4
5:4 aspect ratio.
9:16
9:16 aspect ratio.
16:9
16:9 aspect ratio.
21:9
21:9 aspect ratio.
1:8
1:8 aspect ratio.
8:1
8:1 aspect ratio.
1:4
1:4 aspect ratio.
4:1
4:1 aspect ratio.
delivery
enum (string)
 (optional)
The delivery mode for the image output.
Possible
values:
inline
Image data is returned inline in the response.
uri
Image data is returned as a URI.
image_size
enum (string)
 (optional)
The size of the image output.
Possible
values:
512
512px image size.
1K
1K image size.
2K
2K image size.
4K
4K image size.
mime_type
enum (string)
 (optional)
The MIME type of the image output.
Possible
values:
image/jpeg
JPEG image format.
type
object
 (required)
No description provided.
Always set to "image".
VideoResponseFormat
Configuration for video output format.
aspect_ratio
enum (string)
 (optional)
The aspect ratio for the video output.
Possible
values:
16:9
16:9 aspect ratio.
9:16
9:16 aspect ratio.
delivery
enum (string)
 (optional)
The delivery mode for the video output.
Possible
values:
inline
Video data is returned inline in the response.
uri
Video data is returned as a URI.
duration
string
 (optional)
The duration for the video output.
gcs_uri
string
 (optional)
The GCS URI to store the video output. Required for Vertex if delivery mode
is URI.
type
object
 (required)
No description provided.
Always set to "video".
response_modalities
ResponseModality
 (optional)
The requested modalities of the response (TEXT, IMAGE, AUDIO).
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
safety_settings
SafetySetting
 (optional)
Safety settings for the interaction.
A safety setting that affects the safety-blocking behavior.
A SafetySetting consists of a
harm category and a
threshold for that
category.
Fields
method
enum (string)
 (optional)
Optional. The method for blocking content. If not specified, the default
behavior is to use the probability score.
Possible
values:
severity
The harm block method uses both probability and severity scores.
probability
The harm block method uses the probability score.
threshold
enum (string)
 (optional)
Required. The threshold for blocking content. If the harm probability
exceeds this threshold, the content will be blocked.
Possible
values:
block_low_and_above
Block content with a low harm probability or higher.
block_medium_and_above
Block content with a medium harm probability or higher.
block_only_high
Block content with a high harm probability.
block_none
Do not block any content, regardless of its harm probability.
off
Turn off the safety filter entirely.
type
HarmCategory
 (optional)
Required. The type of harm category to be blocked.
Possible values
hate_speech
Content that promotes violence or incites hatred against individuals or
groups based on certain attributes.
dangerous_content
Content that promotes, facilitates, or enables dangerous activities.
harassment
Abusive, threatening, or content intended to bully, torment, or ridicule.
sexually_explicit
Content that contains sexually explicit material.
civic_integrity
Deprecated: Election filter is not longer supported.
The harm category is civic integrity.
image_hate
Images that contain hate speech.
image_dangerous_content
Images that contain dangerous content.
image_harassment
Images that contain harassment.
image_sexually_explicit
Images that contain sexually explicit content.
jailbreak
Prompts designed to bypass safety filters.
service_tier
ServiceTier
 (optional)
The service tier for the interaction.
Possible values
flex
Flex service tier.
standard
Standard service tier.
priority
Priority service tier.
status
enum (string)
 (optional)
Required. Output only. The status of the interaction.
Possible
values:
in_progress
The interaction is in progress.
requires_action
The interaction requires action/input from the user.
completed
The interaction is completed.
failed
The interaction failed.
cancelled
The interaction was cancelled.
incomplete
The interaction is completed, but contains incomplete results (e.g.
hitting max_tokens).
budget_exceeded
The interaction was halted because the token budget was exceeded.
steps
Step
 (optional)
Output only. The steps that make up the interaction, when included in the response.
A step in the interaction.
Possible Types
Polymorphic discriminator: type
UserInputStep
Input provided by the user.
content
Content
 (optional)
No description provided.
The content of the response.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
annotations
Annotation
 (optional)
Citation information for model-generated content.
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
title
string
 (optional)
The title of the URL.
type
object
 (required)
No description provided.
Always set to "url_citation".
url
string
 (optional)
The URL.
FileCitation
A file citation annotation.
custom_metadata
object
 (optional)
User provided metadata about the retrieved context.
document_uri
string
 (optional)
The URI of the file.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
file_name
string
 (optional)
The name of the file.
media_id
string
 (optional)
Media ID in-case of image citations, if applicable.
page_number
integer
 (optional)
Page number of the cited document, if applicable.
source
string
 (optional)
Source attributed for a portion of the text.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "file_citation".
PlaceCitation
A place citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
name
string
 (optional)
Title of the place.
place_id
string
 (optional)
The ID of the place, in `places/{place_id}` format.
review_snippets
ReviewSnippet
 (optional)
Snippets of reviews that are used to generate answers about the
features of a given place in Google Maps.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "place_citation".
url
string
 (optional)
URI reference of the place.
text
string
 (required)
Required. The text content.
type
object
 (required)
No description provided.
Always set to "text".
ImageContent
An image content block.
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
AudioContent
An audio content block.
channels
integer
 (optional)
The number of audio channels.
data
string
 (optional)
The audio content.
mime_type
enum (string)
 (optional)
The mime type of the audio.
Possible
values:
audio/wav
WAV audio format
audio/mp3
MP3 audio format
audio/aiff
AIFF audio format
audio/aac
AAC audio format
audio/ogg
OGG audio format
audio/flac
FLAC audio format
audio/mpeg
MPEG audio format
audio/m4a
M4A audio format
audio/l16
L16 audio format
audio/opus
OPUS audio format
audio/alaw
ALAW audio format
audio/mulaw
MULAW audio format
sample_rate
integer
 (optional)
The sample rate of the audio.
type
object
 (required)
No description provided.
Always set to "audio".
uri
string
 (optional)
The URI of the audio.
DocumentContent
A document content block.
data
string
 (optional)
The document content.
mime_type
enum (string)
 (optional)
The mime type of the document.
Possible
values:
application/pdf
PDF document format
text/csv
CSV document format
type
object
 (required)
No description provided.
Always set to "document".
uri
string
 (optional)
The URI of the document.
VideoContent
A video content block.
data
string
 (optional)
The video content.
mime_type
enum (string)
 (optional)
The mime type of the video.
Possible
values:
video/mp4
MP4 video format
video/mpeg
MPEG video format
video/mpg
MPG video format
video/mov
MOV video format
video/avi
AVI video format
video/x-flv
FLV video format
video/webm
WebM video format
video/wmv
WMV video format
video/3gpp
3GPP video format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "video".
uri
string
 (optional)
The URI of the video.
type
object
 (required)
No description provided.
Always set to "user_input".
ModelOutputStep
Output generated by the model.
content
Content
 (optional)
No description provided.
The content of the response.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
annotations
Annotation
 (optional)
Citation information for model-generated content.
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
title
string
 (optional)
The title of the URL.
type
object
 (required)
No description provided.
Always set to "url_citation".
url
string
 (optional)
The URL.
FileCitation
A file citation annotation.
custom_metadata
object
 (optional)
User provided metadata about the retrieved context.
document_uri
string
 (optional)
The URI of the file.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
file_name
string
 (optional)
The name of the file.
media_id
string
 (optional)
Media ID in-case of image citations, if applicable.
page_number
integer
 (optional)
Page number of the cited document, if applicable.
source
string
 (optional)
Source attributed for a portion of the text.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "file_citation".
PlaceCitation
A place citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
name
string
 (optional)
Title of the place.
place_id
string
 (optional)
The ID of the place, in `places/{place_id}` format.
review_snippets
ReviewSnippet
 (optional)
Snippets of reviews that are used to generate answers about the
features of a given place in Google Maps.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "place_citation".
url
string
 (optional)
URI reference of the place.
text
string
 (required)
Required. The text content.
type
object
 (required)
No description provided.
Always set to "text".
ImageContent
An image content block.
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
AudioContent
An audio content block.
channels
integer
 (optional)
The number of audio channels.
data
string
 (optional)
The audio content.
mime_type
enum (string)
 (optional)
The mime type of the audio.
Possible
values:
audio/wav
WAV audio format
audio/mp3
MP3 audio format
audio/aiff
AIFF audio format
audio/aac
AAC audio format
audio/ogg
OGG audio format
audio/flac
FLAC audio format
audio/mpeg
MPEG audio format
audio/m4a
M4A audio format
audio/l16
L16 audio format
audio/opus
OPUS audio format
audio/alaw
ALAW audio format
audio/mulaw
MULAW audio format
sample_rate
integer
 (optional)
The sample rate of the audio.
type
object
 (required)
No description provided.
Always set to "audio".
uri
string
 (optional)
The URI of the audio.
DocumentContent
A document content block.
data
string
 (optional)
The document content.
mime_type
enum (string)
 (optional)
The mime type of the document.
Possible
values:
application/pdf
PDF document format
text/csv
CSV document format
type
object
 (required)
No description provided.
Always set to "document".
uri
string
 (optional)
The URI of the document.
VideoContent
A video content block.
data
string
 (optional)
The video content.
mime_type
enum (string)
 (optional)
The mime type of the video.
Possible
values:
video/mp4
MP4 video format
video/mpeg
MPEG video format
video/mpg
MPG video format
video/mov
MOV video format
video/avi
AVI video format
video/x-flv
FLV video format
video/webm
WebM video format
video/wmv
WMV video format
video/3gpp
3GPP video format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "video".
uri
string
 (optional)
The URI of the video.
error
Status
 (optional)
The error result of the operation in case of failure or cancellation.
The `Status` type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It is
used by [gRPC](https://github.com/grpc). Each `Status` message contains
three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the
[API Design Guide](https://cloud.google.com/apis/design/errors).
Fields
code
integer
 (optional)
The status code, which should be an enum value of google.rpc.Code.
details
array (object)
 (optional)
A list of messages that carry the error details.  There is a common set of
message types for APIs to use.
message
string
 (optional)
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
google.rpc.Status.details field, or localized by the client.
type
object
 (required)
No description provided.
Always set to "model_output".
ThoughtStep
A thought step.
signature
string
 (optional)
A signature hash for backend validation.
summary
ThoughtSummaryContent
 (optional)
A summary of the thought.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
annotations
Annotation
 (optional)
Citation information for model-generated content.
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
title
string
 (optional)
The title of the URL.
type
object
 (required)
No description provided.
Always set to "url_citation".
url
string
 (optional)
The URL.
FileCitation
A file citation annotation.
custom_metadata
object
 (optional)
User provided metadata about the retrieved context.
document_uri
string
 (optional)
The URI of the file.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
file_name
string
 (optional)
The name of the file.
media_id
string
 (optional)
Media ID in-case of image citations, if applicable.
page_number
integer
 (optional)
Page number of the cited document, if applicable.
source
string
 (optional)
Source attributed for a portion of the text.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "file_citation".
PlaceCitation
A place citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
name
string
 (optional)
Title of the place.
place_id
string
 (optional)
The ID of the place, in `places/{place_id}` format.
review_snippets
ReviewSnippet
 (optional)
Snippets of reviews that are used to generate answers about the
features of a given place in Google Maps.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "place_citation".
url
string
 (optional)
URI reference of the place.
text
string
 (required)
Required. The text content.
type
object
 (required)
No description provided.
Always set to "text".
ImageContent
An image content block.
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
type
object
 (required)
No description provided.
Always set to "thought".
FunctionCallStep
A function tool call step.
arguments
object
 (required)
Required. The arguments to pass to the function.
id
string
 (required)
Required. A unique ID for this specific tool call.
name
string
 (required)
Required. The name of the tool to call.
type
object
 (required)
No description provided.
Always set to "function_call".
CodeExecutionCallStep
Code execution call step.
arguments
CodeExecutionCallStepArguments
 (required)
Required. The arguments to pass to the code execution.
The arguments to pass to the code execution.
Fields
code
string
 (optional)
The code to be executed.
language
enum (string)
 (optional)
Programming language of the `code`.
Possible
values:
python
Python = 3.10, with numpy and simpy available.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "code_execution_call".
UrlContextCallStep
URL context call step.
arguments
UrlContextCallArguments
 (required)
Required. The arguments to pass to the URL context.
The arguments to pass to the URL context.
Fields
urls
array (string)
 (optional)
The URLs to fetch.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "url_context_call".
McpServerToolCallStep
MCPServer tool call step.
arguments
object
 (required)
Required. The JSON object of arguments for the function.
id
string
 (required)
Required. A unique ID for this specific tool call.
name
string
 (required)
Required. The name of the tool which was called.
server_name
string
 (required)
Required. The name of the used MCP server.
type
object
 (required)
No description provided.
Always set to "mcp_server_tool_call".
GoogleSearchCallStep
Google Search call step.
arguments
GoogleSearchCallStepArguments
 (required)
Required. The arguments to pass to Google Search.
The arguments to pass to Google Search.
Fields
queries
array (string)
 (optional)
Web search queries for the following-up web search.
id
string
 (required)
Required. A unique ID for this specific tool call.
search_type
enum (string)
 (optional)
The type of search grounding enabled.
Possible
values:
web_search
Setting this field enables web search. Only text results are returned.
image_search
Setting this field enables image search. Image bytes are returned.
enterprise_web_search
Setting this field enables enterprise web search.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_search_call".
FileSearchCallStep
File Search call step.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "file_search_call".
GoogleMapsCallStep
Google Maps call step.
arguments
GoogleMapsCallStepArguments
 (optional)
The arguments to pass to the Google Maps tool.
The arguments to pass to the Google Maps tool.
Fields
queries
array (string)
 (optional)
The queries to be executed.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_maps_call".
FunctionResultStep
Result of a function tool call.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the tool call resulted in an error.
name
string
 (optional)
The name of the tool that was called.
result
array (ImageContent or TextContent) or object or string
 (required)
The result of the tool call.
type
object
 (required)
No description provided.
Always set to "function_result".
CodeExecutionResultStep
Code execution result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the code execution resulted in an error.
result
string
 (required)
Required. The output of the code execution.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "code_execution_result".
UrlContextResultStep
URL context result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the URL context resulted in an error.
result
UrlContextResult
 (required)
Required. The results of the URL context.
The result of the URL context.
Fields
status
enum (string)
 (optional)
The status of the URL retrieval.
Possible
values:
success
Url retrieval is successful.
error
Url retrieval is failed due to error.
paywall
Url retrieval is failed because the content is behind paywall.
unsafe
Url retrieval is failed because the content is unsafe.
url
string
 (optional)
The URL that was fetched.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "url_context_result".
GoogleSearchResultStep
Google Search result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the Google Search resulted in an error.
result
GoogleSearchResultItem
 (required)
Required. The results of the Google Search.
The result of the Google Search.
Fields
search_suggestions
string
 (optional)
Web content snippet that can be embedded in a web page or an app webview.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_search_result".
McpServerToolResultStep
MCPServer tool result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
name
string
 (optional)
Name of the tool which is called for this specific tool call.
result
array (ImageContent or TextContent) or object or string
 (required)
The output from the MCP server call. Can be simple text or rich content.
server_name
string
 (optional)
The name of the used MCP server.
type
object
 (required)
No description provided.
Always set to "mcp_server_tool_result".
FileSearchResultStep
File Search result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "file_search_result".
GoogleMapsResultStep
Google Maps result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
result
GoogleMapsResultItem
 (required)
No description provided.
The result of the Google Maps.
Fields
places
GoogleMapsResultPlaces
 (optional)
No description provided.
Fields
name
string
 (optional)
No description provided.
place_id
string
 (optional)
No description provided.
review_snippets
ReviewSnippet
 (optional)
No description provided.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
url
string
 (optional)
No description provided.
widget_context_token
string
 (optional)
No description provided.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_maps_result".
system_instruction
string
 (optional)
System instruction for the interaction.
tools
Tool
 (optional)
A list of tool declarations the model may call during interaction.
A tool that can be used by the model.
Possible Types
Polymorphic discriminator: type
Function
A tool that can be used by the model.
description
string
 (optional)
A description of the function.
name
string
 (optional)
The name of the function.
parameters
object
 (optional)
The JSON Schema for the function's parameters.
type
object
 (required)
No description provided.
Always set to "function".
CodeExecution
A tool that can be used by the model to execute code.
type
object
 (required)
No description provided.
Always set to "code_execution".
UrlContext
A tool that can be used by the model to fetch URL context.
type
object
 (required)
No description provided.
Always set to "url_context".
ComputerUse
A tool that can be used by the model to interact with the computer.
disabled_safety_policies
array (enum (string))
 (optional)
Optional. Disabled safety policies for computer use.
Possible
values:
financial_transactions
Safety policy for financial transactions.
sensitive_data_modification
Safety policy for sensitive data modification.
communication_tool
Safety policy for communication tools (e.g. Gmail, Chat, Meet).
account_creation
Safety policy for account creation.
data_modification
Safety policy for data modification.
user_consent_management
Safety policy for user consent management.
legal_terms_and_agreements
Safety policy for legal terms and agreements.
enable_prompt_injection_detection
boolean
 (optional)
Whether enable the prompt injection detection check on computer-use
request.
environment
enum (string)
 (optional)
The environment being operated.
Possible
values:
browser
Operates in a web browser.
mobile
Operates in a mobile environment.
desktop
Operates in a desktop environment.
excluded_predefined_functions
array (string)
 (optional)
The list of predefined functions that are excluded from the model call.
type
object
 (required)
No description provided.
Always set to "computer_use".
McpServer
A MCPServer is a server that can be called by the model to perform actions.
allowed_tools
AllowedTools
 (optional)
The allowed tools.
The configuration for allowed tools.
Fields
mode
enum (string)
 (optional)
The mode of the tool choice.
Possible
values:
auto
Auto tool choice.
any
Any tool choice.
none
No tool choice.
validated
Validated tool choice.
tools
array (string)
 (optional)
The names of the allowed tools.
headers
object
 (optional)
Optional: Fields for authentication headers, timeouts, etc., if needed.
name
string
 (optional)
The name of the MCPServer.
type
object
 (required)
No description provided.
Always set to "mcp_server".
url
string
 (optional)
The full URL for the MCPServer endpoint.
Example: "https://api.example.com/mcp"
GoogleSearch
A tool that can be used by the model to search Google.
search_types
array (enum (string))
 (optional)
The types of search grounding to enable.
Possible
values:
web_search
Setting this field enables web search. Only text results are returned.
image_search
Setting this field enables image search. Image bytes are returned.
enterprise_web_search
Setting this field enables enterprise web search.
type
object
 (required)
No description provided.
Always set to "google_search".
FileSearch
A tool that can be used by the model to search files.
file_search_store_names
array (string)
 (optional)
The file search store names to search.
metadata_filter
string
 (optional)
Metadata filter to apply to the semantic retrieval documents and chunks.
top_k
integer
 (optional)
The number of semantic retrieval chunks to retrieve.
type
object
 (required)
No description provided.
Always set to "file_search".
GoogleMaps
A tool that can be used by the model to call Google Maps.
enable_widget
boolean
 (optional)
Whether to return a widget context token in the tool call result of the
response.
latitude
number
 (optional)
The latitude of the user's location.
longitude
number
 (optional)
The longitude of the user's location.
type
object
 (required)
No description provided.
Always set to "google_maps".
Retrieval
A tool that can be used by the model to retrieve files.
exa_ai_search_config
ExaAISearchConfig
 (optional)
Used to specify configuration for ExaAISearch.
Used to specify configuration for ExaAISearch.
Fields
api_key
string
 (optional)
Required. The API key for ExaAiSearch.
custom_config
object
 (optional)
Optional. This field can be used to pass any parameter from the Exa.ai Search API.
parallel_ai_search_config
ParallelAISearchConfig
 (optional)
Used to specify configuration for ParallelAISearch.
Used to specify configuration for ParallelAISearch.
Fields
api_key
string
 (optional)
Optional. The API key for ParallelAiSearch.
custom_config
object
 (optional)
Optional. Custom configs for ParallelAiSearch.
rag_store_config
RagStoreConfig
 (optional)
Used to specify configuration for RagStore.
Use to specify configuration for RAG Store.
Fields
rag_resources
RagResource
 (optional)
Optional. The representation of the rag source.
The definition of the Rag resource.
Fields
rag_corpus
string
 (optional)
Optional. RagCorpora resource name.
rag_file_ids
array (string)
 (optional)
Optional. rag_file_id. The files should be in the same rag_corpus set in
rag_corpus field.
rag_retrieval_config
RagRetrievalConfig
 (optional)
Optional. The retrieval config for the Rag query.
Specifies the context retrieval config.
Fields
filter
Filter
 (optional)
Optional. Config for filters.
Config for filters.
Fields
metadata_filter
string
 (optional)
Optional. String for metadata filtering.
vector_distance_threshold
number
 (optional)
Optional. Only returns contexts with vector distance smaller than the
threshold.
vector_similarity_threshold
number
 (optional)
Optional. Only returns contexts with vector similarity larger than the
threshold.
hybrid_search
HybridSearch
 (optional)
Optional. Config for Hybrid Search.
Config for Hybrid Search.
Fields
alpha
number
 (optional)
Optional. Alpha value controls the weight between dense and sparse vector search
results.
ranking
Ranking
 (optional)
Optional. Config for ranking and reranking.
Config for ranking and reranking.
top_k
integer
 (optional)
Optional. The number of contexts to retrieve.
retrieval_types
array (enum (string))
 (optional)
The types of file retrieval to enable.
Possible
values:
rag_store
exa_ai_search
parallel_ai_search
type
object
 (required)
No description provided.
Always set to "retrieval".
updated
string
 (optional)
Output only. The time at which the response was last updated in ISO 8601 format
(YYYY-MM-DDThh:mm:ssZ).
usage
Usage
 (optional)
Output only. Statistics on the interaction request's token usage.
Statistics on the interaction request's token usage.
Fields
cached_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of cached token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
grounding_tool_count
GroundingToolCount
 (optional)
Grounding tool count.
The number of grounding tool counts.
Fields
count
integer
 (optional)
The number of grounding tool counts.
type
enum (string)
 (optional)
The grounding tool type associated with the count.
Possible
values:
google_search
Grounding with Google Web Search and Image Search, & Web Grounding
for Enterprise.
google_maps
Grounding with Google Maps.
retrieval
Grounding with customer's data, for example, VertexAISearch.
input_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of input token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
output_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of output token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
tool_use_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of tool-use token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
total_cached_tokens
integer
 (optional)
Number of tokens in the cached part of the prompt (the cached content).
total_input_tokens
integer
 (optional)
Number of tokens in the prompt (context).
total_output_tokens
integer
 (optional)
Total number of tokens across all the generated responses.
total_thought_tokens
integer
 (optional)
Number of tokens of thoughts for thinking models.
total_tokens
integer
 (optional)
Total token count for the interaction request (prompt + responses + other
internal tokens).
total_tool_use_tokens
integer
 (optional)
Number of tokens present in tool-use prompt(s).
webhook_config
WebhookConfig
 (optional)
Optional. Webhook configuration for receiving notifications when the
interaction completes.
Message for configuring webhook events for a request.
Fields
uris
array (string)
 (optional)
Optional. If set, these webhook URIs will be used for webhook events instead of the
registered webhooks.
user_metadata
object
 (optional)
Optional. The user metadata that will be returned on each event emission to the
webhooks.
last_pause_time
string
 (optional)
Output only. The time when the trigger was last paused.
last_resume_time
string
 (optional)
Output only. The time when the trigger was last resumed.
last_run_time
string
 (optional)
Output only. The time when the trigger was last run.
max_consecutive_failures
integer
 (optional)
Optional. The maximum number of consecutive failures allowed before
the trigger is automatically paused (status becomes ERROR).
next_run_time
string
 (optional)
Output only. The time when the trigger is scheduled to run next.
previous_interaction_id
string
 (optional)
Output only. The ID of the last interaction created by this trigger.
schedule
string
 (optional)
Required. The cron schedule on which the trigger should run.
Standard cron format.
status
enum (string)
 (optional)
Output only. The current status of the trigger.
Possible
values:
active
The trigger is active and will fire on schedule.
paused
The trigger is paused and will not fire.
error
The trigger has entered an error state due to consecutive failures.
time_zone
string
 (optional)
Required. Time zone in which the schedule should be interpreted.
update_time
string
 (optional)
Output only. The time when the trigger was last updated.
Example
Example Response
{
"consecutive_failure_count": 0,
"create_time": "string",
"display_name": "string",
"environment_id": "string",
"execution_timeout_seconds": 0,
"id": "string",
"interaction": {
"created": "2025-12-04T15:01:45Z",
"id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
"model": "gemini-3.5-flash",
"object": "interaction",
"steps": [
{
"type": "model_output",
"content": [
{
"type": "text",
"text": "Hello! I'm doing well, functioning as expected. Thank you for asking! How are you doing today?"
}
]
}
],
"status": "completed",
"updated": "2025-12-04T15:01:45Z",
"usage": {
"input_tokens_by_modality": [
{
"modality": "text",
"tokens": 7
}
],
"total_cached_tokens": 0,
"total_input_tokens": 7,
"total_output_tokens": 23,
"total_thought_tokens": 49,
"total_tokens": 79,
"total_tool_use_tokens": 0
}
},
"last_pause_time": "string",
"last_resume_time": "string",
"last_run_time": "string",
"max_consecutive_failures": 0,
"next_run_time": "string",
"previous_interaction_id": "string",
"schedule": "string",
"status": "active",
"time_zone": "string",
"update_time": "string"
}
RunTrigger
post
https://generativelanguage.googleapis.com/v1beta/triggers/{trigger_id}/executions
Runs a trigger immediately.
Response
Response
If successful, the response body contains data with the following structure:
end_time
string
 (optional)
Output only. The time when the execution finished.
environment_id
string
 (optional)
Output only. The environment ID used for the execution.
error
string
 (optional)
Output only. The error message if the execution failed.
id
string
 (optional)
Required. Output only. Identifier. The ID of the trigger execution.
interaction_id
string
 (optional)
Output only. The ID of the interaction created by this execution, if any.
scheduled_time
string
 (optional)
Output only. The time when the execution was scheduled to run.
start_time
string
 (optional)
Output only. The time when the execution started.
status
enum (string)
 (optional)
Output only. The status of the execution.
Possible
values:
in_progress
The execution is currently in progress.
completed
The execution completed successfully.
failed
The execution failed.
skipped
The execution was skipped (e.g., previous execution still running).
timed_out
The execution timed out.
trigger_id
string
 (optional)
Required. Output only. Identifier. The ID of the trigger that created this execution.
Example
Example Response
{
"end_time": "string",
"environment_id": "string",
"error": "string",
"id": "string",
"interaction_id": "string",
"scheduled_time": "string",
"start_time": "string",
"status": "in_progress",
"trigger_id": "string"
}
ListTriggers
get
https://generativelanguage.googleapis.com/v1beta/triggers
Lists triggers for a project.
Path / Query parameters
Response
Path / Query Parameters
filter
string
 (optional)
Optional. Filter expression (e.g., by state).
page_size
integer
 (optional)
Optional. The maximum number of triggers to return per page.
page_token
string
 (optional)
Optional. A page token from a previous ListTriggers call.
Response
If successful, the response body contains data with the following structure:
next_page_token
string
 (optional)
A page token, received from a previous `ListTriggers` call.
Provide this to retrieve the subsequent page.
triggers
array (Trigger)
 (optional)
The list of triggers.
Example
Example Response
{
"next_page_token": "string",
"triggers": [
{
"consecutive_failure_count": 0,
"create_time": "string",
"display_name": "string",
"environment_id": "string",
"execution_timeout_seconds": 0,
"id": "string",
"interaction": {
"created": "2025-12-04T15:01:45Z",
"id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
"model": "gemini-3.5-flash",
"object": "interaction",
"steps": [
{
"type": "model_output",
"content": [
{
"type": "text",
"text": "Hello! I'm doing well, functioning as expected. Thank you for asking! How are you doing today?"
}
]
}
],
"status": "completed",
"updated": "2025-12-04T15:01:45Z",
"usage": {
"input_tokens_by_modality": [
{
"modality": "text",
"tokens": 7
}
],
"total_cached_tokens": 0,
"total_input_tokens": 7,
"total_output_tokens": 23,
"total_thought_tokens": 49,
"total_tokens": 79,
"total_tool_use_tokens": 0
}
},
"last_pause_time": "string",
"last_resume_time": "string",
"last_run_time": "string",
"max_consecutive_failures": 0,
"next_run_time": "string",
"previous_interaction_id": "string",
"schedule": "string",
"status": "active",
"time_zone": "string",
"update_time": "string"
}
]
}
GetTrigger
get
https://generativelanguage.googleapis.com/v1beta/triggers/{id}
Gets details of a single trigger.
Response
Response
If successful, the response body contains data with the following structure:
consecutive_failure_count
integer
 (optional)
Output only. The number of consecutive failures that have occurred
since the last successful execution.
create_time
string
 (optional)
Output only. The time when the trigger was created.
display_name
string
 (optional)
Optional. The display name of the trigger.
environment_id
string
 (optional)
Optional. The environment ID for the trigger execution.
execution_timeout_seconds
integer
 (optional)
Optional. The execution timeout for the triggered interaction.
id
string
 (optional)
Required. Output only. Identifier. The ID of the trigger.
interaction
Interaction
 (optional)
Required. The interaction request template to be executed.
The Interaction resource.
Fields
agent
AgentOption
 (optional)
The name of the `Agent` used for generating the interaction.
The agent to interact with.
Possible values
deep-research-pro-preview-12-2025
Gemini Deep Research Agent
deep-research-preview-04-2026
Gemini Deep Research Agent
deep-research-max-preview-04-2026
Gemini Deep Research Max Agent
antigravity-preview-05-2026
Use the Antigravity managed agent to perform multi-step tasks that require reasoning, file operations, and tool use.
agent_config
object
 (optional)
Configuration parameters for the agent interaction.
Possible Types
Polymorphic discriminator: type
DynamicAgentConfig
Configuration for dynamic agents.
type
object
 (required)
No description provided.
Always set to "dynamic".
DeepResearchAgentConfig
Configuration for the Deep Research agent.
collaborative_planning
boolean
 (optional)
Enables human-in-the-loop planning for the Deep Research agent. If set to
true, the Deep Research agent will provide a research plan in its response.
The agent will then proceed only if the user confirms the plan in the next
turn.
enable_bigquery_tool
boolean
 (optional)
Enables bigquery tool for the Deep Research agent.
thinking_summaries
ThinkingSummaries
 (optional)
Whether to include thought summaries in the response.
Possible values
auto
Auto thinking summaries.
none
No thinking summaries.
type
object
 (required)
No description provided.
Always set to "deep-research".
visualization
enum (string)
 (optional)
Whether to include visualizations in the response.
Possible
values:
off
Do not include visualizations.
auto
Automatically include visualizations.
CodeMenderAgentConfig
Configuration for the CodeMender agent.
find_request
FindRequest
 (optional)
Parameters for finding vulnerabilities.
Request parameters specific to FIND sessions, used for discovering
vulnerabilities in a codebase.
Fields
description
string
 (optional)
Additional context or custom instructions provided by the user to guide
the vulnerability analysis.
finding_id
string
 (optional)
The identifier of a specific finding to verify. This is primarily used in
VERIFY mode to focus the agent's execution-based validation on a single
vulnerability.
mode
enum (string)
 (optional)
The mode of the find session.
Possible
values:
scan
Fast scan using only the initial classifier.
verify
Performs classification followed by detailed investigation.
source_files
FileContent
 (optional)
A list of source files to provide as context for the scan.
Content of a single file in the codebase.
Fields
content
string
 (optional)
The UTF-8 encoded text content of the file.
path
string
 (optional)
The relative path of the file from the project root.
fix_request
FixRequest
 (optional)
Parameters for fixing vulnerabilities.
Request parameters specific to FIX sessions, used for generating and
validating security patches.
Fields
description
string
 (optional)
Additional context or custom instructions provided by the user to guide
the patch generation process.
finding_id
string
 (optional)
The identifier of the specific security finding to be remediated. This ID
maps to a previously discovered vulnerability.
source_files
FileContent
 (optional)
A list of source files providing context for the remediation. These files
are typically the ones containing the identified vulnerability.
Content of a single file in the codebase.
Fields
content
string
 (optional)
The UTF-8 encoded text content of the file.
path
string
 (optional)
The relative path of the file from the project root.
model
string
 (optional)
The name of the model to use for the CodeMender agent. One
CodeMender session will only use one model.
session_config
SessionConfig
 (optional)
Optional session-specific configurations to override default agent
behavior.
The configuration of CodeMender sessions.
Fields
max_rounds
integer
 (optional)
The maximum number of interaction rounds the agent is allowed to perform
before reaching a timeout.
session_id
string
 (optional)
Parameter for grouping multiple interactions that belong to
the same CodeMender session.
type
object
 (required)
No description provided.
Always set to "code-mender".
AntigravityAgentConfig
Configuration for the Antigravity agent runtime.
Provides server-side control over the agent's execution environment
and tool configuration.
max_total_tokens
string
 (optional)
Max total tokens for the agent run.
type
object
 (required)
No description provided.
Always set to "antigravity".
created
string
 (optional)
Output only. The time at which the response was created in ISO 8601 format
(YYYY-MM-DDThh:mm:ssZ).
environment
EnvironmentConfig
 (optional)
The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.
Configuration for a custom environment.
Fields
environment_id
string
 (optional)
Optional. The environment ID for the interaction. If specified, the request will
update the existing environment instead of creating a new one.
network
EnvironmentNetworkEgressAllowlist
 (optional)
Network configuration for the environment.
Outbound networking configuration for the sandbox. Accepts an object with an 'allowlist' array to restrict traffic, or the string 'disabled' to turn off all network access. Omit entirely to allow all outbound traffic with no header injection.
Possible Types
object
Outbound networking configuration for the sandbox. When specified, restricts which external domains the sandbox can reach. Omit entirely to allow all outbound traffic with no header injection.
allowlist
AllowlistEntry
 (optional)
List of allowed outbound domains. Only requests to listed domains are permitted. Use [{'domain': '*'}] to allow all domains while still injecting headers on specific ones.
A single domain allowlist rule with optional header injection.
Fields
domain
string
 (optional)
Domain to allow outbound requests to. Supports wildcards (e.g. '*.googleapis.com'). Use '*' to allow all domains.
transform
array (object) or object
 (optional)
Headers to inject on all outbound requests matching this domain. Accepts a single dict or a list of dicts. The egress proxy injects these automatically.
string
Turns all network off.
Possible values
disabled
Turns all network off.
sources
Source
 (optional)
No description provided.
A source to be mounted into the environment.
Fields
content
string
 (optional)
The inline content if `type` is `INLINE`.
encoding
string
 (optional)
Optional encoding for inline content (e.g. `base64`).
source
string
 (optional)
The source of the environment.
For GCS, this is the GCS path.
For GitHub, this is the GitHub path.
target
string
 (optional)
Where the source should appear in the environment.
type
enum (string)
 (optional)
No description provided.
Possible
values:
gcs
A GCS bucket.
inline
Inline content.
repository
A generic repository. The protocol prefix in the source URL
identifies the provider (e.g., github://, gcs://).
skill_registry
A skill resource from the Skill Registry Service.
Skill: projects/{project}/locations/{location}/skills/{skill}
SkillRevision:
projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}
Support mounting all skills under a project:
projects/{project}/locations/{location}/skills.
type
object
 (optional)
No description provided.
Always set to "remote".
environment_id
string
 (optional)
Output only. The environment ID for the interaction. Only populated if environment
config is set in the request.
id
string
 (optional)
Required. Output only. A unique identifier for the interaction completion.
Defaults to:
input
Content or array (Content) or array (Step) or array (Turn) or string
 (optional)
The input for the interaction.
labels
object
 (optional)
The labels with user-defined metadata for the request.
model
ModelOption
 (optional)
The name of the `Model` used for generating the interaction.
The model that will complete your prompt.\n\nSee [models](https://ai.google.dev/gemini-api/docs/models) for additional details.
Possible values
gemini-2.5-flash
Our first hybrid reasoning model which supports a 1M token context window and has thinking budgets.
gemini-2.5-pro
Our state-of-the-art multipurpose model, which excels at coding and complex reasoning tasks.
gemma-4-26b-a4b-it
Gemma 4 26B A4B IT
gemma-4-31b-it
Gemma 4 31B IT
gemini-flash-latest
Latest release of Gemini Flash
gemini-flash-lite-latest
Latest release of Gemini Flash-Lite
gemini-pro-latest
Latest release of Gemini Pro
gemini-2.5-flash-lite
Our smallest and most cost effective model, built for at scale usage.
gemini-2.5-flash-image
Our native image generation model, optimized for speed, flexibility, and contextual understanding. Text input and output is priced the same as 2.5 Flash.
gemini-3-flash-preview
Our most intelligent model built for speed, combining frontier intelligence with superior search and grounding.
gemini-3.1-pro-preview
Our latest SOTA reasoning model with unprecedented depth and nuance, and powerful multimodal understanding and coding capabilities.
gemini-3.1-pro-preview-customtools
Gemini 3.1 Pro Preview optimized for custom tool usage
gemini-3.1-flash-lite
Our most cost-efficient model, optimized for high-volume agentic tasks, translation, and simple data processing.
gemini-3-pro-image
Gemini 3 Pro Image
nano-banana-pro-preview
Gemini 3 Pro Image Preview
gemini-3.1-flash-image
Gemini 3.1 Flash Image.
gemini-3.5-flash
Our most intelligent model for sustained frontier performance in agentic and coding tasks.
lyria-3-clip-preview
Our low-latency, music generation model optimized for high-fidelity audio clips and precise rhythmic control.
lyria-3-pro-preview
Our advanced, full-song generative model with deep compositional understanding, optimized for precise structural control and complex transitions across diverse musical styles.
gemini-robotics-er-1.6-preview
Gemini Robotics-ER 1.6 Preview
output_audio
AudioContent
 (optional)
The last audio generated by the model in response to the current request.
Note: this is added by the SDK.
An audio content block.
Fields
channels
integer
 (optional)
The number of audio channels.
data
string
 (optional)
The audio content.
mime_type
enum (string)
 (optional)
The mime type of the audio.
Possible
values:
audio/wav
WAV audio format
audio/mp3
MP3 audio format
audio/aiff
AIFF audio format
audio/aac
AAC audio format
audio/ogg
OGG audio format
audio/flac
FLAC audio format
audio/mpeg
MPEG audio format
audio/m4a
M4A audio format
audio/l16
L16 audio format
audio/opus
OPUS audio format
audio/alaw
ALAW audio format
audio/mulaw
MULAW audio format
sample_rate
integer
 (optional)
The sample rate of the audio.
type
object
 (optional)
No description provided.
Always set to "audio".
uri
string
 (optional)
The URI of the audio.
output_image
ImageContent
 (optional)
The last image generated by the model in response to the current request.
Note: this is added by the SDK.
An image content block.
Fields
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (optional)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
output_text
string
 (optional)
Concatenated text from the last model output in response to the current request.
Note: this is added by the SDK.
output_video
VideoContent
 (optional)
The last video generated by the model in response to the current request.
Note: this is added by the SDK.
A video content block.
Fields
data
string
 (optional)
The video content.
mime_type
enum (string)
 (optional)
The mime type of the video.
Possible
values:
video/mp4
MP4 video format
video/mpeg
MPEG video format
video/mpg
MPG video format
video/mov
MOV video format
video/avi
AVI video format
video/x-flv
FLV video format
video/webm
WebM video format
video/wmv
WMV video format
video/3gpp
3GPP video format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (optional)
No description provided.
Always set to "video".
uri
string
 (optional)
The URI of the video.
previous_interaction_id
string
 (optional)
The ID of the previous interaction, if any.
response_format
ResponseFormat
 (optional)
Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
Possible Types
AudioResponseFormat
Configuration for audio output format.
bit_rate
integer
 (optional)
Bit rate in bits per second (bps). Only applicable for compressed formats
(MP3, Opus).
delivery
enum (string)
 (optional)
The delivery mode for the audio output.
Possible
values:
inline
Audio data is returned inline in the response.
uri
Audio data is returned as a URI.
mime_type
enum (string)
 (optional)
The MIME type of the audio output.
Possible
values:
audio/mp3
MP3 audio format.
audio/ogg_opus
OGG Opus audio format.
audio/l16
Raw PCM (L16) audio format.
audio/wav
WAV audio format.
audio/alaw
A-law audio format.
audio/mulaw
Mu-law audio format.
sample_rate
integer
 (optional)
Sample rate in Hz.
type
object
 (required)
No description provided.
Always set to "audio".
TextResponseFormat
Configuration for text output format.
mime_type
enum (string)
 (optional)
The MIME type of the text output.
Possible
values:
application/json
JSON output format.
text/plain
Plain text output format.
schema
object
 (optional)
The JSON schema that the output should conform to. Only applicable when
mime_type is application/json.
type
object
 (required)
No description provided.
Always set to "text".
ImageResponseFormat
Configuration for image output format.
aspect_ratio
enum (string)
 (optional)
The aspect ratio for the image output.
Possible
values:
1:1
1:1 aspect ratio.
2:3
2:3 aspect ratio.
3:2
3:2 aspect ratio.
3:4
3:4 aspect ratio.
4:3
4:3 aspect ratio.
4:5
4:5 aspect ratio.
5:4
5:4 aspect ratio.
9:16
9:16 aspect ratio.
16:9
16:9 aspect ratio.
21:9
21:9 aspect ratio.
1:8
1:8 aspect ratio.
8:1
8:1 aspect ratio.
1:4
1:4 aspect ratio.
4:1
4:1 aspect ratio.
delivery
enum (string)
 (optional)
The delivery mode for the image output.
Possible
values:
inline
Image data is returned inline in the response.
uri
Image data is returned as a URI.
image_size
enum (string)
 (optional)
The size of the image output.
Possible
values:
512
512px image size.
1K
1K image size.
2K
2K image size.
4K
4K image size.
mime_type
enum (string)
 (optional)
The MIME type of the image output.
Possible
values:
image/jpeg
JPEG image format.
type
object
 (required)
No description provided.
Always set to "image".
VideoResponseFormat
Configuration for video output format.
aspect_ratio
enum (string)
 (optional)
The aspect ratio for the video output.
Possible
values:
16:9
16:9 aspect ratio.
9:16
9:16 aspect ratio.
delivery
enum (string)
 (optional)
The delivery mode for the video output.
Possible
values:
inline
Video data is returned inline in the response.
uri
Video data is returned as a URI.
duration
string
 (optional)
The duration for the video output.
gcs_uri
string
 (optional)
The GCS URI to store the video output. Required for Vertex if delivery mode
is URI.
type
object
 (required)
No description provided.
Always set to "video".
response_modalities
ResponseModality
 (optional)
The requested modalities of the response (TEXT, IMAGE, AUDIO).
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
safety_settings
SafetySetting
 (optional)
Safety settings for the interaction.
A safety setting that affects the safety-blocking behavior.
A SafetySetting consists of a
harm category and a
threshold for that
category.
Fields
method
enum (string)
 (optional)
Optional. The method for blocking content. If not specified, the default
behavior is to use the probability score.
Possible
values:
severity
The harm block method uses both probability and severity scores.
probability
The harm block method uses the probability score.
threshold
enum (string)
 (optional)
Required. The threshold for blocking content. If the harm probability
exceeds this threshold, the content will be blocked.
Possible
values:
block_low_and_above
Block content with a low harm probability or higher.
block_medium_and_above
Block content with a medium harm probability or higher.
block_only_high
Block content with a high harm probability.
block_none
Do not block any content, regardless of its harm probability.
off
Turn off the safety filter entirely.
type
HarmCategory
 (optional)
Required. The type of harm category to be blocked.
Possible values
hate_speech
Content that promotes violence or incites hatred against individuals or
groups based on certain attributes.
dangerous_content
Content that promotes, facilitates, or enables dangerous activities.
harassment
Abusive, threatening, or content intended to bully, torment, or ridicule.
sexually_explicit
Content that contains sexually explicit material.
civic_integrity
Deprecated: Election filter is not longer supported.
The harm category is civic integrity.
image_hate
Images that contain hate speech.
image_dangerous_content
Images that contain dangerous content.
image_harassment
Images that contain harassment.
image_sexually_explicit
Images that contain sexually explicit content.
jailbreak
Prompts designed to bypass safety filters.
service_tier
ServiceTier
 (optional)
The service tier for the interaction.
Possible values
flex
Flex service tier.
standard
Standard service tier.
priority
Priority service tier.
status
enum (string)
 (optional)
Required. Output only. The status of the interaction.
Possible
values:
in_progress
The interaction is in progress.
requires_action
The interaction requires action/input from the user.
completed
The interaction is completed.
failed
The interaction failed.
cancelled
The interaction was cancelled.
incomplete
The interaction is completed, but contains incomplete results (e.g.
hitting max_tokens).
budget_exceeded
The interaction was halted because the token budget was exceeded.
steps
Step
 (optional)
Output only. The steps that make up the interaction, when included in the response.
A step in the interaction.
Possible Types
Polymorphic discriminator: type
UserInputStep
Input provided by the user.
content
Content
 (optional)
No description provided.
The content of the response.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
annotations
Annotation
 (optional)
Citation information for model-generated content.
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
title
string
 (optional)
The title of the URL.
type
object
 (required)
No description provided.
Always set to "url_citation".
url
string
 (optional)
The URL.
FileCitation
A file citation annotation.
custom_metadata
object
 (optional)
User provided metadata about the retrieved context.
document_uri
string
 (optional)
The URI of the file.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
file_name
string
 (optional)
The name of the file.
media_id
string
 (optional)
Media ID in-case of image citations, if applicable.
page_number
integer
 (optional)
Page number of the cited document, if applicable.
source
string
 (optional)
Source attributed for a portion of the text.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "file_citation".
PlaceCitation
A place citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
name
string
 (optional)
Title of the place.
place_id
string
 (optional)
The ID of the place, in `places/{place_id}` format.
review_snippets
ReviewSnippet
 (optional)
Snippets of reviews that are used to generate answers about the
features of a given place in Google Maps.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "place_citation".
url
string
 (optional)
URI reference of the place.
text
string
 (required)
Required. The text content.
type
object
 (required)
No description provided.
Always set to "text".
ImageContent
An image content block.
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
AudioContent
An audio content block.
channels
integer
 (optional)
The number of audio channels.
data
string
 (optional)
The audio content.
mime_type
enum (string)
 (optional)
The mime type of the audio.
Possible
values:
audio/wav
WAV audio format
audio/mp3
MP3 audio format
audio/aiff
AIFF audio format
audio/aac
AAC audio format
audio/ogg
OGG audio format
audio/flac
FLAC audio format
audio/mpeg
MPEG audio format
audio/m4a
M4A audio format
audio/l16
L16 audio format
audio/opus
OPUS audio format
audio/alaw
ALAW audio format
audio/mulaw
MULAW audio format
sample_rate
integer
 (optional)
The sample rate of the audio.
type
object
 (required)
No description provided.
Always set to "audio".
uri
string
 (optional)
The URI of the audio.
DocumentContent
A document content block.
data
string
 (optional)
The document content.
mime_type
enum (string)
 (optional)
The mime type of the document.
Possible
values:
application/pdf
PDF document format
text/csv
CSV document format
type
object
 (required)
No description provided.
Always set to "document".
uri
string
 (optional)
The URI of the document.
VideoContent
A video content block.
data
string
 (optional)
The video content.
mime_type
enum (string)
 (optional)
The mime type of the video.
Possible
values:
video/mp4
MP4 video format
video/mpeg
MPEG video format
video/mpg
MPG video format
video/mov
MOV video format
video/avi
AVI video format
video/x-flv
FLV video format
video/webm
WebM video format
video/wmv
WMV video format
video/3gpp
3GPP video format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "video".
uri
string
 (optional)
The URI of the video.
type
object
 (required)
No description provided.
Always set to "user_input".
ModelOutputStep
Output generated by the model.
content
Content
 (optional)
No description provided.
The content of the response.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
annotations
Annotation
 (optional)
Citation information for model-generated content.
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
title
string
 (optional)
The title of the URL.
type
object
 (required)
No description provided.
Always set to "url_citation".
url
string
 (optional)
The URL.
FileCitation
A file citation annotation.
custom_metadata
object
 (optional)
User provided metadata about the retrieved context.
document_uri
string
 (optional)
The URI of the file.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
file_name
string
 (optional)
The name of the file.
media_id
string
 (optional)
Media ID in-case of image citations, if applicable.
page_number
integer
 (optional)
Page number of the cited document, if applicable.
source
string
 (optional)
Source attributed for a portion of the text.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "file_citation".
PlaceCitation
A place citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
name
string
 (optional)
Title of the place.
place_id
string
 (optional)
The ID of the place, in `places/{place_id}` format.
review_snippets
ReviewSnippet
 (optional)
Snippets of reviews that are used to generate answers about the
features of a given place in Google Maps.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "place_citation".
url
string
 (optional)
URI reference of the place.
text
string
 (required)
Required. The text content.
type
object
 (required)
No description provided.
Always set to "text".
ImageContent
An image content block.
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
AudioContent
An audio content block.
channels
integer
 (optional)
The number of audio channels.
data
string
 (optional)
The audio content.
mime_type
enum (string)
 (optional)
The mime type of the audio.
Possible
values:
audio/wav
WAV audio format
audio/mp3
MP3 audio format
audio/aiff
AIFF audio format
audio/aac
AAC audio format
audio/ogg
OGG audio format
audio/flac
FLAC audio format
audio/mpeg
MPEG audio format
audio/m4a
M4A audio format
audio/l16
L16 audio format
audio/opus
OPUS audio format
audio/alaw
ALAW audio format
audio/mulaw
MULAW audio format
sample_rate
integer
 (optional)
The sample rate of the audio.
type
object
 (required)
No description provided.
Always set to "audio".
uri
string
 (optional)
The URI of the audio.
DocumentContent
A document content block.
data
string
 (optional)
The document content.
mime_type
enum (string)
 (optional)
The mime type of the document.
Possible
values:
application/pdf
PDF document format
text/csv
CSV document format
type
object
 (required)
No description provided.
Always set to "document".
uri
string
 (optional)
The URI of the document.
VideoContent
A video content block.
data
string
 (optional)
The video content.
mime_type
enum (string)
 (optional)
The mime type of the video.
Possible
values:
video/mp4
MP4 video format
video/mpeg
MPEG video format
video/mpg
MPG video format
video/mov
MOV video format
video/avi
AVI video format
video/x-flv
FLV video format
video/webm
WebM video format
video/wmv
WMV video format
video/3gpp
3GPP video format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "video".
uri
string
 (optional)
The URI of the video.
error
Status
 (optional)
The error result of the operation in case of failure or cancellation.
The `Status` type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It is
used by [gRPC](https://github.com/grpc). Each `Status` message contains
three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the
[API Design Guide](https://cloud.google.com/apis/design/errors).
Fields
code
integer
 (optional)
The status code, which should be an enum value of google.rpc.Code.
details
array (object)
 (optional)
A list of messages that carry the error details.  There is a common set of
message types for APIs to use.
message
string
 (optional)
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
google.rpc.Status.details field, or localized by the client.
type
object
 (required)
No description provided.
Always set to "model_output".
ThoughtStep
A thought step.
signature
string
 (optional)
A signature hash for backend validation.
summary
ThoughtSummaryContent
 (optional)
A summary of the thought.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
annotations
Annotation
 (optional)
Citation information for model-generated content.
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
title
string
 (optional)
The title of the URL.
type
object
 (required)
No description provided.
Always set to "url_citation".
url
string
 (optional)
The URL.
FileCitation
A file citation annotation.
custom_metadata
object
 (optional)
User provided metadata about the retrieved context.
document_uri
string
 (optional)
The URI of the file.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
file_name
string
 (optional)
The name of the file.
media_id
string
 (optional)
Media ID in-case of image citations, if applicable.
page_number
integer
 (optional)
Page number of the cited document, if applicable.
source
string
 (optional)
Source attributed for a portion of the text.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "file_citation".
PlaceCitation
A place citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
name
string
 (optional)
Title of the place.
place_id
string
 (optional)
The ID of the place, in `places/{place_id}` format.
review_snippets
ReviewSnippet
 (optional)
Snippets of reviews that are used to generate answers about the
features of a given place in Google Maps.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "place_citation".
url
string
 (optional)
URI reference of the place.
text
string
 (required)
Required. The text content.
type
object
 (required)
No description provided.
Always set to "text".
ImageContent
An image content block.
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
type
object
 (required)
No description provided.
Always set to "thought".
FunctionCallStep
A function tool call step.
arguments
object
 (required)
Required. The arguments to pass to the function.
id
string
 (required)
Required. A unique ID for this specific tool call.
name
string
 (required)
Required. The name of the tool to call.
type
object
 (required)
No description provided.
Always set to "function_call".
CodeExecutionCallStep
Code execution call step.
arguments
CodeExecutionCallStepArguments
 (required)
Required. The arguments to pass to the code execution.
The arguments to pass to the code execution.
Fields
code
string
 (optional)
The code to be executed.
language
enum (string)
 (optional)
Programming language of the `code`.
Possible
values:
python
Python = 3.10, with numpy and simpy available.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "code_execution_call".
UrlContextCallStep
URL context call step.
arguments
UrlContextCallArguments
 (required)
Required. The arguments to pass to the URL context.
The arguments to pass to the URL context.
Fields
urls
array (string)
 (optional)
The URLs to fetch.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "url_context_call".
McpServerToolCallStep
MCPServer tool call step.
arguments
object
 (required)
Required. The JSON object of arguments for the function.
id
string
 (required)
Required. A unique ID for this specific tool call.
name
string
 (required)
Required. The name of the tool which was called.
server_name
string
 (required)
Required. The name of the used MCP server.
type
object
 (required)
No description provided.
Always set to "mcp_server_tool_call".
GoogleSearchCallStep
Google Search call step.
arguments
GoogleSearchCallStepArguments
 (required)
Required. The arguments to pass to Google Search.
The arguments to pass to Google Search.
Fields
queries
array (string)
 (optional)
Web search queries for the following-up web search.
id
string
 (required)
Required. A unique ID for this specific tool call.
search_type
enum (string)
 (optional)
The type of search grounding enabled.
Possible
values:
web_search
Setting this field enables web search. Only text results are returned.
image_search
Setting this field enables image search. Image bytes are returned.
enterprise_web_search
Setting this field enables enterprise web search.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_search_call".
FileSearchCallStep
File Search call step.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "file_search_call".
GoogleMapsCallStep
Google Maps call step.
arguments
GoogleMapsCallStepArguments
 (optional)
The arguments to pass to the Google Maps tool.
The arguments to pass to the Google Maps tool.
Fields
queries
array (string)
 (optional)
The queries to be executed.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_maps_call".
FunctionResultStep
Result of a function tool call.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the tool call resulted in an error.
name
string
 (optional)
The name of the tool that was called.
result
array (ImageContent or TextContent) or object or string
 (required)
The result of the tool call.
type
object
 (required)
No description provided.
Always set to "function_result".
CodeExecutionResultStep
Code execution result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the code execution resulted in an error.
result
string
 (required)
Required. The output of the code execution.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "code_execution_result".
UrlContextResultStep
URL context result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the URL context resulted in an error.
result
UrlContextResult
 (required)
Required. The results of the URL context.
The result of the URL context.
Fields
status
enum (string)
 (optional)
The status of the URL retrieval.
Possible
values:
success
Url retrieval is successful.
error
Url retrieval is failed due to error.
paywall
Url retrieval is failed because the content is behind paywall.
unsafe
Url retrieval is failed because the content is unsafe.
url
string
 (optional)
The URL that was fetched.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "url_context_result".
GoogleSearchResultStep
Google Search result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the Google Search resulted in an error.
result
GoogleSearchResultItem
 (required)
Required. The results of the Google Search.
The result of the Google Search.
Fields
search_suggestions
string
 (optional)
Web content snippet that can be embedded in a web page or an app webview.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_search_result".
McpServerToolResultStep
MCPServer tool result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
name
string
 (optional)
Name of the tool which is called for this specific tool call.
result
array (ImageContent or TextContent) or object or string
 (required)
The output from the MCP server call. Can be simple text or rich content.
server_name
string
 (optional)
The name of the used MCP server.
type
object
 (required)
No description provided.
Always set to "mcp_server_tool_result".
FileSearchResultStep
File Search result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "file_search_result".
GoogleMapsResultStep
Google Maps result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
result
GoogleMapsResultItem
 (required)
No description provided.
The result of the Google Maps.
Fields
places
GoogleMapsResultPlaces
 (optional)
No description provided.
Fields
name
string
 (optional)
No description provided.
place_id
string
 (optional)
No description provided.
review_snippets
ReviewSnippet
 (optional)
No description provided.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
url
string
 (optional)
No description provided.
widget_context_token
string
 (optional)
No description provided.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_maps_result".
system_instruction
string
 (optional)
System instruction for the interaction.
tools
Tool
 (optional)
A list of tool declarations the model may call during interaction.
A tool that can be used by the model.
Possible Types
Polymorphic discriminator: type
Function
A tool that can be used by the model.
description
string
 (optional)
A description of the function.
name
string
 (optional)
The name of the function.
parameters
object
 (optional)
The JSON Schema for the function's parameters.
type
object
 (required)
No description provided.
Always set to "function".
CodeExecution
A tool that can be used by the model to execute code.
type
object
 (required)
No description provided.
Always set to "code_execution".
UrlContext
A tool that can be used by the model to fetch URL context.
type
object
 (required)
No description provided.
Always set to "url_context".
ComputerUse
A tool that can be used by the model to interact with the computer.
disabled_safety_policies
array (enum (string))
 (optional)
Optional. Disabled safety policies for computer use.
Possible
values:
financial_transactions
Safety policy for financial transactions.
sensitive_data_modification
Safety policy for sensitive data modification.
communication_tool
Safety policy for communication tools (e.g. Gmail, Chat, Meet).
account_creation
Safety policy for account creation.
data_modification
Safety policy for data modification.
user_consent_management
Safety policy for user consent management.
legal_terms_and_agreements
Safety policy for legal terms and agreements.
enable_prompt_injection_detection
boolean
 (optional)
Whether enable the prompt injection detection check on computer-use
request.
environment
enum (string)
 (optional)
The environment being operated.
Possible
values:
browser
Operates in a web browser.
mobile
Operates in a mobile environment.
desktop
Operates in a desktop environment.
excluded_predefined_functions
array (string)
 (optional)
The list of predefined functions that are excluded from the model call.
type
object
 (required)
No description provided.
Always set to "computer_use".
McpServer
A MCPServer is a server that can be called by the model to perform actions.
allowed_tools
AllowedTools
 (optional)
The allowed tools.
The configuration for allowed tools.
Fields
mode
enum (string)
 (optional)
The mode of the tool choice.
Possible
values:
auto
Auto tool choice.
any
Any tool choice.
none
No tool choice.
validated
Validated tool choice.
tools
array (string)
 (optional)
The names of the allowed tools.
headers
object
 (optional)
Optional: Fields for authentication headers, timeouts, etc., if needed.
name
string
 (optional)
The name of the MCPServer.
type
object
 (required)
No description provided.
Always set to "mcp_server".
url
string
 (optional)
The full URL for the MCPServer endpoint.
Example: "https://api.example.com/mcp"
GoogleSearch
A tool that can be used by the model to search Google.
search_types
array (enum (string))
 (optional)
The types of search grounding to enable.
Possible
values:
web_search
Setting this field enables web search. Only text results are returned.
image_search
Setting this field enables image search. Image bytes are returned.
enterprise_web_search
Setting this field enables enterprise web search.
type
object
 (required)
No description provided.
Always set to "google_search".
FileSearch
A tool that can be used by the model to search files.
file_search_store_names
array (string)
 (optional)
The file search store names to search.
metadata_filter
string
 (optional)
Metadata filter to apply to the semantic retrieval documents and chunks.
top_k
integer
 (optional)
The number of semantic retrieval chunks to retrieve.
type
object
 (required)
No description provided.
Always set to "file_search".
GoogleMaps
A tool that can be used by the model to call Google Maps.
enable_widget
boolean
 (optional)
Whether to return a widget context token in the tool call result of the
response.
latitude
number
 (optional)
The latitude of the user's location.
longitude
number
 (optional)
The longitude of the user's location.
type
object
 (required)
No description provided.
Always set to "google_maps".
Retrieval
A tool that can be used by the model to retrieve files.
exa_ai_search_config
ExaAISearchConfig
 (optional)
Used to specify configuration for ExaAISearch.
Used to specify configuration for ExaAISearch.
Fields
api_key
string
 (optional)
Required. The API key for ExaAiSearch.
custom_config
object
 (optional)
Optional. This field can be used to pass any parameter from the Exa.ai Search API.
parallel_ai_search_config
ParallelAISearchConfig
 (optional)
Used to specify configuration for ParallelAISearch.
Used to specify configuration for ParallelAISearch.
Fields
api_key
string
 (optional)
Optional. The API key for ParallelAiSearch.
custom_config
object
 (optional)
Optional. Custom configs for ParallelAiSearch.
rag_store_config
RagStoreConfig
 (optional)
Used to specify configuration for RagStore.
Use to specify configuration for RAG Store.
Fields
rag_resources
RagResource
 (optional)
Optional. The representation of the rag source.
The definition of the Rag resource.
Fields
rag_corpus
string
 (optional)
Optional. RagCorpora resource name.
rag_file_ids
array (string)
 (optional)
Optional. rag_file_id. The files should be in the same rag_corpus set in
rag_corpus field.
rag_retrieval_config
RagRetrievalConfig
 (optional)
Optional. The retrieval config for the Rag query.
Specifies the context retrieval config.
Fields
filter
Filter
 (optional)
Optional. Config for filters.
Config for filters.
Fields
metadata_filter
string
 (optional)
Optional. String for metadata filtering.
vector_distance_threshold
number
 (optional)
Optional. Only returns contexts with vector distance smaller than the
threshold.
vector_similarity_threshold
number
 (optional)
Optional. Only returns contexts with vector similarity larger than the
threshold.
hybrid_search
HybridSearch
 (optional)
Optional. Config for Hybrid Search.
Config for Hybrid Search.
Fields
alpha
number
 (optional)
Optional. Alpha value controls the weight between dense and sparse vector search
results.
ranking
Ranking
 (optional)
Optional. Config for ranking and reranking.
Config for ranking and reranking.
top_k
integer
 (optional)
Optional. The number of contexts to retrieve.
retrieval_types
array (enum (string))
 (optional)
The types of file retrieval to enable.
Possible
values:
rag_store
exa_ai_search
parallel_ai_search
type
object
 (required)
No description provided.
Always set to "retrieval".
updated
string
 (optional)
Output only. The time at which the response was last updated in ISO 8601 format
(YYYY-MM-DDThh:mm:ssZ).
usage
Usage
 (optional)
Output only. Statistics on the interaction request's token usage.
Statistics on the interaction request's token usage.
Fields
cached_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of cached token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
grounding_tool_count
GroundingToolCount
 (optional)
Grounding tool count.
The number of grounding tool counts.
Fields
count
integer
 (optional)
The number of grounding tool counts.
type
enum (string)
 (optional)
The grounding tool type associated with the count.
Possible
values:
google_search
Grounding with Google Web Search and Image Search, & Web Grounding
for Enterprise.
google_maps
Grounding with Google Maps.
retrieval
Grounding with customer's data, for example, VertexAISearch.
input_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of input token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
output_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of output token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
tool_use_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of tool-use token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
total_cached_tokens
integer
 (optional)
Number of tokens in the cached part of the prompt (the cached content).
total_input_tokens
integer
 (optional)
Number of tokens in the prompt (context).
total_output_tokens
integer
 (optional)
Total number of tokens across all the generated responses.
total_thought_tokens
integer
 (optional)
Number of tokens of thoughts for thinking models.
total_tokens
integer
 (optional)
Total token count for the interaction request (prompt + responses + other
internal tokens).
total_tool_use_tokens
integer
 (optional)
Number of tokens present in tool-use prompt(s).
webhook_config
WebhookConfig
 (optional)
Optional. Webhook configuration for receiving notifications when the
interaction completes.
Message for configuring webhook events for a request.
Fields
uris
array (string)
 (optional)
Optional. If set, these webhook URIs will be used for webhook events instead of the
registered webhooks.
user_metadata
object
 (optional)
Optional. The user metadata that will be returned on each event emission to the
webhooks.
last_pause_time
string
 (optional)
Output only. The time when the trigger was last paused.
last_resume_time
string
 (optional)
Output only. The time when the trigger was last resumed.
last_run_time
string
 (optional)
Output only. The time when the trigger was last run.
max_consecutive_failures
integer
 (optional)
Optional. The maximum number of consecutive failures allowed before
the trigger is automatically paused (status becomes ERROR).
next_run_time
string
 (optional)
Output only. The time when the trigger is scheduled to run next.
previous_interaction_id
string
 (optional)
Output only. The ID of the last interaction created by this trigger.
schedule
string
 (optional)
Required. The cron schedule on which the trigger should run.
Standard cron format.
status
enum (string)
 (optional)
Output only. The current status of the trigger.
Possible
values:
active
The trigger is active and will fire on schedule.
paused
The trigger is paused and will not fire.
error
The trigger has entered an error state due to consecutive failures.
time_zone
string
 (optional)
Required. Time zone in which the schedule should be interpreted.
update_time
string
 (optional)
Output only. The time when the trigger was last updated.
Example
Example Response
{
"consecutive_failure_count": 0,
"create_time": "string",
"display_name": "string",
"environment_id": "string",
"execution_timeout_seconds": 0,
"id": "string",
"interaction": {
"created": "2025-12-04T15:01:45Z",
"id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
"model": "gemini-3.5-flash",
"object": "interaction",
"steps": [
{
"type": "model_output",
"content": [
{
"type": "text",
"text": "Hello! I'm doing well, functioning as expected. Thank you for asking! How are you doing today?"
}
]
}
],
"status": "completed",
"updated": "2025-12-04T15:01:45Z",
"usage": {
"input_tokens_by_modality": [
{
"modality": "text",
"tokens": 7
}
],
"total_cached_tokens": 0,
"total_input_tokens": 7,
"total_output_tokens": 23,
"total_thought_tokens": 49,
"total_tokens": 79,
"total_tool_use_tokens": 0
}
},
"last_pause_time": "string",
"last_resume_time": "string",
"last_run_time": "string",
"max_consecutive_failures": 0,
"next_run_time": "string",
"previous_interaction_id": "string",
"schedule": "string",
"status": "active",
"time_zone": "string",
"update_time": "string"
}
ListTriggerExecutions
get
https://generativelanguage.googleapis.com/v1beta/triggers/{trigger_id}/executions
Lists executions for a trigger.
Path / Query parameters
Response
Path / Query Parameters
page_size
integer
 (optional)
Optional. The maximum number of executions to return per page.
page_token
string
 (optional)
Optional. A page token from a previous ListTriggerExecutions call.
Response
If successful, the response body contains data with the following structure:
next_page_token
string
 (optional)
A page token, received from a previous `ListTriggerExecutions` call.
Provide this to retrieve the subsequent page.
trigger_executions
array (TriggerExecution)
 (optional)
The list of trigger executions.
Example
Example Response
{
"next_page_token": "string",
"trigger_executions": [
{
"end_time": "string",
"environment_id": "string",
"error": "string",
"id": "string",
"interaction_id": "string",
"scheduled_time": "string",
"start_time": "string",
"status": "in_progress",
"trigger_id": "string"
}
]
}
UpdateTrigger
patch
https://generativelanguage.googleapis.com/v1beta/triggers/{id}
Updates a trigger.
Request body
Response
Request body
The request body contains data with the following structure:
display_name
string
 (optional)
Optional. The display name of the trigger.
status
enum (string)
 (optional)
Optional. The status of the trigger.
Possible
values:
active
The trigger is active and will fire on schedule.
paused
The trigger is paused and will not fire.
error
The trigger has entered an error state due to consecutive failures.
Response
If successful, the response body contains data with the following structure:
consecutive_failure_count
integer
 (optional)
Output only. The number of consecutive failures that have occurred
since the last successful execution.
create_time
string
 (optional)
Output only. The time when the trigger was created.
display_name
string
 (optional)
Optional. The display name of the trigger.
environment_id
string
 (optional)
Optional. The environment ID for the trigger execution.
execution_timeout_seconds
integer
 (optional)
Optional. The execution timeout for the triggered interaction.
id
string
 (optional)
Required. Output only. Identifier. The ID of the trigger.
interaction
Interaction
 (optional)
Required. The interaction request template to be executed.
The Interaction resource.
Fields
agent
AgentOption
 (optional)
The name of the `Agent` used for generating the interaction.
The agent to interact with.
Possible values
deep-research-pro-preview-12-2025
Gemini Deep Research Agent
deep-research-preview-04-2026
Gemini Deep Research Agent
deep-research-max-preview-04-2026
Gemini Deep Research Max Agent
antigravity-preview-05-2026
Use the Antigravity managed agent to perform multi-step tasks that require reasoning, file operations, and tool use.
agent_config
object
 (optional)
Configuration parameters for the agent interaction.
Possible Types
Polymorphic discriminator: type
DynamicAgentConfig
Configuration for dynamic agents.
type
object
 (required)
No description provided.
Always set to "dynamic".
DeepResearchAgentConfig
Configuration for the Deep Research agent.
collaborative_planning
boolean
 (optional)
Enables human-in-the-loop planning for the Deep Research agent. If set to
true, the Deep Research agent will provide a research plan in its response.
The agent will then proceed only if the user confirms the plan in the next
turn.
enable_bigquery_tool
boolean
 (optional)
Enables bigquery tool for the Deep Research agent.
thinking_summaries
ThinkingSummaries
 (optional)
Whether to include thought summaries in the response.
Possible values
auto
Auto thinking summaries.
none
No thinking summaries.
type
object
 (required)
No description provided.
Always set to "deep-research".
visualization
enum (string)
 (optional)
Whether to include visualizations in the response.
Possible
values:
off
Do not include visualizations.
auto
Automatically include visualizations.
CodeMenderAgentConfig
Configuration for the CodeMender agent.
find_request
FindRequest
 (optional)
Parameters for finding vulnerabilities.
Request parameters specific to FIND sessions, used for discovering
vulnerabilities in a codebase.
Fields
description
string
 (optional)
Additional context or custom instructions provided by the user to guide
the vulnerability analysis.
finding_id
string
 (optional)
The identifier of a specific finding to verify. This is primarily used in
VERIFY mode to focus the agent's execution-based validation on a single
vulnerability.
mode
enum (string)
 (optional)
The mode of the find session.
Possible
values:
scan
Fast scan using only the initial classifier.
verify
Performs classification followed by detailed investigation.
source_files
FileContent
 (optional)
A list of source files to provide as context for the scan.
Content of a single file in the codebase.
Fields
content
string
 (optional)
The UTF-8 encoded text content of the file.
path
string
 (optional)
The relative path of the file from the project root.
fix_request
FixRequest
 (optional)
Parameters for fixing vulnerabilities.
Request parameters specific to FIX sessions, used for generating and
validating security patches.
Fields
description
string
 (optional)
Additional context or custom instructions provided by the user to guide
the patch generation process.
finding_id
string
 (optional)
The identifier of the specific security finding to be remediated. This ID
maps to a previously discovered vulnerability.
source_files
FileContent
 (optional)
A list of source files providing context for the remediation. These files
are typically the ones containing the identified vulnerability.
Content of a single file in the codebase.
Fields
content
string
 (optional)
The UTF-8 encoded text content of the file.
path
string
 (optional)
The relative path of the file from the project root.
model
string
 (optional)
The name of the model to use for the CodeMender agent. One
CodeMender session will only use one model.
session_config
SessionConfig
 (optional)
Optional session-specific configurations to override default agent
behavior.
The configuration of CodeMender sessions.
Fields
max_rounds
integer
 (optional)
The maximum number of interaction rounds the agent is allowed to perform
before reaching a timeout.
session_id
string
 (optional)
Parameter for grouping multiple interactions that belong to
the same CodeMender session.
type
object
 (required)
No description provided.
Always set to "code-mender".
AntigravityAgentConfig
Configuration for the Antigravity agent runtime.
Provides server-side control over the agent's execution environment
and tool configuration.
max_total_tokens
string
 (optional)
Max total tokens for the agent run.
type
object
 (required)
No description provided.
Always set to "antigravity".
created
string
 (optional)
Output only. The time at which the response was created in ISO 8601 format
(YYYY-MM-DDThh:mm:ssZ).
environment
EnvironmentConfig
 (optional)
The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.
Configuration for a custom environment.
Fields
environment_id
string
 (optional)
Optional. The environment ID for the interaction. If specified, the request will
update the existing environment instead of creating a new one.
network
EnvironmentNetworkEgressAllowlist
 (optional)
Network configuration for the environment.
Outbound networking configuration for the sandbox. Accepts an object with an 'allowlist' array to restrict traffic, or the string 'disabled' to turn off all network access. Omit entirely to allow all outbound traffic with no header injection.
Possible Types
object
Outbound networking configuration for the sandbox. When specified, restricts which external domains the sandbox can reach. Omit entirely to allow all outbound traffic with no header injection.
allowlist
AllowlistEntry
 (optional)
List of allowed outbound domains. Only requests to listed domains are permitted. Use [{'domain': '*'}] to allow all domains while still injecting headers on specific ones.
A single domain allowlist rule with optional header injection.
Fields
domain
string
 (optional)
Domain to allow outbound requests to. Supports wildcards (e.g. '*.googleapis.com'). Use '*' to allow all domains.
transform
array (object) or object
 (optional)
Headers to inject on all outbound requests matching this domain. Accepts a single dict or a list of dicts. The egress proxy injects these automatically.
string
Turns all network off.
Possible values
disabled
Turns all network off.
sources
Source
 (optional)
No description provided.
A source to be mounted into the environment.
Fields
content
string
 (optional)
The inline content if `type` is `INLINE`.
encoding
string
 (optional)
Optional encoding for inline content (e.g. `base64`).
source
string
 (optional)
The source of the environment.
For GCS, this is the GCS path.
For GitHub, this is the GitHub path.
target
string
 (optional)
Where the source should appear in the environment.
type
enum (string)
 (optional)
No description provided.
Possible
values:
gcs
A GCS bucket.
inline
Inline content.
repository
A generic repository. The protocol prefix in the source URL
identifies the provider (e.g., github://, gcs://).
skill_registry
A skill resource from the Skill Registry Service.
Skill: projects/{project}/locations/{location}/skills/{skill}
SkillRevision:
projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}
Support mounting all skills under a project:
projects/{project}/locations/{location}/skills.
type
object
 (optional)
No description provided.
Always set to "remote".
environment_id
string
 (optional)
Output only. The environment ID for the interaction. Only populated if environment
config is set in the request.
id
string
 (optional)
Required. Output only. A unique identifier for the interaction completion.
Defaults to:
input
Content or array (Content) or array (Step) or array (Turn) or string
 (optional)
The input for the interaction.
labels
object
 (optional)
The labels with user-defined metadata for the request.
model
ModelOption
 (optional)
The name of the `Model` used for generating the interaction.
The model that will complete your prompt.\n\nSee [models](https://ai.google.dev/gemini-api/docs/models) for additional details.
Possible values
gemini-2.5-flash
Our first hybrid reasoning model which supports a 1M token context window and has thinking budgets.
gemini-2.5-pro
Our state-of-the-art multipurpose model, which excels at coding and complex reasoning tasks.
gemma-4-26b-a4b-it
Gemma 4 26B A4B IT
gemma-4-31b-it
Gemma 4 31B IT
gemini-flash-latest
Latest release of Gemini Flash
gemini-flash-lite-latest
Latest release of Gemini Flash-Lite
gemini-pro-latest
Latest release of Gemini Pro
gemini-2.5-flash-lite
Our smallest and most cost effective model, built for at scale usage.
gemini-2.5-flash-image
Our native image generation model, optimized for speed, flexibility, and contextual understanding. Text input and output is priced the same as 2.5 Flash.
gemini-3-flash-preview
Our most intelligent model built for speed, combining frontier intelligence with superior search and grounding.
gemini-3.1-pro-preview
Our latest SOTA reasoning model with unprecedented depth and nuance, and powerful multimodal understanding and coding capabilities.
gemini-3.1-pro-preview-customtools
Gemini 3.1 Pro Preview optimized for custom tool usage
gemini-3.1-flash-lite
Our most cost-efficient model, optimized for high-volume agentic tasks, translation, and simple data processing.
gemini-3-pro-image
Gemini 3 Pro Image
nano-banana-pro-preview
Gemini 3 Pro Image Preview
gemini-3.1-flash-image
Gemini 3.1 Flash Image.
gemini-3.5-flash
Our most intelligent model for sustained frontier performance in agentic and coding tasks.
lyria-3-clip-preview
Our low-latency, music generation model optimized for high-fidelity audio clips and precise rhythmic control.
lyria-3-pro-preview
Our advanced, full-song generative model with deep compositional understanding, optimized for precise structural control and complex transitions across diverse musical styles.
gemini-robotics-er-1.6-preview
Gemini Robotics-ER 1.6 Preview
output_audio
AudioContent
 (optional)
The last audio generated by the model in response to the current request.
Note: this is added by the SDK.
An audio content block.
Fields
channels
integer
 (optional)
The number of audio channels.
data
string
 (optional)
The audio content.
mime_type
enum (string)
 (optional)
The mime type of the audio.
Possible
values:
audio/wav
WAV audio format
audio/mp3
MP3 audio format
audio/aiff
AIFF audio format
audio/aac
AAC audio format
audio/ogg
OGG audio format
audio/flac
FLAC audio format
audio/mpeg
MPEG audio format
audio/m4a
M4A audio format
audio/l16
L16 audio format
audio/opus
OPUS audio format
audio/alaw
ALAW audio format
audio/mulaw
MULAW audio format
sample_rate
integer
 (optional)
The sample rate of the audio.
type
object
 (optional)
No description provided.
Always set to "audio".
uri
string
 (optional)
The URI of the audio.
output_image
ImageContent
 (optional)
The last image generated by the model in response to the current request.
Note: this is added by the SDK.
An image content block.
Fields
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (optional)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
output_text
string
 (optional)
Concatenated text from the last model output in response to the current request.
Note: this is added by the SDK.
output_video
VideoContent
 (optional)
The last video generated by the model in response to the current request.
Note: this is added by the SDK.
A video content block.
Fields
data
string
 (optional)
The video content.
mime_type
enum (string)
 (optional)
The mime type of the video.
Possible
values:
video/mp4
MP4 video format
video/mpeg
MPEG video format
video/mpg
MPG video format
video/mov
MOV video format
video/avi
AVI video format
video/x-flv
FLV video format
video/webm
WebM video format
video/wmv
WMV video format
video/3gpp
3GPP video format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (optional)
No description provided.
Always set to "video".
uri
string
 (optional)
The URI of the video.
previous_interaction_id
string
 (optional)
The ID of the previous interaction, if any.
response_format
ResponseFormat
 (optional)
Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
Possible Types
AudioResponseFormat
Configuration for audio output format.
bit_rate
integer
 (optional)
Bit rate in bits per second (bps). Only applicable for compressed formats
(MP3, Opus).
delivery
enum (string)
 (optional)
The delivery mode for the audio output.
Possible
values:
inline
Audio data is returned inline in the response.
uri
Audio data is returned as a URI.
mime_type
enum (string)
 (optional)
The MIME type of the audio output.
Possible
values:
audio/mp3
MP3 audio format.
audio/ogg_opus
OGG Opus audio format.
audio/l16
Raw PCM (L16) audio format.
audio/wav
WAV audio format.
audio/alaw
A-law audio format.
audio/mulaw
Mu-law audio format.
sample_rate
integer
 (optional)
Sample rate in Hz.
type
object
 (required)
No description provided.
Always set to "audio".
TextResponseFormat
Configuration for text output format.
mime_type
enum (string)
 (optional)
The MIME type of the text output.
Possible
values:
application/json
JSON output format.
text/plain
Plain text output format.
schema
object
 (optional)
The JSON schema that the output should conform to. Only applicable when
mime_type is application/json.
type
object
 (required)
No description provided.
Always set to "text".
ImageResponseFormat
Configuration for image output format.
aspect_ratio
enum (string)
 (optional)
The aspect ratio for the image output.
Possible
values:
1:1
1:1 aspect ratio.
2:3
2:3 aspect ratio.
3:2
3:2 aspect ratio.
3:4
3:4 aspect ratio.
4:3
4:3 aspect ratio.
4:5
4:5 aspect ratio.
5:4
5:4 aspect ratio.
9:16
9:16 aspect ratio.
16:9
16:9 aspect ratio.
21:9
21:9 aspect ratio.
1:8
1:8 aspect ratio.
8:1
8:1 aspect ratio.
1:4
1:4 aspect ratio.
4:1
4:1 aspect ratio.
delivery
enum (string)
 (optional)
The delivery mode for the image output.
Possible
values:
inline
Image data is returned inline in the response.
uri
Image data is returned as a URI.
image_size
enum (string)
 (optional)
The size of the image output.
Possible
values:
512
512px image size.
1K
1K image size.
2K
2K image size.
4K
4K image size.
mime_type
enum (string)
 (optional)
The MIME type of the image output.
Possible
values:
image/jpeg
JPEG image format.
type
object
 (required)
No description provided.
Always set to "image".
VideoResponseFormat
Configuration for video output format.
aspect_ratio
enum (string)
 (optional)
The aspect ratio for the video output.
Possible
values:
16:9
16:9 aspect ratio.
9:16
9:16 aspect ratio.
delivery
enum (string)
 (optional)
The delivery mode for the video output.
Possible
values:
inline
Video data is returned inline in the response.
uri
Video data is returned as a URI.
duration
string
 (optional)
The duration for the video output.
gcs_uri
string
 (optional)
The GCS URI to store the video output. Required for Vertex if delivery mode
is URI.
type
object
 (required)
No description provided.
Always set to "video".
response_modalities
ResponseModality
 (optional)
The requested modalities of the response (TEXT, IMAGE, AUDIO).
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
safety_settings
SafetySetting
 (optional)
Safety settings for the interaction.
A safety setting that affects the safety-blocking behavior.
A SafetySetting consists of a
harm category and a
threshold for that
category.
Fields
method
enum (string)
 (optional)
Optional. The method for blocking content. If not specified, the default
behavior is to use the probability score.
Possible
values:
severity
The harm block method uses both probability and severity scores.
probability
The harm block method uses the probability score.
threshold
enum (string)
 (optional)
Required. The threshold for blocking content. If the harm probability
exceeds this threshold, the content will be blocked.
Possible
values:
block_low_and_above
Block content with a low harm probability or higher.
block_medium_and_above
Block content with a medium harm probability or higher.
block_only_high
Block content with a high harm probability.
block_none
Do not block any content, regardless of its harm probability.
off
Turn off the safety filter entirely.
type
HarmCategory
 (optional)
Required. The type of harm category to be blocked.
Possible values
hate_speech
Content that promotes violence or incites hatred against individuals or
groups based on certain attributes.
dangerous_content
Content that promotes, facilitates, or enables dangerous activities.
harassment
Abusive, threatening, or content intended to bully, torment, or ridicule.
sexually_explicit
Content that contains sexually explicit material.
civic_integrity
Deprecated: Election filter is not longer supported.
The harm category is civic integrity.
image_hate
Images that contain hate speech.
image_dangerous_content
Images that contain dangerous content.
image_harassment
Images that contain harassment.
image_sexually_explicit
Images that contain sexually explicit content.
jailbreak
Prompts designed to bypass safety filters.
service_tier
ServiceTier
 (optional)
The service tier for the interaction.
Possible values
flex
Flex service tier.
standard
Standard service tier.
priority
Priority service tier.
status
enum (string)
 (optional)
Required. Output only. The status of the interaction.
Possible
values:
in_progress
The interaction is in progress.
requires_action
The interaction requires action/input from the user.
completed
The interaction is completed.
failed
The interaction failed.
cancelled
The interaction was cancelled.
incomplete
The interaction is completed, but contains incomplete results (e.g.
hitting max_tokens).
budget_exceeded
The interaction was halted because the token budget was exceeded.
steps
Step
 (optional)
Output only. The steps that make up the interaction, when included in the response.
A step in the interaction.
Possible Types
Polymorphic discriminator: type
UserInputStep
Input provided by the user.
content
Content
 (optional)
No description provided.
The content of the response.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
annotations
Annotation
 (optional)
Citation information for model-generated content.
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
title
string
 (optional)
The title of the URL.
type
object
 (required)
No description provided.
Always set to "url_citation".
url
string
 (optional)
The URL.
FileCitation
A file citation annotation.
custom_metadata
object
 (optional)
User provided metadata about the retrieved context.
document_uri
string
 (optional)
The URI of the file.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
file_name
string
 (optional)
The name of the file.
media_id
string
 (optional)
Media ID in-case of image citations, if applicable.
page_number
integer
 (optional)
Page number of the cited document, if applicable.
source
string
 (optional)
Source attributed for a portion of the text.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "file_citation".
PlaceCitation
A place citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
name
string
 (optional)
Title of the place.
place_id
string
 (optional)
The ID of the place, in `places/{place_id}` format.
review_snippets
ReviewSnippet
 (optional)
Snippets of reviews that are used to generate answers about the
features of a given place in Google Maps.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "place_citation".
url
string
 (optional)
URI reference of the place.
text
string
 (required)
Required. The text content.
type
object
 (required)
No description provided.
Always set to "text".
ImageContent
An image content block.
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
AudioContent
An audio content block.
channels
integer
 (optional)
The number of audio channels.
data
string
 (optional)
The audio content.
mime_type
enum (string)
 (optional)
The mime type of the audio.
Possible
values:
audio/wav
WAV audio format
audio/mp3
MP3 audio format
audio/aiff
AIFF audio format
audio/aac
AAC audio format
audio/ogg
OGG audio format
audio/flac
FLAC audio format
audio/mpeg
MPEG audio format
audio/m4a
M4A audio format
audio/l16
L16 audio format
audio/opus
OPUS audio format
audio/alaw
ALAW audio format
audio/mulaw
MULAW audio format
sample_rate
integer
 (optional)
The sample rate of the audio.
type
object
 (required)
No description provided.
Always set to "audio".
uri
string
 (optional)
The URI of the audio.
DocumentContent
A document content block.
data
string
 (optional)
The document content.
mime_type
enum (string)
 (optional)
The mime type of the document.
Possible
values:
application/pdf
PDF document format
text/csv
CSV document format
type
object
 (required)
No description provided.
Always set to "document".
uri
string
 (optional)
The URI of the document.
VideoContent
A video content block.
data
string
 (optional)
The video content.
mime_type
enum (string)
 (optional)
The mime type of the video.
Possible
values:
video/mp4
MP4 video format
video/mpeg
MPEG video format
video/mpg
MPG video format
video/mov
MOV video format
video/avi
AVI video format
video/x-flv
FLV video format
video/webm
WebM video format
video/wmv
WMV video format
video/3gpp
3GPP video format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "video".
uri
string
 (optional)
The URI of the video.
type
object
 (required)
No description provided.
Always set to "user_input".
ModelOutputStep
Output generated by the model.
content
Content
 (optional)
No description provided.
The content of the response.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
annotations
Annotation
 (optional)
Citation information for model-generated content.
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
title
string
 (optional)
The title of the URL.
type
object
 (required)
No description provided.
Always set to "url_citation".
url
string
 (optional)
The URL.
FileCitation
A file citation annotation.
custom_metadata
object
 (optional)
User provided metadata about the retrieved context.
document_uri
string
 (optional)
The URI of the file.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
file_name
string
 (optional)
The name of the file.
media_id
string
 (optional)
Media ID in-case of image citations, if applicable.
page_number
integer
 (optional)
Page number of the cited document, if applicable.
source
string
 (optional)
Source attributed for a portion of the text.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "file_citation".
PlaceCitation
A place citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
name
string
 (optional)
Title of the place.
place_id
string
 (optional)
The ID of the place, in `places/{place_id}` format.
review_snippets
ReviewSnippet
 (optional)
Snippets of reviews that are used to generate answers about the
features of a given place in Google Maps.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "place_citation".
url
string
 (optional)
URI reference of the place.
text
string
 (required)
Required. The text content.
type
object
 (required)
No description provided.
Always set to "text".
ImageContent
An image content block.
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
AudioContent
An audio content block.
channels
integer
 (optional)
The number of audio channels.
data
string
 (optional)
The audio content.
mime_type
enum (string)
 (optional)
The mime type of the audio.
Possible
values:
audio/wav
WAV audio format
audio/mp3
MP3 audio format
audio/aiff
AIFF audio format
audio/aac
AAC audio format
audio/ogg
OGG audio format
audio/flac
FLAC audio format
audio/mpeg
MPEG audio format
audio/m4a
M4A audio format
audio/l16
L16 audio format
audio/opus
OPUS audio format
audio/alaw
ALAW audio format
audio/mulaw
MULAW audio format
sample_rate
integer
 (optional)
The sample rate of the audio.
type
object
 (required)
No description provided.
Always set to "audio".
uri
string
 (optional)
The URI of the audio.
DocumentContent
A document content block.
data
string
 (optional)
The document content.
mime_type
enum (string)
 (optional)
The mime type of the document.
Possible
values:
application/pdf
PDF document format
text/csv
CSV document format
type
object
 (required)
No description provided.
Always set to "document".
uri
string
 (optional)
The URI of the document.
VideoContent
A video content block.
data
string
 (optional)
The video content.
mime_type
enum (string)
 (optional)
The mime type of the video.
Possible
values:
video/mp4
MP4 video format
video/mpeg
MPEG video format
video/mpg
MPG video format
video/mov
MOV video format
video/avi
AVI video format
video/x-flv
FLV video format
video/webm
WebM video format
video/wmv
WMV video format
video/3gpp
3GPP video format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "video".
uri
string
 (optional)
The URI of the video.
error
Status
 (optional)
The error result of the operation in case of failure or cancellation.
The `Status` type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It is
used by [gRPC](https://github.com/grpc). Each `Status` message contains
three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the
[API Design Guide](https://cloud.google.com/apis/design/errors).
Fields
code
integer
 (optional)
The status code, which should be an enum value of google.rpc.Code.
details
array (object)
 (optional)
A list of messages that carry the error details.  There is a common set of
message types for APIs to use.
message
string
 (optional)
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
google.rpc.Status.details field, or localized by the client.
type
object
 (required)
No description provided.
Always set to "model_output".
ThoughtStep
A thought step.
signature
string
 (optional)
A signature hash for backend validation.
summary
ThoughtSummaryContent
 (optional)
A summary of the thought.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
annotations
Annotation
 (optional)
Citation information for model-generated content.
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
title
string
 (optional)
The title of the URL.
type
object
 (required)
No description provided.
Always set to "url_citation".
url
string
 (optional)
The URL.
FileCitation
A file citation annotation.
custom_metadata
object
 (optional)
User provided metadata about the retrieved context.
document_uri
string
 (optional)
The URI of the file.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
file_name
string
 (optional)
The name of the file.
media_id
string
 (optional)
Media ID in-case of image citations, if applicable.
page_number
integer
 (optional)
Page number of the cited document, if applicable.
source
string
 (optional)
Source attributed for a portion of the text.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "file_citation".
PlaceCitation
A place citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
name
string
 (optional)
Title of the place.
place_id
string
 (optional)
The ID of the place, in `places/{place_id}` format.
review_snippets
ReviewSnippet
 (optional)
Snippets of reviews that are used to generate answers about the
features of a given place in Google Maps.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "place_citation".
url
string
 (optional)
URI reference of the place.
text
string
 (required)
Required. The text content.
type
object
 (required)
No description provided.
Always set to "text".
ImageContent
An image content block.
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
type
object
 (required)
No description provided.
Always set to "thought".
FunctionCallStep
A function tool call step.
arguments
object
 (required)
Required. The arguments to pass to the function.
id
string
 (required)
Required. A unique ID for this specific tool call.
name
string
 (required)
Required. The name of the tool to call.
type
object
 (required)
No description provided.
Always set to "function_call".
CodeExecutionCallStep
Code execution call step.
arguments
CodeExecutionCallStepArguments
 (required)
Required. The arguments to pass to the code execution.
The arguments to pass to the code execution.
Fields
code
string
 (optional)
The code to be executed.
language
enum (string)
 (optional)
Programming language of the `code`.
Possible
values:
python
Python = 3.10, with numpy and simpy available.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "code_execution_call".
UrlContextCallStep
URL context call step.
arguments
UrlContextCallArguments
 (required)
Required. The arguments to pass to the URL context.
The arguments to pass to the URL context.
Fields
urls
array (string)
 (optional)
The URLs to fetch.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "url_context_call".
McpServerToolCallStep
MCPServer tool call step.
arguments
object
 (required)
Required. The JSON object of arguments for the function.
id
string
 (required)
Required. A unique ID for this specific tool call.
name
string
 (required)
Required. The name of the tool which was called.
server_name
string
 (required)
Required. The name of the used MCP server.
type
object
 (required)
No description provided.
Always set to "mcp_server_tool_call".
GoogleSearchCallStep
Google Search call step.
arguments
GoogleSearchCallStepArguments
 (required)
Required. The arguments to pass to Google Search.
The arguments to pass to Google Search.
Fields
queries
array (string)
 (optional)
Web search queries for the following-up web search.
id
string
 (required)
Required. A unique ID for this specific tool call.
search_type
enum (string)
 (optional)
The type of search grounding enabled.
Possible
values:
web_search
Setting this field enables web search. Only text results are returned.
image_search
Setting this field enables image search. Image bytes are returned.
enterprise_web_search
Setting this field enables enterprise web search.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_search_call".
FileSearchCallStep
File Search call step.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "file_search_call".
GoogleMapsCallStep
Google Maps call step.
arguments
GoogleMapsCallStepArguments
 (optional)
The arguments to pass to the Google Maps tool.
The arguments to pass to the Google Maps tool.
Fields
queries
array (string)
 (optional)
The queries to be executed.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_maps_call".
FunctionResultStep
Result of a function tool call.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the tool call resulted in an error.
name
string
 (optional)
The name of the tool that was called.
result
array (ImageContent or TextContent) or object or string
 (required)
The result of the tool call.
type
object
 (required)
No description provided.
Always set to "function_result".
CodeExecutionResultStep
Code execution result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the code execution resulted in an error.
result
string
 (required)
Required. The output of the code execution.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "code_execution_result".
UrlContextResultStep
URL context result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the URL context resulted in an error.
result
UrlContextResult
 (required)
Required. The results of the URL context.
The result of the URL context.
Fields
status
enum (string)
 (optional)
The status of the URL retrieval.
Possible
values:
success
Url retrieval is successful.
error
Url retrieval is failed due to error.
paywall
Url retrieval is failed because the content is behind paywall.
unsafe
Url retrieval is failed because the content is unsafe.
url
string
 (optional)
The URL that was fetched.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "url_context_result".
GoogleSearchResultStep
Google Search result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the Google Search resulted in an error.
result
GoogleSearchResultItem
 (required)
Required. The results of the Google Search.
The result of the Google Search.
Fields
search_suggestions
string
 (optional)
Web content snippet that can be embedded in a web page or an app webview.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_search_result".
McpServerToolResultStep
MCPServer tool result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
name
string
 (optional)
Name of the tool which is called for this specific tool call.
result
array (ImageContent or TextContent) or object or string
 (required)
The output from the MCP server call. Can be simple text or rich content.
server_name
string
 (optional)
The name of the used MCP server.
type
object
 (required)
No description provided.
Always set to "mcp_server_tool_result".
FileSearchResultStep
File Search result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "file_search_result".
GoogleMapsResultStep
Google Maps result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
result
GoogleMapsResultItem
 (required)
No description provided.
The result of the Google Maps.
Fields
places
GoogleMapsResultPlaces
 (optional)
No description provided.
Fields
name
string
 (optional)
No description provided.
place_id
string
 (optional)
No description provided.
review_snippets
ReviewSnippet
 (optional)
No description provided.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
url
string
 (optional)
No description provided.
widget_context_token
string
 (optional)
No description provided.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_maps_result".
system_instruction
string
 (optional)
System instruction for the interaction.
tools
Tool
 (optional)
A list of tool declarations the model may call during interaction.
A tool that can be used by the model.
Possible Types
Polymorphic discriminator: type
Function
A tool that can be used by the model.
description
string
 (optional)
A description of the function.
name
string
 (optional)
The name of the function.
parameters
object
 (optional)
The JSON Schema for the function's parameters.
type
object
 (required)
No description provided.
Always set to "function".
CodeExecution
A tool that can be used by the model to execute code.
type
object
 (required)
No description provided.
Always set to "code_execution".
UrlContext
A tool that can be used by the model to fetch URL context.
type
object
 (required)
No description provided.
Always set to "url_context".
ComputerUse
A tool that can be used by the model to interact with the computer.
disabled_safety_policies
array (enum (string))
 (optional)
Optional. Disabled safety policies for computer use.
Possible
values:
financial_transactions
Safety policy for financial transactions.
sensitive_data_modification
Safety policy for sensitive data modification.
communication_tool
Safety policy for communication tools (e.g. Gmail, Chat, Meet).
account_creation
Safety policy for account creation.
data_modification
Safety policy for data modification.
user_consent_management
Safety policy for user consent management.
legal_terms_and_agreements
Safety policy for legal terms and agreements.
enable_prompt_injection_detection
boolean
 (optional)
Whether enable the prompt injection detection check on computer-use
request.
environment
enum (string)
 (optional)
The environment being operated.
Possible
values:
browser
Operates in a web browser.
mobile
Operates in a mobile environment.
desktop
Operates in a desktop environment.
excluded_predefined_functions
array (string)
 (optional)
The list of predefined functions that are excluded from the model call.
type
object
 (required)
No description provided.
Always set to "computer_use".
McpServer
A MCPServer is a server that can be called by the model to perform actions.
allowed_tools
AllowedTools
 (optional)
The allowed tools.
The configuration for allowed tools.
Fields
mode
enum (string)
 (optional)
The mode of the tool choice.
Possible
values:
auto
Auto tool choice.
any
Any tool choice.
none
No tool choice.
validated
Validated tool choice.
tools
array (string)
 (optional)
The names of the allowed tools.
headers
object
 (optional)
Optional: Fields for authentication headers, timeouts, etc., if needed.
name
string
 (optional)
The name of the MCPServer.
type
object
 (required)
No description provided.
Always set to "mcp_server".
url
string
 (optional)
The full URL for the MCPServer endpoint.
Example: "https://api.example.com/mcp"
GoogleSearch
A tool that can be used by the model to search Google.
search_types
array (enum (string))
 (optional)
The types of search grounding to enable.
Possible
values:
web_search
Setting this field enables web search. Only text results are returned.
image_search
Setting this field enables image search. Image bytes are returned.
enterprise_web_search
Setting this field enables enterprise web search.
type
object
 (required)
No description provided.
Always set to "google_search".
FileSearch
A tool that can be used by the model to search files.
file_search_store_names
array (string)
 (optional)
The file search store names to search.
metadata_filter
string
 (optional)
Metadata filter to apply to the semantic retrieval documents and chunks.
top_k
integer
 (optional)
The number of semantic retrieval chunks to retrieve.
type
object
 (required)
No description provided.
Always set to "file_search".
GoogleMaps
A tool that can be used by the model to call Google Maps.
enable_widget
boolean
 (optional)
Whether to return a widget context token in the tool call result of the
response.
latitude
number
 (optional)
The latitude of the user's location.
longitude
number
 (optional)
The longitude of the user's location.
type
object
 (required)
No description provided.
Always set to "google_maps".
Retrieval
A tool that can be used by the model to retrieve files.
exa_ai_search_config
ExaAISearchConfig
 (optional)
Used to specify configuration for ExaAISearch.
Used to specify configuration for ExaAISearch.
Fields
api_key
string
 (optional)
Required. The API key for ExaAiSearch.
custom_config
object
 (optional)
Optional. This field can be used to pass any parameter from the Exa.ai Search API.
parallel_ai_search_config
ParallelAISearchConfig
 (optional)
Used to specify configuration for ParallelAISearch.
Used to specify configuration for ParallelAISearch.
Fields
api_key
string
 (optional)
Optional. The API key for ParallelAiSearch.
custom_config
object
 (optional)
Optional. Custom configs for ParallelAiSearch.
rag_store_config
RagStoreConfig
 (optional)
Used to specify configuration for RagStore.
Use to specify configuration for RAG Store.
Fields
rag_resources
RagResource
 (optional)
Optional. The representation of the rag source.
The definition of the Rag resource.
Fields
rag_corpus
string
 (optional)
Optional. RagCorpora resource name.
rag_file_ids
array (string)
 (optional)
Optional. rag_file_id. The files should be in the same rag_corpus set in
rag_corpus field.
rag_retrieval_config
RagRetrievalConfig
 (optional)
Optional. The retrieval config for the Rag query.
Specifies the context retrieval config.
Fields
filter
Filter
 (optional)
Optional. Config for filters.
Config for filters.
Fields
metadata_filter
string
 (optional)
Optional. String for metadata filtering.
vector_distance_threshold
number
 (optional)
Optional. Only returns contexts with vector distance smaller than the
threshold.
vector_similarity_threshold
number
 (optional)
Optional. Only returns contexts with vector similarity larger than the
threshold.
hybrid_search
HybridSearch
 (optional)
Optional. Config for Hybrid Search.
Config for Hybrid Search.
Fields
alpha
number
 (optional)
Optional. Alpha value controls the weight between dense and sparse vector search
results.
ranking
Ranking
 (optional)
Optional. Config for ranking and reranking.
Config for ranking and reranking.
top_k
integer
 (optional)
Optional. The number of contexts to retrieve.
retrieval_types
array (enum (string))
 (optional)
The types of file retrieval to enable.
Possible
values:
rag_store
exa_ai_search
parallel_ai_search
type
object
 (required)
No description provided.
Always set to "retrieval".
updated
string
 (optional)
Output only. The time at which the response was last updated in ISO 8601 format
(YYYY-MM-DDThh:mm:ssZ).
usage
Usage
 (optional)
Output only. Statistics on the interaction request's token usage.
Statistics on the interaction request's token usage.
Fields
cached_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of cached token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
grounding_tool_count
GroundingToolCount
 (optional)
Grounding tool count.
The number of grounding tool counts.
Fields
count
integer
 (optional)
The number of grounding tool counts.
type
enum (string)
 (optional)
The grounding tool type associated with the count.
Possible
values:
google_search
Grounding with Google Web Search and Image Search, & Web Grounding
for Enterprise.
google_maps
Grounding with Google Maps.
retrieval
Grounding with customer's data, for example, VertexAISearch.
input_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of input token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
output_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of output token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
tool_use_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of tool-use token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
total_cached_tokens
integer
 (optional)
Number of tokens in the cached part of the prompt (the cached content).
total_input_tokens
integer
 (optional)
Number of tokens in the prompt (context).
total_output_tokens
integer
 (optional)
Total number of tokens across all the generated responses.
total_thought_tokens
integer
 (optional)
Number of tokens of thoughts for thinking models.
total_tokens
integer
 (optional)
Total token count for the interaction request (prompt + responses + other
internal tokens).
total_tool_use_tokens
integer
 (optional)
Number of tokens present in tool-use prompt(s).
webhook_config
WebhookConfig
 (optional)
Optional. Webhook configuration for receiving notifications when the
interaction completes.
Message for configuring webhook events for a request.
Fields
uris
array (string)
 (optional)
Optional. If set, these webhook URIs will be used for webhook events instead of the
registered webhooks.
user_metadata
object
 (optional)
Optional. The user metadata that will be returned on each event emission to the
webhooks.
last_pause_time
string
 (optional)
Output only. The time when the trigger was last paused.
last_resume_time
string
 (optional)
Output only. The time when the trigger was last resumed.
last_run_time
string
 (optional)
Output only. The time when the trigger was last run.
max_consecutive_failures
integer
 (optional)
Optional. The maximum number of consecutive failures allowed before
the trigger is automatically paused (status becomes ERROR).
next_run_time
string
 (optional)
Output only. The time when the trigger is scheduled to run next.
previous_interaction_id
string
 (optional)
Output only. The ID of the last interaction created by this trigger.
schedule
string
 (optional)
Required. The cron schedule on which the trigger should run.
Standard cron format.
status
enum (string)
 (optional)
Output only. The current status of the trigger.
Possible
values:
active
The trigger is active and will fire on schedule.
paused
The trigger is paused and will not fire.
error
The trigger has entered an error state due to consecutive failures.
time_zone
string
 (optional)
Required. Time zone in which the schedule should be interpreted.
update_time
string
 (optional)
Output only. The time when the trigger was last updated.
Example
Example Response
{
"consecutive_failure_count": 0,
"create_time": "string",
"display_name": "string",
"environment_id": "string",
"execution_timeout_seconds": 0,
"id": "string",
"interaction": {
"created": "2025-12-04T15:01:45Z",
"id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
"model": "gemini-3.5-flash",
"object": "interaction",
"steps": [
{
"type": "model_output",
"content": [
{
"type": "text",
"text": "Hello! I'm doing well, functioning as expected. Thank you for asking! How are you doing today?"
}
]
}
],
"status": "completed",
"updated": "2025-12-04T15:01:45Z",
"usage": {
"input_tokens_by_modality": [
{
"modality": "text",
"tokens": 7
}
],
"total_cached_tokens": 0,
"total_input_tokens": 7,
"total_output_tokens": 23,
"total_thought_tokens": 49,
"total_tokens": 79,
"total_tool_use_tokens": 0
}
},
"last_pause_time": "string",
"last_resume_time": "string",
"last_run_time": "string",
"max_consecutive_failures": 0,
"next_run_time": "string",
"previous_interaction_id": "string",
"schedule": "string",
"status": "active",
"time_zone": "string",
"update_time": "string"
}
DeleteTrigger
delete
https://generativelanguage.googleapis.com/v1beta/triggers/{id}
Deletes a trigger.
Response
Response
If successful, the response is empty.
Example
Resources
Trigger
A trigger configuration that is scheduled to run an agent.
Fields
consecutive_failure_count
integer
 (optional)
Output only. The number of consecutive failures that have occurred
since the last successful execution.
create_time
string
 (optional)
Output only. The time when the trigger was created.
display_name
string
 (optional)
Optional. The display name of the trigger.
environment_id
string
 (optional)
Optional. The environment ID for the trigger execution.
execution_timeout_seconds
integer
 (optional)
Optional. The execution timeout for the triggered interaction.
id
string
 (optional)
Required. Output only. Identifier. The ID of the trigger.
interaction
Interaction
 (optional)
Required. The interaction request template to be executed.
The Interaction resource.
Fields
agent
AgentOption
 (optional)
The name of the `Agent` used for generating the interaction.
The agent to interact with.
Possible values
deep-research-pro-preview-12-2025
Gemini Deep Research Agent
deep-research-preview-04-2026
Gemini Deep Research Agent
deep-research-max-preview-04-2026
Gemini Deep Research Max Agent
antigravity-preview-05-2026
Use the Antigravity managed agent to perform multi-step tasks that require reasoning, file operations, and tool use.
agent_config
object
 (optional)
Configuration parameters for the agent interaction.
Possible Types
Polymorphic discriminator: type
DynamicAgentConfig
Configuration for dynamic agents.
type
object
 (required)
No description provided.
Always set to "dynamic".
DeepResearchAgentConfig
Configuration for the Deep Research agent.
collaborative_planning
boolean
 (optional)
Enables human-in-the-loop planning for the Deep Research agent. If set to
true, the Deep Research agent will provide a research plan in its response.
The agent will then proceed only if the user confirms the plan in the next
turn.
enable_bigquery_tool
boolean
 (optional)
Enables bigquery tool for the Deep Research agent.
thinking_summaries
ThinkingSummaries
 (optional)
Whether to include thought summaries in the response.
Possible values
auto
Auto thinking summaries.
none
No thinking summaries.
type
object
 (required)
No description provided.
Always set to "deep-research".
visualization
enum (string)
 (optional)
Whether to include visualizations in the response.
Possible
values:
off
Do not include visualizations.
auto
Automatically include visualizations.
CodeMenderAgentConfig
Configuration for the CodeMender agent.
find_request
FindRequest
 (optional)
Parameters for finding vulnerabilities.
Request parameters specific to FIND sessions, used for discovering
vulnerabilities in a codebase.
Fields
description
string
 (optional)
Additional context or custom instructions provided by the user to guide
the vulnerability analysis.
finding_id
string
 (optional)
The identifier of a specific finding to verify. This is primarily used in
VERIFY mode to focus the agent's execution-based validation on a single
vulnerability.
mode
enum (string)
 (optional)
The mode of the find session.
Possible
values:
scan
Fast scan using only the initial classifier.
verify
Performs classification followed by detailed investigation.
source_files
FileContent
 (optional)
A list of source files to provide as context for the scan.
Content of a single file in the codebase.
Fields
content
string
 (optional)
The UTF-8 encoded text content of the file.
path
string
 (optional)
The relative path of the file from the project root.
fix_request
FixRequest
 (optional)
Parameters for fixing vulnerabilities.
Request parameters specific to FIX sessions, used for generating and
validating security patches.
Fields
description
string
 (optional)
Additional context or custom instructions provided by the user to guide
the patch generation process.
finding_id
string
 (optional)
The identifier of the specific security finding to be remediated. This ID
maps to a previously discovered vulnerability.
source_files
FileContent
 (optional)
A list of source files providing context for the remediation. These files
are typically the ones containing the identified vulnerability.
Content of a single file in the codebase.
Fields
content
string
 (optional)
The UTF-8 encoded text content of the file.
path
string
 (optional)
The relative path of the file from the project root.
model
string
 (optional)
The name of the model to use for the CodeMender agent. One
CodeMender session will only use one model.
session_config
SessionConfig
 (optional)
Optional session-specific configurations to override default agent
behavior.
The configuration of CodeMender sessions.
Fields
max_rounds
integer
 (optional)
The maximum number of interaction rounds the agent is allowed to perform
before reaching a timeout.
session_id
string
 (optional)
Parameter for grouping multiple interactions that belong to
the same CodeMender session.
type
object
 (required)
No description provided.
Always set to "code-mender".
AntigravityAgentConfig
Configuration for the Antigravity agent runtime.
Provides server-side control over the agent's execution environment
and tool configuration.
max_total_tokens
string
 (optional)
Max total tokens for the agent run.
type
object
 (required)
No description provided.
Always set to "antigravity".
created
string
 (optional)
Output only. The time at which the response was created in ISO 8601 format
(YYYY-MM-DDThh:mm:ssZ).
environment
EnvironmentConfig
 (optional)
The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.
Configuration for a custom environment.
Fields
environment_id
string
 (optional)
Optional. The environment ID for the interaction. If specified, the request will
update the existing environment instead of creating a new one.
network
EnvironmentNetworkEgressAllowlist
 (optional)
Network configuration for the environment.
Outbound networking configuration for the sandbox. Accepts an object with an 'allowlist' array to restrict traffic, or the string 'disabled' to turn off all network access. Omit entirely to allow all outbound traffic with no header injection.
Possible Types
object
Outbound networking configuration for the sandbox. When specified, restricts which external domains the sandbox can reach. Omit entirely to allow all outbound traffic with no header injection.
allowlist
AllowlistEntry
 (optional)
List of allowed outbound domains. Only requests to listed domains are permitted. Use [{'domain': '*'}] to allow all domains while still injecting headers on specific ones.
A single domain allowlist rule with optional header injection.
Fields
domain
string
 (optional)
Domain to allow outbound requests to. Supports wildcards (e.g. '*.googleapis.com'). Use '*' to allow all domains.
transform
array (object) or object
 (optional)
Headers to inject on all outbound requests matching this domain. Accepts a single dict or a list of dicts. The egress proxy injects these automatically.
string
Turns all network off.
Possible values
disabled
Turns all network off.
sources
Source
 (optional)
No description provided.
A source to be mounted into the environment.
Fields
content
string
 (optional)
The inline content if `type` is `INLINE`.
encoding
string
 (optional)
Optional encoding for inline content (e.g. `base64`).
source
string
 (optional)
The source of the environment.
For GCS, this is the GCS path.
For GitHub, this is the GitHub path.
target
string
 (optional)
Where the source should appear in the environment.
type
enum (string)
 (optional)
No description provided.
Possible
values:
gcs
A GCS bucket.
inline
Inline content.
repository
A generic repository. The protocol prefix in the source URL
identifies the provider (e.g., github://, gcs://).
skill_registry
A skill resource from the Skill Registry Service.
Skill: projects/{project}/locations/{location}/skills/{skill}
SkillRevision:
projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}
Support mounting all skills under a project:
projects/{project}/locations/{location}/skills.
type
object
 (optional)
No description provided.
Always set to "remote".
environment_id
string
 (optional)
Output only. The environment ID for the interaction. Only populated if environment
config is set in the request.
id
string
 (optional)
Required. Output only. A unique identifier for the interaction completion.
Defaults to:
input
Content or array (Content) or array (Step) or array (Turn) or string
 (optional)
The input for the interaction.
labels
object
 (optional)
The labels with user-defined metadata for the request.
model
ModelOption
 (optional)
The name of the `Model` used for generating the interaction.
The model that will complete your prompt.\n\nSee [models](https://ai.google.dev/gemini-api/docs/models) for additional details.
Possible values
gemini-2.5-flash
Our first hybrid reasoning model which supports a 1M token context window and has thinking budgets.
gemini-2.5-pro
Our state-of-the-art multipurpose model, which excels at coding and complex reasoning tasks.
gemma-4-26b-a4b-it
Gemma 4 26B A4B IT
gemma-4-31b-it
Gemma 4 31B IT
gemini-flash-latest
Latest release of Gemini Flash
gemini-flash-lite-latest
Latest release of Gemini Flash-Lite
gemini-pro-latest
Latest release of Gemini Pro
gemini-2.5-flash-lite
Our smallest and most cost effective model, built for at scale usage.
gemini-2.5-flash-image
Our native image generation model, optimized for speed, flexibility, and contextual understanding. Text input and output is priced the same as 2.5 Flash.
gemini-3-flash-preview
Our most intelligent model built for speed, combining frontier intelligence with superior search and grounding.
gemini-3.1-pro-preview
Our latest SOTA reasoning model with unprecedented depth and nuance, and powerful multimodal understanding and coding capabilities.
gemini-3.1-pro-preview-customtools
Gemini 3.1 Pro Preview optimized for custom tool usage
gemini-3.1-flash-lite
Our most cost-efficient model, optimized for high-volume agentic tasks, translation, and simple data processing.
gemini-3-pro-image
Gemini 3 Pro Image
nano-banana-pro-preview
Gemini 3 Pro Image Preview
gemini-3.1-flash-image
Gemini 3.1 Flash Image.
gemini-3.5-flash
Our most intelligent model for sustained frontier performance in agentic and coding tasks.
lyria-3-clip-preview
Our low-latency, music generation model optimized for high-fidelity audio clips and precise rhythmic control.
lyria-3-pro-preview
Our advanced, full-song generative model with deep compositional understanding, optimized for precise structural control and complex transitions across diverse musical styles.
gemini-robotics-er-1.6-preview
Gemini Robotics-ER 1.6 Preview
output_audio
AudioContent
 (optional)
The last audio generated by the model in response to the current request.
Note: this is added by the SDK.
An audio content block.
Fields
channels
integer
 (optional)
The number of audio channels.
data
string
 (optional)
The audio content.
mime_type
enum (string)
 (optional)
The mime type of the audio.
Possible
values:
audio/wav
WAV audio format
audio/mp3
MP3 audio format
audio/aiff
AIFF audio format
audio/aac
AAC audio format
audio/ogg
OGG audio format
audio/flac
FLAC audio format
audio/mpeg
MPEG audio format
audio/m4a
M4A audio format
audio/l16
L16 audio format
audio/opus
OPUS audio format
audio/alaw
ALAW audio format
audio/mulaw
MULAW audio format
sample_rate
integer
 (optional)
The sample rate of the audio.
type
object
 (optional)
No description provided.
Always set to "audio".
uri
string
 (optional)
The URI of the audio.
output_image
ImageContent
 (optional)
The last image generated by the model in response to the current request.
Note: this is added by the SDK.
An image content block.
Fields
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (optional)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
output_text
string
 (optional)
Concatenated text from the last model output in response to the current request.
Note: this is added by the SDK.
output_video
VideoContent
 (optional)
The last video generated by the model in response to the current request.
Note: this is added by the SDK.
A video content block.
Fields
data
string
 (optional)
The video content.
mime_type
enum (string)
 (optional)
The mime type of the video.
Possible
values:
video/mp4
MP4 video format
video/mpeg
MPEG video format
video/mpg
MPG video format
video/mov
MOV video format
video/avi
AVI video format
video/x-flv
FLV video format
video/webm
WebM video format
video/wmv
WMV video format
video/3gpp
3GPP video format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (optional)
No description provided.
Always set to "video".
uri
string
 (optional)
The URI of the video.
previous_interaction_id
string
 (optional)
The ID of the previous interaction, if any.
response_format
ResponseFormat
 (optional)
Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
Possible Types
AudioResponseFormat
Configuration for audio output format.
bit_rate
integer
 (optional)
Bit rate in bits per second (bps). Only applicable for compressed formats
(MP3, Opus).
delivery
enum (string)
 (optional)
The delivery mode for the audio output.
Possible
values:
inline
Audio data is returned inline in the response.
uri
Audio data is returned as a URI.
mime_type
enum (string)
 (optional)
The MIME type of the audio output.
Possible
values:
audio/mp3
MP3 audio format.
audio/ogg_opus
OGG Opus audio format.
audio/l16
Raw PCM (L16) audio format.
audio/wav
WAV audio format.
audio/alaw
A-law audio format.
audio/mulaw
Mu-law audio format.
sample_rate
integer
 (optional)
Sample rate in Hz.
type
object
 (required)
No description provided.
Always set to "audio".
TextResponseFormat
Configuration for text output format.
mime_type
enum (string)
 (optional)
The MIME type of the text output.
Possible
values:
application/json
JSON output format.
text/plain
Plain text output format.
schema
object
 (optional)
The JSON schema that the output should conform to. Only applicable when
mime_type is application/json.
type
object
 (required)
No description provided.
Always set to "text".
ImageResponseFormat
Configuration for image output format.
aspect_ratio
enum (string)
 (optional)
The aspect ratio for the image output.
Possible
values:
1:1
1:1 aspect ratio.
2:3
2:3 aspect ratio.
3:2
3:2 aspect ratio.
3:4
3:4 aspect ratio.
4:3
4:3 aspect ratio.
4:5
4:5 aspect ratio.
5:4
5:4 aspect ratio.
9:16
9:16 aspect ratio.
16:9
16:9 aspect ratio.
21:9
21:9 aspect ratio.
1:8
1:8 aspect ratio.
8:1
8:1 aspect ratio.
1:4
1:4 aspect ratio.
4:1
4:1 aspect ratio.
delivery
enum (string)
 (optional)
The delivery mode for the image output.
Possible
values:
inline
Image data is returned inline in the response.
uri
Image data is returned as a URI.
image_size
enum (string)
 (optional)
The size of the image output.
Possible
values:
512
512px image size.
1K
1K image size.
2K
2K image size.
4K
4K image size.
mime_type
enum (string)
 (optional)
The MIME type of the image output.
Possible
values:
image/jpeg
JPEG image format.
type
object
 (required)
No description provided.
Always set to "image".
VideoResponseFormat
Configuration for video output format.
aspect_ratio
enum (string)
 (optional)
The aspect ratio for the video output.
Possible
values:
16:9
16:9 aspect ratio.
9:16
9:16 aspect ratio.
delivery
enum (string)
 (optional)
The delivery mode for the video output.
Possible
values:
inline
Video data is returned inline in the response.
uri
Video data is returned as a URI.
duration
string
 (optional)
The duration for the video output.
gcs_uri
string
 (optional)
The GCS URI to store the video output. Required for Vertex if delivery mode
is URI.
type
object
 (required)
No description provided.
Always set to "video".
response_modalities
ResponseModality
 (optional)
The requested modalities of the response (TEXT, IMAGE, AUDIO).
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
safety_settings
SafetySetting
 (optional)
Safety settings for the interaction.
A safety setting that affects the safety-blocking behavior.
A SafetySetting consists of a
harm category and a
threshold for that
category.
Fields
method
enum (string)
 (optional)
Optional. The method for blocking content. If not specified, the default
behavior is to use the probability score.
Possible
values:
severity
The harm block method uses both probability and severity scores.
probability
The harm block method uses the probability score.
threshold
enum (string)
 (optional)
Required. The threshold for blocking content. If the harm probability
exceeds this threshold, the content will be blocked.
Possible
values:
block_low_and_above
Block content with a low harm probability or higher.
block_medium_and_above
Block content with a medium harm probability or higher.
block_only_high
Block content with a high harm probability.
block_none
Do not block any content, regardless of its harm probability.
off
Turn off the safety filter entirely.
type
HarmCategory
 (optional)
Required. The type of harm category to be blocked.
Possible values
hate_speech
Content that promotes violence or incites hatred against individuals or
groups based on certain attributes.
dangerous_content
Content that promotes, facilitates, or enables dangerous activities.
harassment
Abusive, threatening, or content intended to bully, torment, or ridicule.
sexually_explicit
Content that contains sexually explicit material.
civic_integrity
Deprecated: Election filter is not longer supported.
The harm category is civic integrity.
image_hate
Images that contain hate speech.
image_dangerous_content
Images that contain dangerous content.
image_harassment
Images that contain harassment.
image_sexually_explicit
Images that contain sexually explicit content.
jailbreak
Prompts designed to bypass safety filters.
service_tier
ServiceTier
 (optional)
The service tier for the interaction.
Possible values
flex
Flex service tier.
standard
Standard service tier.
priority
Priority service tier.
status
enum (string)
 (optional)
Required. Output only. The status of the interaction.
Possible
values:
in_progress
The interaction is in progress.
requires_action
The interaction requires action/input from the user.
completed
The interaction is completed.
failed
The interaction failed.
cancelled
The interaction was cancelled.
incomplete
The interaction is completed, but contains incomplete results (e.g.
hitting max_tokens).
budget_exceeded
The interaction was halted because the token budget was exceeded.
steps
Step
 (optional)
Output only. The steps that make up the interaction, when included in the response.
A step in the interaction.
Possible Types
Polymorphic discriminator: type
UserInputStep
Input provided by the user.
content
Content
 (optional)
No description provided.
The content of the response.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
annotations
Annotation
 (optional)
Citation information for model-generated content.
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
title
string
 (optional)
The title of the URL.
type
object
 (required)
No description provided.
Always set to "url_citation".
url
string
 (optional)
The URL.
FileCitation
A file citation annotation.
custom_metadata
object
 (optional)
User provided metadata about the retrieved context.
document_uri
string
 (optional)
The URI of the file.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
file_name
string
 (optional)
The name of the file.
media_id
string
 (optional)
Media ID in-case of image citations, if applicable.
page_number
integer
 (optional)
Page number of the cited document, if applicable.
source
string
 (optional)
Source attributed for a portion of the text.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "file_citation".
PlaceCitation
A place citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
name
string
 (optional)
Title of the place.
place_id
string
 (optional)
The ID of the place, in `places/{place_id}` format.
review_snippets
ReviewSnippet
 (optional)
Snippets of reviews that are used to generate answers about the
features of a given place in Google Maps.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "place_citation".
url
string
 (optional)
URI reference of the place.
text
string
 (required)
Required. The text content.
type
object
 (required)
No description provided.
Always set to "text".
ImageContent
An image content block.
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
AudioContent
An audio content block.
channels
integer
 (optional)
The number of audio channels.
data
string
 (optional)
The audio content.
mime_type
enum (string)
 (optional)
The mime type of the audio.
Possible
values:
audio/wav
WAV audio format
audio/mp3
MP3 audio format
audio/aiff
AIFF audio format
audio/aac
AAC audio format
audio/ogg
OGG audio format
audio/flac
FLAC audio format
audio/mpeg
MPEG audio format
audio/m4a
M4A audio format
audio/l16
L16 audio format
audio/opus
OPUS audio format
audio/alaw
ALAW audio format
audio/mulaw
MULAW audio format
sample_rate
integer
 (optional)
The sample rate of the audio.
type
object
 (required)
No description provided.
Always set to "audio".
uri
string
 (optional)
The URI of the audio.
DocumentContent
A document content block.
data
string
 (optional)
The document content.
mime_type
enum (string)
 (optional)
The mime type of the document.
Possible
values:
application/pdf
PDF document format
text/csv
CSV document format
type
object
 (required)
No description provided.
Always set to "document".
uri
string
 (optional)
The URI of the document.
VideoContent
A video content block.
data
string
 (optional)
The video content.
mime_type
enum (string)
 (optional)
The mime type of the video.
Possible
values:
video/mp4
MP4 video format
video/mpeg
MPEG video format
video/mpg
MPG video format
video/mov
MOV video format
video/avi
AVI video format
video/x-flv
FLV video format
video/webm
WebM video format
video/wmv
WMV video format
video/3gpp
3GPP video format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "video".
uri
string
 (optional)
The URI of the video.
type
object
 (required)
No description provided.
Always set to "user_input".
ModelOutputStep
Output generated by the model.
content
Content
 (optional)
No description provided.
The content of the response.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
annotations
Annotation
 (optional)
Citation information for model-generated content.
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
title
string
 (optional)
The title of the URL.
type
object
 (required)
No description provided.
Always set to "url_citation".
url
string
 (optional)
The URL.
FileCitation
A file citation annotation.
custom_metadata
object
 (optional)
User provided metadata about the retrieved context.
document_uri
string
 (optional)
The URI of the file.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
file_name
string
 (optional)
The name of the file.
media_id
string
 (optional)
Media ID in-case of image citations, if applicable.
page_number
integer
 (optional)
Page number of the cited document, if applicable.
source
string
 (optional)
Source attributed for a portion of the text.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "file_citation".
PlaceCitation
A place citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
name
string
 (optional)
Title of the place.
place_id
string
 (optional)
The ID of the place, in `places/{place_id}` format.
review_snippets
ReviewSnippet
 (optional)
Snippets of reviews that are used to generate answers about the
features of a given place in Google Maps.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "place_citation".
url
string
 (optional)
URI reference of the place.
text
string
 (required)
Required. The text content.
type
object
 (required)
No description provided.
Always set to "text".
ImageContent
An image content block.
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
AudioContent
An audio content block.
channels
integer
 (optional)
The number of audio channels.
data
string
 (optional)
The audio content.
mime_type
enum (string)
 (optional)
The mime type of the audio.
Possible
values:
audio/wav
WAV audio format
audio/mp3
MP3 audio format
audio/aiff
AIFF audio format
audio/aac
AAC audio format
audio/ogg
OGG audio format
audio/flac
FLAC audio format
audio/mpeg
MPEG audio format
audio/m4a
M4A audio format
audio/l16
L16 audio format
audio/opus
OPUS audio format
audio/alaw
ALAW audio format
audio/mulaw
MULAW audio format
sample_rate
integer
 (optional)
The sample rate of the audio.
type
object
 (required)
No description provided.
Always set to "audio".
uri
string
 (optional)
The URI of the audio.
DocumentContent
A document content block.
data
string
 (optional)
The document content.
mime_type
enum (string)
 (optional)
The mime type of the document.
Possible
values:
application/pdf
PDF document format
text/csv
CSV document format
type
object
 (required)
No description provided.
Always set to "document".
uri
string
 (optional)
The URI of the document.
VideoContent
A video content block.
data
string
 (optional)
The video content.
mime_type
enum (string)
 (optional)
The mime type of the video.
Possible
values:
video/mp4
MP4 video format
video/mpeg
MPEG video format
video/mpg
MPG video format
video/mov
MOV video format
video/avi
AVI video format
video/x-flv
FLV video format
video/webm
WebM video format
video/wmv
WMV video format
video/3gpp
3GPP video format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "video".
uri
string
 (optional)
The URI of the video.
error
Status
 (optional)
The error result of the operation in case of failure or cancellation.
The `Status` type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It is
used by [gRPC](https://github.com/grpc). Each `Status` message contains
three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the
[API Design Guide](https://cloud.google.com/apis/design/errors).
Fields
code
integer
 (optional)
The status code, which should be an enum value of google.rpc.Code.
details
array (object)
 (optional)
A list of messages that carry the error details.  There is a common set of
message types for APIs to use.
message
string
 (optional)
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
google.rpc.Status.details field, or localized by the client.
type
object
 (required)
No description provided.
Always set to "model_output".
ThoughtStep
A thought step.
signature
string
 (optional)
A signature hash for backend validation.
summary
ThoughtSummaryContent
 (optional)
A summary of the thought.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
annotations
Annotation
 (optional)
Citation information for model-generated content.
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
title
string
 (optional)
The title of the URL.
type
object
 (required)
No description provided.
Always set to "url_citation".
url
string
 (optional)
The URL.
FileCitation
A file citation annotation.
custom_metadata
object
 (optional)
User provided metadata about the retrieved context.
document_uri
string
 (optional)
The URI of the file.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
file_name
string
 (optional)
The name of the file.
media_id
string
 (optional)
Media ID in-case of image citations, if applicable.
page_number
integer
 (optional)
Page number of the cited document, if applicable.
source
string
 (optional)
Source attributed for a portion of the text.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "file_citation".
PlaceCitation
A place citation annotation.
end_index
integer
 (optional)
End of the attributed segment, exclusive.
name
string
 (optional)
Title of the place.
place_id
string
 (optional)
The ID of the place, in `places/{place_id}` format.
review_snippets
ReviewSnippet
 (optional)
Snippets of reviews that are used to generate answers about the
features of a given place in Google Maps.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
start_index
integer
 (optional)
Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
type
object
 (required)
No description provided.
Always set to "place_citation".
url
string
 (optional)
URI reference of the place.
text
string
 (required)
Required. The text content.
type
object
 (required)
No description provided.
Always set to "text".
ImageContent
An image content block.
data
string
 (optional)
The image content.
mime_type
enum (string)
 (optional)
The mime type of the image.
Possible
values:
image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format
resolution
MediaResolution
 (optional)
The resolution of the media.
Possible values
low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.
type
object
 (required)
No description provided.
Always set to "image".
uri
string
 (optional)
The URI of the image.
type
object
 (required)
No description provided.
Always set to "thought".
FunctionCallStep
A function tool call step.
arguments
object
 (required)
Required. The arguments to pass to the function.
id
string
 (required)
Required. A unique ID for this specific tool call.
name
string
 (required)
Required. The name of the tool to call.
type
object
 (required)
No description provided.
Always set to "function_call".
CodeExecutionCallStep
Code execution call step.
arguments
CodeExecutionCallStepArguments
 (required)
Required. The arguments to pass to the code execution.
The arguments to pass to the code execution.
Fields
code
string
 (optional)
The code to be executed.
language
enum (string)
 (optional)
Programming language of the `code`.
Possible
values:
python
Python = 3.10, with numpy and simpy available.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "code_execution_call".
UrlContextCallStep
URL context call step.
arguments
UrlContextCallArguments
 (required)
Required. The arguments to pass to the URL context.
The arguments to pass to the URL context.
Fields
urls
array (string)
 (optional)
The URLs to fetch.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "url_context_call".
McpServerToolCallStep
MCPServer tool call step.
arguments
object
 (required)
Required. The JSON object of arguments for the function.
id
string
 (required)
Required. A unique ID for this specific tool call.
name
string
 (required)
Required. The name of the tool which was called.
server_name
string
 (required)
Required. The name of the used MCP server.
type
object
 (required)
No description provided.
Always set to "mcp_server_tool_call".
GoogleSearchCallStep
Google Search call step.
arguments
GoogleSearchCallStepArguments
 (required)
Required. The arguments to pass to Google Search.
The arguments to pass to Google Search.
Fields
queries
array (string)
 (optional)
Web search queries for the following-up web search.
id
string
 (required)
Required. A unique ID for this specific tool call.
search_type
enum (string)
 (optional)
The type of search grounding enabled.
Possible
values:
web_search
Setting this field enables web search. Only text results are returned.
image_search
Setting this field enables image search. Image bytes are returned.
enterprise_web_search
Setting this field enables enterprise web search.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_search_call".
FileSearchCallStep
File Search call step.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "file_search_call".
GoogleMapsCallStep
Google Maps call step.
arguments
GoogleMapsCallStepArguments
 (optional)
The arguments to pass to the Google Maps tool.
The arguments to pass to the Google Maps tool.
Fields
queries
array (string)
 (optional)
The queries to be executed.
id
string
 (required)
Required. A unique ID for this specific tool call.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_maps_call".
FunctionResultStep
Result of a function tool call.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the tool call resulted in an error.
name
string
 (optional)
The name of the tool that was called.
result
array (ImageContent or TextContent) or object or string
 (required)
The result of the tool call.
type
object
 (required)
No description provided.
Always set to "function_result".
CodeExecutionResultStep
Code execution result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the code execution resulted in an error.
result
string
 (required)
Required. The output of the code execution.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "code_execution_result".
UrlContextResultStep
URL context result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the URL context resulted in an error.
result
UrlContextResult
 (required)
Required. The results of the URL context.
The result of the URL context.
Fields
status
enum (string)
 (optional)
The status of the URL retrieval.
Possible
values:
success
Url retrieval is successful.
error
Url retrieval is failed due to error.
paywall
Url retrieval is failed because the content is behind paywall.
unsafe
Url retrieval is failed because the content is unsafe.
url
string
 (optional)
The URL that was fetched.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "url_context_result".
GoogleSearchResultStep
Google Search result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
is_error
boolean
 (optional)
Whether the Google Search resulted in an error.
result
GoogleSearchResultItem
 (required)
Required. The results of the Google Search.
The result of the Google Search.
Fields
search_suggestions
string
 (optional)
Web content snippet that can be embedded in a web page or an app webview.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_search_result".
McpServerToolResultStep
MCPServer tool result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
name
string
 (optional)
Name of the tool which is called for this specific tool call.
result
array (ImageContent or TextContent) or object or string
 (required)
The output from the MCP server call. Can be simple text or rich content.
server_name
string
 (optional)
The name of the used MCP server.
type
object
 (required)
No description provided.
Always set to "mcp_server_tool_result".
FileSearchResultStep
File Search result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "file_search_result".
GoogleMapsResultStep
Google Maps result step.
call_id
string
 (required)
Required. ID to match the ID from the function call block.
result
GoogleMapsResultItem
 (required)
No description provided.
The result of the Google Maps.
Fields
places
GoogleMapsResultPlaces
 (optional)
No description provided.
Fields
name
string
 (optional)
No description provided.
place_id
string
 (optional)
No description provided.
review_snippets
ReviewSnippet
 (optional)
No description provided.
Encapsulates a snippet of a user review that answers a question about
the features of a specific place in Google Maps.
Fields
review_id
string
 (optional)
The ID of the review snippet.
title
string
 (optional)
Title of the review.
url
string
 (optional)
A link that corresponds to the user review on Google Maps.
url
string
 (optional)
No description provided.
widget_context_token
string
 (optional)
No description provided.
signature
string
 (optional)
A signature hash for backend validation.
type
object
 (required)
No description provided.
Always set to "google_maps_result".
system_instruction
string
 (optional)
System instruction for the interaction.
tools
Tool
 (optional)
A list of tool declarations the model may call during interaction.
A tool that can be used by the model.
Possible Types
Polymorphic discriminator: type
Function
A tool that can be used by the model.
description
string
 (optional)
A description of the function.
name
string
 (optional)
The name of the function.
parameters
object
 (optional)
The JSON Schema for the function's parameters.
type
object
 (required)
No description provided.
Always set to "function".
CodeExecution
A tool that can be used by the model to execute code.
type
object
 (required)
No description provided.
Always set to "code_execution".
UrlContext
A tool that can be used by the model to fetch URL context.
type
object
 (required)
No description provided.
Always set to "url_context".
ComputerUse
A tool that can be used by the model to interact with the computer.
disabled_safety_policies
array (enum (string))
 (optional)
Optional. Disabled safety policies for computer use.
Possible
values:
financial_transactions
Safety policy for financial transactions.
sensitive_data_modification
Safety policy for sensitive data modification.
communication_tool
Safety policy for communication tools (e.g. Gmail, Chat, Meet).
account_creation
Safety policy for account creation.
data_modification
Safety policy for data modification.
user_consent_management
Safety policy for user consent management.
legal_terms_and_agreements
Safety policy for legal terms and agreements.
enable_prompt_injection_detection
boolean
 (optional)
Whether enable the prompt injection detection check on computer-use
request.
environment
enum (string)
 (optional)
The environment being operated.
Possible
values:
browser
Operates in a web browser.
mobile
Operates in a mobile environment.
desktop
Operates in a desktop environment.
excluded_predefined_functions
array (string)
 (optional)
The list of predefined functions that are excluded from the model call.
type
object
 (required)
No description provided.
Always set to "computer_use".
McpServer
A MCPServer is a server that can be called by the model to perform actions.
allowed_tools
AllowedTools
 (optional)
The allowed tools.
The configuration for allowed tools.
Fields
mode
enum (string)
 (optional)
The mode of the tool choice.
Possible
values:
auto
Auto tool choice.
any
Any tool choice.
none
No tool choice.
validated
Validated tool choice.
tools
array (string)
 (optional)
The names of the allowed tools.
headers
object
 (optional)
Optional: Fields for authentication headers, timeouts, etc., if needed.
name
string
 (optional)
The name of the MCPServer.
type
object
 (required)
No description provided.
Always set to "mcp_server".
url
string
 (optional)
The full URL for the MCPServer endpoint.
Example: "https://api.example.com/mcp"
GoogleSearch
A tool that can be used by the model to search Google.
search_types
array (enum (string))
 (optional)
The types of search grounding to enable.
Possible
values:
web_search
Setting this field enables web search. Only text results are returned.
image_search
Setting this field enables image search. Image bytes are returned.
enterprise_web_search
Setting this field enables enterprise web search.
type
object
 (required)
No description provided.
Always set to "google_search".
FileSearch
A tool that can be used by the model to search files.
file_search_store_names
array (string)
 (optional)
The file search store names to search.
metadata_filter
string
 (optional)
Metadata filter to apply to the semantic retrieval documents and chunks.
top_k
integer
 (optional)
The number of semantic retrieval chunks to retrieve.
type
object
 (required)
No description provided.
Always set to "file_search".
GoogleMaps
A tool that can be used by the model to call Google Maps.
enable_widget
boolean
 (optional)
Whether to return a widget context token in the tool call result of the
response.
latitude
number
 (optional)
The latitude of the user's location.
longitude
number
 (optional)
The longitude of the user's location.
type
object
 (required)
No description provided.
Always set to "google_maps".
Retrieval
A tool that can be used by the model to retrieve files.
exa_ai_search_config
ExaAISearchConfig
 (optional)
Used to specify configuration for ExaAISearch.
Used to specify configuration for ExaAISearch.
Fields
api_key
string
 (optional)
Required. The API key for ExaAiSearch.
custom_config
object
 (optional)
Optional. This field can be used to pass any parameter from the Exa.ai Search API.
parallel_ai_search_config
ParallelAISearchConfig
 (optional)
Used to specify configuration for ParallelAISearch.
Used to specify configuration for ParallelAISearch.
Fields
api_key
string
 (optional)
Optional. The API key for ParallelAiSearch.
custom_config
object
 (optional)
Optional. Custom configs for ParallelAiSearch.
rag_store_config
RagStoreConfig
 (optional)
Used to specify configuration for RagStore.
Use to specify configuration for RAG Store.
Fields
rag_resources
RagResource
 (optional)
Optional. The representation of the rag source.
The definition of the Rag resource.
Fields
rag_corpus
string
 (optional)
Optional. RagCorpora resource name.
rag_file_ids
array (string)
 (optional)
Optional. rag_file_id. The files should be in the same rag_corpus set in
rag_corpus field.
rag_retrieval_config
RagRetrievalConfig
 (optional)
Optional. The retrieval config for the Rag query.
Specifies the context retrieval config.
Fields
filter
Filter
 (optional)
Optional. Config for filters.
Config for filters.
Fields
metadata_filter
string
 (optional)
Optional. String for metadata filtering.
vector_distance_threshold
number
 (optional)
Optional. Only returns contexts with vector distance smaller than the
threshold.
vector_similarity_threshold
number
 (optional)
Optional. Only returns contexts with vector similarity larger than the
threshold.
hybrid_search
HybridSearch
 (optional)
Optional. Config for Hybrid Search.
Config for Hybrid Search.
Fields
alpha
number
 (optional)
Optional. Alpha value controls the weight between dense and sparse vector search
results.
ranking
Ranking
 (optional)
Optional. Config for ranking and reranking.
Config for ranking and reranking.
top_k
integer
 (optional)
Optional. The number of contexts to retrieve.
retrieval_types
array (enum (string))
 (optional)
The types of file retrieval to enable.
Possible
values:
rag_store
exa_ai_search
parallel_ai_search
type
object
 (required)
No description provided.
Always set to "retrieval".
updated
string
 (optional)
Output only. The time at which the response was last updated in ISO 8601 format
(YYYY-MM-DDThh:mm:ssZ).
usage
Usage
 (optional)
Output only. Statistics on the interaction request's token usage.
Statistics on the interaction request's token usage.
Fields
cached_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of cached token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
grounding_tool_count
GroundingToolCount
 (optional)
Grounding tool count.
The number of grounding tool counts.
Fields
count
integer
 (optional)
The number of grounding tool counts.
type
enum (string)
 (optional)
The grounding tool type associated with the count.
Possible
values:
google_search
Grounding with Google Web Search and Image Search, & Web Grounding
for Enterprise.
google_maps
Grounding with Google Maps.
retrieval
Grounding with customer's data, for example, VertexAISearch.
input_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of input token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
output_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of output token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
tool_use_tokens_by_modality
ModalityTokens
 (optional)
A breakdown of tool-use token usage by modality.
The token count for a single response modality.
Fields
modality
ResponseModality
 (optional)
The modality associated with the token count.
Possible values
text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.
tokens
integer
 (optional)
Number of tokens for the modality.
total_cached_tokens
integer
 (optional)
Number of tokens in the cached part of the prompt (the cached content).
total_input_tokens
integer
 (optional)
Number of tokens in the prompt (context).
total_output_tokens
integer
 (optional)
Total number of tokens across all the generated responses.
total_thought_tokens
integer
 (optional)
Number of tokens of thoughts for thinking models.
total_tokens
integer
 (optional)
Total token count for the interaction request (prompt + responses + other
internal tokens).
total_tool_use_tokens
integer
 (optional)
Number of tokens present in tool-use prompt(s).
webhook_config
WebhookConfig
 (optional)
Optional. Webhook configuration for receiving notifications when the
interaction completes.
Message for configuring webhook events for a request.
Fields
uris
array (string)
 (optional)
Optional. If set, these webhook URIs will be used for webhook events instead of the
registered webhooks.
user_metadata
object
 (optional)
Optional. The user metadata that will be returned on each event emission to the
webhooks.
last_pause_time
string
 (optional)
Output only. The time when the trigger was last paused.
last_resume_time
string
 (optional)
Output only. The time when the trigger was last resumed.
last_run_time
string
 (optional)
Output only. The time when the trigger was last run.
max_consecutive_failures
integer
 (optional)
Optional. The maximum number of consecutive failures allowed before
the trigger is automatically paused (status becomes ERROR).
next_run_time
string
 (optional)
Output only. The time when the trigger is scheduled to run next.
previous_interaction_id
string
 (optional)
Output only. The ID of the last interaction created by this trigger.
schedule
string
 (optional)
Required. The cron schedule on which the trigger should run.
Standard cron format.
status
enum (string)
 (optional)
Output only. The current status of the trigger.
Possible
values:
active
The trigger is active and will fire on schedule.
paused
The trigger is paused and will not fire.
error
The trigger has entered an error state due to consecutive failures.
time_zone
string
 (optional)
Required. Time zone in which the schedule should be interpreted.
update_time
string
 (optional)
Output only. The time when the trigger was last updated.
TriggerExecution
An execution instance of a trigger.
Fields
end_time
string
 (optional)
Output only. The time when the execution finished.
environment_id
string
 (optional)
Output only. The environment ID used for the execution.
error
string
 (optional)
Output only. The error message if the execution failed.
id
string
 (optional)
Required. Output only. Identifier. The ID of the trigger execution.
interaction_id
string
 (optional)
Output only. The ID of the interaction created by this execution, if any.
scheduled_time
string
 (optional)
Output only. The time when the execution was scheduled to run.
start_time
string
 (optional)
Output only. The time when the execution started.
status
enum (string)
 (optional)
Output only. The status of the execution.
Possible
values:
in_progress
The execution is currently in progress.
completed
The execution completed successfully.
failed
The execution failed.
skipped
The execution was skipped (e.g., previous execution still running).
timed_out
The execution timed out.
trigger_id
string
 (optional)
Required. Output only. Identifier. The ID of the trigger that created this execution.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-07-16 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-07-16 UTC."],[],[]]
Terms
Privacy
Manage cookies
English
Deutsch
Español – América Latina
Français
Indonesia
Italiano
Polski
Português – Brasil
Shqip
Tiếng Việt
Türkçe
Русский
עברית
العربيّة
فارسی
हिंदी
বাংলা
ภาษาไทย
中文 – 简体
中文 – 繁體
日本語
한국어