Gemini 4 Carbon (openai)

Streaming Support

When stream: true is set in the request, the API returns the response as server-sent events (SSE) with Content-Type: text/event-stream. This enables progressive delivery: message deltas are sent as they are generated. Each event contains partial message content so you can render the response in real time.

Streaming Response Format:

• Content-Type: text/event-stream
• Each event line starts with data: followed by JSON
• Events contain incremental message deltas
• The final event indicates completion via finish_reason
• The last chunk of the stream carries usage and credits_consumed, followed by data: [DONE].

Text, image, video, audio, and PDF input Google Search grounding Server-sent events Multiple message roles

Unified Media File Format

Tools Parameter

tools is an optional array that lets you define functions the model can call. The array can contain multiple objects. When using function calling, you can declare multiple functions in the array.

Define custom functions with parameters. You can declare multiple functions in the `tools` array:

[
  {
    "type": "function",
    "function": {
      "name": "get_current_weather",
      "description": "Get the current weather for a given location",
      "parameters": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "description": "City and state, for example: San Francisco, CA"
          },
          "unit": {
            "type": "string",
            "enum": ["celsius", "fahrenheit"]
          }
        },
        "required": ["location"]
      }
    }
  },
  {
    "type": "function",
    "function": {
      "name": "get_stock_price",
      "description": "Get the current price for a given stock symbol",
      "parameters": {
        "type": "object",
        "properties": {
          "symbol": {
            "type": "string",
            "description": "Stock symbol, for example: AAPL"
          }
        },
        "required": ["symbol"]
      }
    }
  }
]

Function declaration requirements

To use function calling in the prompt, create a tools array that contains one or more function declarations. Define functions with JSON (specifically, a selected subset of the OpenAPI schema format).

A single function declaration can include the following fields:

• name (string, required): Unique function name (for example, get_weather_forecast, send_email). Use a descriptive name without spaces or special characters (underscore or camelCase).

• description (string, optional but recommended): A clear, detailed explanation of what the function does. This is critical for the model to know when to call it. Be specific and provide examples when needed (for example, "Find movie theaters by location, optionally including movies currently playing.").

• parameters (object, required): Defines the input parameters the function expects. Includes:

  • type (string): Overall data type; must be "object".
  • properties (object): Lists each parameter, each with:
    • type (string): Parameter data type, such as string, integer, boolean, array.
    • description (string): Explains the purpose and format of the parameter. Provide examples and constraints (for example, "City and state, such as 'San Francisco, CA', or a ZIP code such as '95616'.").
    • enum (array, optional): If values come from a fixed set, list allowed values with enum instead of only describing them in text. This improves accuracy (for example, "enum": ["daylight", "cool", "warm"]).
  • required (array): An array of strings listing parameter names required for the function to run.

Error Responses

Errors are returned with HTTP 200 and a JSON body {"code": , "msg": ""}. Check code (200 = success) before reading choices/candidates.