Generate content with multimodal inputs.
Endpoint
post https:Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
model
string
Required. The fully qualified name of the publisher model or tuned model endpoint to use.
Publisher model format: projects/{project}/locations/{location}/publishers/*/models/*
Tuned model endpoint format: projects/{project}/locations/{location}/endpoints/{endpoint}
Request body
The request body contains data with the following structure:
Required. The content of the current conversation with the model.
For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
cachedContent
string
Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: projects/{project}/locations/{location}/cachedContents/{cachedContent}
Optional. A list of Tools
the model may use to generate the next response.
A Tool
is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
Optional. Tool config. This config is shared for all tools provided in the request.
labels
map (key: string, value: string)
Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only.
label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. label values are optional. label keys must start with a letter.
Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
Optional. Generation config.
Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
Example request
Grounding:Public data
Java
Node.js
Grounding:Private data
Java
Node.js
Grounding:Vais
C#
Python
Grounding:Web
C#
Python
Text
Java
Node.js
Python
Multimodal
Java
Node.js
Python
Chat
C#
Go
Java
Node.js
Python
Function calling (basic)
C#
Go
Java
Python
Function calling (advanced)
Go
Node.js
Function calling chat
Node.js
Python
Response body
If successful, the response body contains an instance of GenerateContentResponse
.