> ## Documentation Index
> Fetch the complete documentation index at: https://gccai.heqingsong.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# API multimodal OpenAI Responses

>  - Totalmente compatível com o formato da API OpenAI Responses
- Suporta entrada multimodal com texto e imagens
- Suporta extensões de ferramentas: pesquisa na web, pesquisa em arquivos, function calling, MCP remoto 

<RequestExample>
  ```bash cURL theme={null}
  curl https://gccai.heqingsong.uk/v1/responses \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>" \
    -d '{
      "model": "gpt-5.2-pro",
      "input": [
        {
          "role": "user",
          "content": [
            {
              "type": "input_text",
              "text": "What is in this image?"
            },
            {
              "type": "input_image",
              "image_url": "https://openai-documentation.vercel.app/images/cat_and_otter.png"
            }
          ]
        }
      ]
    }'
  ```

  ```python Python theme={null}
  import requests
  import os

  url = "https://gccai.heqingsong.uk/v1/responses"

  payload = {
      "model": "gpt-5.2-pro",
      "input": [
          {
              "role": "user",
              "content": [
                  {
                      "type": "input_text",
                      "text": "What is in this image?"
                  },
                  {
                      "type": "input_image",
                      "image_url": "https://openai-documentation.vercel.app/images/cat_and_otter.png"
                  }
              ]
          }
      ]
  }

  headers = {
      "Authorization": f"Bearer {os.environ.get('OPENAI_API_KEY')}",
      "Content-Type": "application/json"
  }

  response = requests.post(url, json=payload, headers=headers)

  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const url = "https://gccai.heqingsong.uk/v1/responses";

  const payload = {
    model: "gpt-5.2-pro",
    input: [
      {
        role: "user",
        content: [
          {
            type: "input_text",
            text: "What is in this image?"
          },
          {
            type: "input_image",
            image_url: "https://openai-documentation.vercel.app/images/cat_and_otter.png"
          }
        ]
      }
    ]
  };

  const headers = {
    "Authorization": `Bearer ${process.env.OPENAI_API_KEY}`,
    "Content-Type": "application/json"
  };

  fetch(url, {
    method: "POST",
    headers: headers,
    body: JSON.stringify(payload)
  })
    .then(response => response.json())
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
  ```

  ```go Go theme={null}
  package main

  import (
      "bytes"
      "encoding/json"
      "fmt"
      "io/ioutil"
      "net/http"
      "os"
  )

  func main() {
      url := "https://gccai.heqingsong.uk/v1/responses"

      payload := map[string]interface{}{
          "model": "gpt-5.2-pro",
          "input": []map[string]interface{}{
              {
                  "role": "user",
                  "content": []map[string]string{
                      {
                          "type": "input_text",
                          "text": "What is in this image?",
                      },
                      {
                          "type":      "input_image",
                          "image_url": "https://openai-documentation.vercel.app/images/cat_and_otter.png",
                      },
                  },
              },
          },
      }

      jsonData, _ := json.Marshal(payload)

      req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
      req.Header.Set("Authorization", "Bearer "+os.Getenv("OPENAI_API_KEY"))
      req.Header.Set("Content-Type", "application/json")

      client := &http.Client{}
      resp, err := client.Do(req)
      if err != nil {
          panic(err)
      }
      defer resp.Body.Close()

      body, _ := ioutil.ReadAll(resp.Body)
      fmt.Println(string(body))
  }
  ```

  ```java Java theme={null}
  import java.net.http.HttpClient;
  import java.net.http.HttpRequest;
  import java.net.http.HttpResponse;
  import java.net.URI;

  public class Main {
      public static void main(String[] args) throws Exception {
          String url = "https://gccai.heqingsong.uk/v1/responses";
          String apiKey = System.getenv("OPENAI_API_KEY");

          String payload = """
          {
            "model": "gpt-5.2-pro",
            "input": [
              {
                "role": "user",
                "content": [
                  {
                    "type": "input_text",
                    "text": "What is in this image?"
                  },
                  {
                    "type": "input_image",
                    "image_url": "https://openai-documentation.vercel.app/images/cat_and_otter.png"
                  }
                ]
              }
            ]
          }
          """;

          HttpClient client = HttpClient.newHttpClient();
          HttpRequest request = HttpRequest.newBuilder()
              .uri(URI.create(url))
              .header("Authorization", "Bearer " + apiKey)
              .header("Content-Type", "application/json")
              .POST(HttpRequest.BodyPublishers.ofString(payload))
              .build();

          HttpResponse<String> response = client.send(request,
              HttpResponse.BodyHandlers.ofString());

          System.out.println(response.body());
      }
  }
  ```

  ```php PHP theme={null}
  <?php

  $url = "https://gccai.heqingsong.uk/v1/responses";
  $apiKey = getenv('OPENAI_API_KEY');

  $payload = [
      "model" => "gpt-5.2-pro",
      "input" => [
          [
              "role" => "user",
              "content" => [
                  [
                      "type" => "input_text",
                      "text" => "What is in this image?"
                  ],
                  [
                      "type" => "input_image",
                      "image_url" => "https://openai-documentation.vercel.app/images/cat_and_otter.png"
                  ]
              ]
          ]
      ]
  ];

  $ch = curl_init($url);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_POST, true);
  curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      "Authorization: Bearer " . $apiKey,
      "Content-Type: application/json"
  ]);

  $response = curl_exec($ch);
  curl_close($ch);

  echo $response;
  ?>
  ```

  ```ruby Ruby theme={null}
  require 'net/http'
  require 'json'
  require 'uri'

  url = URI("https://gccai.heqingsong.uk/v1/responses")
  api_key = ENV['OPENAI_API_KEY']

  payload = {
    model: "gpt-5.2-pro",
    input: [
      {
        role: "user",
        content: [
          {
            type: "input_text",
            text: "What is in this image?"
          },
          {
            type: "input_image",
            image_url: "https://openai-documentation.vercel.app/images/cat_and_otter.png"
          }
        ]
      }
    ]
  }

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true

  request = Net::HTTP::Post.new(url)
  request["Authorization"] = "Bearer #{api_key}"
  request["Content-Type"] = "application/json"
  request.body = payload.to_json

  response = http.request(request)
  puts response.body
  ```

  ```swift Swift theme={null}
  import Foundation

  let url = URL(string: "https://gccai.heqingsong.uk/v1/responses")!
  let apiKey = ProcessInfo.processInfo.environment["OPENAI_API_KEY"] ?? ""

  let payload: [String: Any] = [
      "model": "gpt-5.2-pro",
      "input": [
          [
              "role": "user",
              "content": [
                  [
                      "type": "input_text",
                      "text": "What is in this image?"
                  ],
                  [
                      "type": "input_image",
                      "image_url": "https://openai-documentation.vercel.app/images/cat_and_otter.png"
                  ]
              ]
          ]
      ]
  ]

  var request = URLRequest(url: url)
  request.httpMethod = "POST"
  request.setValue("Bearer \(apiKey)", forHTTPHeaderField: "Authorization")
  request.setValue("application/json", forHTTPHeaderField: "Content-Type")
  request.httpBody = try? JSONSerialization.data(withJSONObject: payload)

  let task = URLSession.shared.dataTask(with: request) { data, response, error in
      if let error = error {
          print("Error: \(error)")
          return
      }

      if let data = data, let responseString = String(data: data, encoding: .utf8) {
          print(responseString)
      }
  }

  task.resume()
  ```

  ```csharp C# theme={null}
  using System;
  using System.Net.Http;
  using System.Text;
  using System.Threading.Tasks;

  class Program
  {
      static async Task Main(string[] args)
      {
          var url = "https://gccai.heqingsong.uk/v1/responses";
          var apiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY");

          var payload = @"{
              ""model"": ""gpt-5.2-pro"",
              ""input"": [
                  {
                      ""role"": ""user"",
                      ""content"": [
                          {
                              ""type"": ""input_text"",
                              ""text"": ""What is in this image?""
                          },
                          {
                              ""type"": ""input_image"",
                              ""image_url"": ""https://openai-documentation.vercel.app/images/cat_and_otter.png""
                          }
                      ]
                  }
              ]
          }";

          using var client = new HttpClient();
          client.DefaultRequestHeaders.Add("Authorization", $"Bearer {apiKey}");

          var content = new StringContent(payload, Encoding.UTF8, "application/json");
          var response = await client.PostAsync(url, content);
          var result = await response.Content.ReadAsStringAsync();

          Console.WriteLine(result);
      }
  }
  ```

  ```c C theme={null}
  #include <stdio.h>
  #include <curl/curl.h>
  #include <stdlib.h>

  int main(void) {
      CURL *curl;
      CURLcode res;
      const char *api_key = getenv("OPENAI_API_KEY");

      curl_global_init(CURL_GLOBAL_DEFAULT);
      curl = curl_easy_init();

      if(curl) {
          const char *url = "https://gccai.heqingsong.uk/v1/responses";
          const char *payload = "{"
              "\"model\":\"gpt-5.2-pro\","
              "\"input\":[{\"role\":\"user\",\"content\":[{\"type\":\"input_text\",\"text\":\"What is in this image?\"},{\"type\":\"input_image\",\"image_url\":\"https://openai-documentation.vercel.app/images/cat_and_otter.png\"}]}]"
          "}";

          char auth_header[256];
          snprintf(auth_header, sizeof(auth_header), "Authorization: Bearer %s", api_key);

          struct curl_slist *headers = NULL;
          headers = curl_slist_append(headers, auth_header);
          headers = curl_slist_append(headers, "Content-Type: application/json");

          curl_easy_setopt(curl, CURLOPT_URL, url);
          curl_easy_setopt(curl, CURLOPT_POSTFIELDS, payload);
          curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);

          res = curl_easy_perform(curl);

          if(res != CURLE_OK) {
              fprintf(stderr, "curl_easy_perform() failed: %s\n",
                      curl_easy_strerror(res));
          }

          curl_slist_free_all(headers);
          curl_easy_cleanup(curl);
      }

      curl_global_cleanup();
      return 0;
  }
  ```

  ```objectivec Objective-C theme={null}
  #import <Foundation/Foundation.h>

  int main(int argc, const char * argv[]) {
      @autoreleasepool {
          NSURL *url = [NSURL URLWithString:@"https://gccai.heqingsong.uk/v1/responses"];
          NSString *apiKey = [NSProcessInfo processInfo].environment[@"OPENAI_API_KEY"];

          NSDictionary *payload = @{
              @"model": @"gpt-5.2-pro",
              @"input": @[
                  @{
                      @"role": @"user",
                      @"content": @[
                          @{
                              @"type": @"input_text",
                              @"text": @"What is in this image?"
                          },
                          @{
                              @"type": @"input_image",
                              @"image_url": @"https://openai-documentation.vercel.app/images/cat_and_otter.png"
                          }
                      ]
                  }
              ]
          };

          NSError *error;
          NSData *jsonData = [NSJSONSerialization dataWithJSONObject:payload
                                                            options:0
                                                              error:&error];

          NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
          [request setHTTPMethod:@"POST"];
          [request setValue:[NSString stringWithFormat:@"Bearer %@", apiKey]
              forHTTPHeaderField:@"Authorization"];
          [request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
          [request setHTTPBody:jsonData];

          NSURLSessionDataTask *task = [[NSURLSession sharedSession]
              dataTaskWithRequest:request
              completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
                  if (error) {
                      NSLog(@"Error: %@", error);
                      return;
                  }
                  NSString *result = [[NSString alloc] initWithData:data
                                                          encoding:NSUTF8StringEncoding];
                  NSLog(@"%@", result);
              }];

          [task resume];
          [[NSRunLoop mainRunLoop] run];
      }
      return 0;
  }
  ```

  ```ocaml OCaml theme={null}
  (* Requires cohttp and yojson libraries *)
  open Lwt
  open Cohttp
  open Cohttp_lwt_unix

  let url = "https://gccai.heqingsong.uk/v1/responses"
  let api_key = Sys.getenv "OPENAI_API_KEY"

  let payload = {|{
    "model": "gpt-5.2-pro",
    "input": [
      {
        "role": "user",
        "content": [
          {
            "type": "input_text",
            "text": "What is in this image?"
          },
          {
            "type": "input_image",
            "image_url": "https://openai-documentation.vercel.app/images/cat_and_otter.png"
          }
        ]
      }
    ]
  }|}

  let () =
    let headers = Header.init ()
      |> fun h -> Header.add h "Authorization" ("Bearer " ^ api_key)
      |> fun h -> Header.add h "Content-Type" "application/json"
    in
    let body = Cohttp_lwt.Body.of_string payload in

    let response = Client.post ~headers ~body (Uri.of_string url) >>= fun (resp, body) ->
      body |> Cohttp_lwt.Body.to_string >|= fun body_str ->
      print_endline body_str
    in
    Lwt_main.run response
  ```

  ```dart Dart theme={null}
  import 'dart:convert';
  import 'dart:io';
  import 'package:http/http.dart' as http;

  void main() async {
    final url = Uri.parse('https://gccai.heqingsong.uk/v1/responses');
    final apiKey = Platform.environment['OPENAI_API_KEY'];

    final payload = {
      'model': 'gpt-5.2-pro',
      'input': [
        {
          'role': 'user',
          'content': [
            {
              'type': 'input_text',
              'text': 'What is in this image?'
            },
            {
              'type': 'input_image',
              'image_url': 'https://openai-documentation.vercel.app/images/cat_and_otter.png'
            }
          ]
        }
      ]
    };

    final response = await http.post(
      url,
      headers: {
        'Authorization': 'Bearer $apiKey',
        'Content-Type': 'application/json',
      },
      body: jsonEncode(payload),
    );

    print(response.body);
  }
  ```

  ```r R theme={null}
  library(httr)
  library(jsonlite)

  url <- "https://gccai.heqingsong.uk/v1/responses"
  api_key <- Sys.getenv("OPENAI_API_KEY")

  payload <- list(
    model = "gpt-5.2-pro",
    input = list(
      list(
        role = "user",
        content = list(
          list(
            type = "input_text",
            text = "What is in this image?"
          ),
          list(
            type = "input_image",
            image_url = "https://openai-documentation.vercel.app/images/cat_and_otter.png"
          )
        )
      )
    )
  )

  response <- POST(
    url,
    add_headers(
      Authorization = paste("Bearer", api_key),
      `Content-Type` = "application/json"
    ),
    body = toJSON(payload, auto_unbox = TRUE),
    encode = "raw"
  )

  cat(content(response, "text"))
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "code": 200,
    "data": {
      "id": "resp-9876543210",
      "object": "response",
      "created": 1677652288,
      "model": "gpt-5.2-pro",
      "choices": [
        {
          "index": 0,
          "message": {
            "role": "assistant",
            "content": "This image shows a cat and an otter. They appear to be interacting with each other in a very cute and heartwarming scene. The cat and otter seem to be getting along well."
          },
          "finish_reason": "stop"
        }
      ],
      "usage": {
        "prompt_tokens": 156,
        "completion_tokens": 45,
        "total_tokens": 201
      }
    }
  }
  ```

  ```json 400 theme={null}
  {
    "error": {
      "code": 400,
      "message": "Invalid request parameters",
      "type": "invalid_request_error"
    }
  }
  ```

  ```json 401 theme={null}
  {
    "error": {
      "code": 401,
      "message": "Authentication failed, please check your API key",
      "type": "authentication_error"
    }
  }
  ```

  ```json 402 theme={null}
  {
    "error": {
      "code": 402,
      "message": "Insufficient account balance, please top up and try again",
      "type": "payment_required"
    }
  }
  ```

  ```json 403 theme={null}
  {
    "error": {
      "code": 403,
      "message": "Access forbidden, you do not have permission to access this resource",
      "type": "permission_error"
    }
  }
  ```

  ```json 429 theme={null}
  {
    "error": {
      "code": 429,
      "message": "Too many requests, please try again later",
      "type": "rate_limit_error"
    }
  }
  ```

  ```json 500 theme={null}
  {
    "error": {
      "code": 500,
      "message": "Internal server error, please try again later",
      "type": "server_error"
    }
  }
  ```

  ```json 502 theme={null}
  {
    "error": {
      "code": 502,
      "message": "Gateway error, server temporarily unavailable",
      "type": "bad_gateway"
    }
  }
  ```
</ResponseExample>

## Autorizações

<ParamField header="Authorization" type="string" required>
  \##Todas as APIs exigem autenticação por Bearer Token##

  Obtenha sua chave de API:

  Acesse a [página de gerenciamento de chaves de API](https://gccai.heqingsong.uk/keys) para obter sua chave de API

  Adicione-a ao cabeçalho da requisição:

  ```
  Authorization: Bearer YOUR_API_KEY
  ```
</ParamField>

## Body

<ParamField body="model" type="string" required default="gpt-5.2-pro">
  Nome do modelo

  Os modelos suportados incluem:

  * `gpt-5.2-pro`
  * `gpt-5.2-codex`
  * Mais modelos em breve...
</ParamField>

<ParamField body="input" type="array" required>
  Lista de conteúdos de entrada

  Array de entrada; cada item contém os campos `role` e `content`.

  **💡 Preenchimento rápido (área Try it):**

  1. Clique em "+ Add an item" para adicionar um item de entrada
  2. Em `role`, informe: `user` (mensagem do usuário), `assistant` (resposta da IA) ou `system` (prompt do sistema)
  3. Em `content`, adicione blocos de conteúdo (pode incluir texto e imagens)

  <Expandable title="Detalhes dos campos">
    <ParamField body="role" type="string" required default="user">
      Tipo de papel

      Opções: `user` (mensagem do usuário), `assistant` (resposta da IA, para múltiplas rodadas), `system` (prompt do sistema, para definir o comportamento da IA)
    </ParamField>

    <ParamField body="content" type="array" required>
      Array de conteúdo

      Suporta vários tipos de blocos de conteúdo, podendo incluir texto e imagens.

      <Expandable title="Tipos de blocos de conteúdo">
        <ParamField body="type" type="string" required>
          Tipo de conteúdo

          Opções:

          * `input_text`: entrada de texto
          * `input_image`: entrada de imagem
        </ParamField>

        <ParamField body="text" type="string">
          Conteúdo de texto

          Usado quando `type` é `input_text`; preencha com o conteúdo textual
        </ParamField>

        <ParamField body="image_url" type="string">
          URL da imagem

          Usado quando `type` é `input_image`; preencha com a URL da imagem ou a codificação base64

          Suporta dois formatos:

          **1. URL completa da imagem**

          * URL de imagem publicamente acessível (http\:// ou https\://)
          * Exemplo: `https://example.com/image.jpg`

          **2. Formato codificado em Base64**

          * **Deve usar o formato Data URI completo**
          * Formato: `data:image/{format};base64,{base64_data}`
          * Formatos de imagem suportados: jpeg, png, gif, webp
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="temperature" type="number">
  Controla a aleatoriedade da saída, faixa 0–2

  * Valores mais baixos (por exemplo, 0.2) tornam a saída mais determinística
  * Valores mais altos (por exemplo, 1.8) tornam a saída mais aleatória

  Padrão: 1.0
</ParamField>

<ParamField body="max_tokens" type="integer">
  Número máximo de tokens a serem gerados

  Modelos diferentes possuem limites máximos distintos; consulte a documentação de cada modelo
</ParamField>

<ParamField body="stream" type="boolean">
  Se deve usar saída em streaming

  * `true`: resposta em streaming (formato SSE)
  * `false`: retorna a resposta completa de uma só vez

  Padrão: false
</ParamField>

<ParamField body="top_p" type="number">
  Parâmetro de amostragem por núcleo (nucleus sampling), faixa 0–1

  Controla a diversidade do texto gerado; recomenda-se usar este parâmetro ou temperature, não ambos

  Padrão: 1.0
</ParamField>

<ParamField body="tools" type="array">
  Lista de ferramentas para estender as capacidades do modelo

  Tipos de ferramentas suportadas:

  * **Web Search** (`web_search`): pesquisa em tempo real na internet
  * **File Search** (`file_search`): pesquisa no conteúdo de arquivos enviados
  * **Function Calling** (`function`): chamada de funções personalizadas
  * **Remote MCP** (`remote_mcp`): conexão a serviços remotos do Model Context Protocol

  Exemplo: `[{"type": "web_search"}]`
</ParamField>

## Resposta

<ResponseField name="id" type="string">
  Identificador único da resposta
</ResponseField>

<ResponseField name="object" type="string">
  Tipo do objeto, fixado em `response`
</ResponseField>

<ResponseField name="created" type="integer">
  Timestamp de criação
</ResponseField>

<ResponseField name="model" type="string">
  Nome do modelo efetivamente utilizado
</ResponseField>

<ResponseField name="choices" type="array">
  Lista de respostas geradas

  <Expandable title="Propriedades">
    <ResponseField name="index" type="integer">
      Índice da escolha
    </ResponseField>

    <ResponseField name="message" type="object">
      Conteúdo da mensagem

      <Expandable title="Propriedades">
        <ResponseField name="role" type="string">
          Tipo de papel (assistant)
        </ResponseField>

        <ResponseField name="content" type="string">
          Conteúdo textual gerado
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="finish_reason" type="string">
      Motivo da conclusão

      Valores possíveis:

      * `stop` - conclusão natural
      * `length` - comprimento máximo atingido
      * `content_filter` - filtragem de conteúdo
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="usage" type="object">
  Estatísticas de uso de tokens

  <Expandable title="Propriedades">
    <ResponseField name="prompt_tokens" type="integer">
      Número de tokens na entrada
    </ResponseField>

    <ResponseField name="completion_tokens" type="integer">
      Número de tokens na saída
    </ResponseField>

    <ResponseField name="total_tokens" type="integer">
      Número total de tokens
    </ResponseField>
  </Expandable>
</ResponseField>

## Exemplos de uso

### Entrada apenas de texto

```json theme={null}
{
  "model": "gpt-5.2-pro",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Hello, introduce artificial intelligence"
        }
      ]
    }
  ]
}
```

### Usando a ferramenta Web Search

```json theme={null}
{
  "model": "gpt-5.2-pro",
  "tools": [{"type": "web_search"}],
  "input": "What positive news is there today?"
}
```

```bash cURL Example theme={null}
curl "https://gccai.heqingsong.uk/v1/responses" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>" \
    -d '{
        "model": "gpt-5.2-pro",
        "tools": [{"type": "web_search"}],
        "input": "What positive news is there today?"
    }'
```

### Compreensão de imagem

```json theme={null}
{
  "model": "gpt-5.2-pro",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Describe this image"
        },
        {
          "type": "input_image",
          "image_url": "https://example.com/image.jpg"
        }
      ]
    }
  ]
}
```

### Análise de múltiplas imagens

```json theme={null}
{
  "model": "gpt-5.2-pro",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Compare the similarities and differences of these two images"
        },
        {
          "type": "input_image",
          "image_url": "https://example.com/image1.jpg"
        },
        {
          "type": "input_image",
          "image_url": "https://example.com/image2.jpg"
        }
      ]
    }
  ]
}
```

### Imagem codificada em Base64

```json theme={null}
{
  "model": "gpt-5.2-pro",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Analyze this image"
        },
        {
          "type": "input_image",
          "image_url": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
        }
      ]
    }
  ]
}
```

### Usando a ferramenta File Search

```json theme={null}
{
  "model": "gpt-5.2-pro",
  "tools": [{"type": "file_search"}],
  "input": "Based on uploaded documents, summarize the company's quarterly performance"
}
```

### Usando Function Calling

```json theme={null}
{
  "model": "gpt-5.2-pro",
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "get_weather",
        "description": "Get weather information for a specified city",
        "parameters": {
          "type": "object",
          "properties": {
            "city": {
              "type": "string",
              "description": "City name, e.g.: Beijing"
            },
            "unit": {
              "type": "string",
              "enum": ["celsius", "fahrenheit"],
              "description": "Temperature unit"
            }
          },
          "required": ["city"]
        }
      }
    }
  ],
  "input": "What's the weather like in Beijing today?"
}
```

### Usando MCP remoto

```json theme={null}
{
  "model": "gpt-5.2-pro",
  "tools": [
    {
      "type": "remote_mcp",
      "remote_mcp": {
        "url": "https://mcp.example.com/api",
        "auth_token": "your_mcp_token"
      }
    }
  ],
  "input": "Query user information in the database"
}
```

### Combinando múltiplas ferramentas

```json theme={null}
{
  "model": "gpt-5.2-pro",
  "tools": [
    {"type": "web_search"},
    {"type": "file_search"},
    {
      "type": "function",
      "function": {
        "name": "calculate",
        "description": "Perform mathematical calculations",
        "parameters": {
          "type": "object",
          "properties": {
            "expression": {
              "type": "string",
              "description": "Mathematical expression"
            }
          },
          "required": ["expression"]
        }
      }
    }
  ],
  "input": "Search for the latest Bitcoin price and calculate the total value of 100 Bitcoins"
}
```

## Especificações dos tipos de conteúdo

### input\_text

Tipo de entrada de texto

**Propriedades:**

* `type`: fixado em `"input_text"`
* `text`: conteúdo de texto (string)

### input\_image

Tipo de entrada de imagem

**Propriedades:**

* `type`: fixado em `"input_image"`
* `image_url`: URL da imagem ou Data URI codificado em Base64

**Formatos de imagem suportados:**

* JPEG
* PNG
* GIF
* WebP

**Limites de tamanho da imagem:**

* Tamanho máximo do arquivo: 20 MB
* Recomendação de aspect\_ratio: não exceder 2048x2048 pixels

## Detalhes de uso das ferramentas

### Web Search

A ferramenta de pesquisa na web permite que o modelo acesse informações em tempo real na internet.

**Exemplo de configuração:**

```json theme={null}
{
  "tools": [{"type": "web_search"}]
}
```

**Casos de uso:**

* Consultar notícias e eventos mais recentes
* Obter dados em tempo real (ações, clima, taxas de câmbio, etc.)
* Pesquisar a documentação técnica mais recente
* Verificar informações factuais

### File Search

A ferramenta de pesquisa em arquivos permite que o modelo procure informações relevantes em documentos enviados.

**Exemplo de configuração:**

```json theme={null}
{
  "tools": [{"type": "file_search"}]
}
```

**Casos de uso:**

* Analisar documentos internos corporativos
* Pesquisar especificações técnicas e manuais
* Consultar contratos e documentos jurídicos
* Sistemas de perguntas e respostas em bases de conhecimento

### Function Calling

Defina funções personalizadas para permitir que o modelo chame APIs externas ou execute operações específicas.

**Exemplo completo de configuração:**

```json theme={null}
{
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "get_stock_price",
        "description": "Get real-time stock price",
        "parameters": {
          "type": "object",
          "properties": {
            "symbol": {
              "type": "string",
              "description": "Stock symbol, e.g.: AAPL"
            },
            "currency": {
              "type": "string",
              "enum": ["USD", "CNY"],
              "description": "Currency unit",
              "default": "USD"
            }
          },
          "required": ["symbol"]
        }
      }
    }
  ]
}
```

**Descrições dos parâmetros:**

* `name`: nome da função (obrigatório)
* `description`: descrição da função (obrigatória)
* `parameters`: definição dos parâmetros no formato JSON Schema
  * `type`: tipo do parâmetro
  * `properties`: definições das propriedades dos parâmetros
  * `required`: lista de parâmetros obrigatórios

**Casos de uso:**

* Chamar APIs de terceiros
* Executar consultas em banco de dados
* Disparar processos de negócio
* Integrar com sistemas internos

### Remote MCP

Conecte-se a serviços remotos do Model Context Protocol (MCP) para estender as capacidades do modelo.

**Exemplo de configuração:**

```json theme={null}
{
  "tools": [
    {
      "type": "remote_mcp",
      "remote_mcp": {
        "url": "https://your-mcp-server.com/api",
        "auth_token": "your_auth_token",
        "timeout": 30
      }
    }
  ]
}
```

**Descrições dos parâmetros:**

* `url`: endereço do servidor MCP (obrigatório)
* `auth_token`: token de autenticação (opcional)
* `timeout`: timeout em segundos, padrão 30 segundos

**Casos de uso:**

* Conectar-se a serviços de IA de nível empresarial
* Usar modelos específicos de domínio
* Acessar fontes de dados protegidas
* Integração de sistemas de IA distribuídos

## Formato de resposta de ferramentas

Quando o modelo usa ferramentas, o formato da resposta incluirá informações da chamada de ferramenta:

```json theme={null}
{
  "id": "resp-123456",
  "object": "response",
  "created": 1677652288,
  "model": "gpt-5.2-pro",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": [
          {
            "id": "call_abc123",
            "type": "function",
            "function": {
              "name": "get_weather",
              "arguments": "{\"city\": \"Beijing\"}"
            }
          }
        ]
      },
      "finish_reason": "tool_calls"
    }
  ]
}
```

**Fluxo de chamada de ferramentas:**

1. O modelo recebe a entrada do usuário
2. Analisa se as ferramentas são necessárias
3. Se necessário, retorna uma solicitação de chamada de ferramenta
4. O cliente executa a chamada da ferramenta
5. Retorna os resultados da ferramenta ao modelo
6. O modelo gera a resposta final

## Observações importantes

1. **Requisitos para URLs de imagens**:
   * Deve ser uma URL acessível publicamente
   * Ou usar o formato Data URI codificado em Base64

2. **Cobrança de tokens**:
   * As imagens consomem tokens com base em seu aspect\_ratio
   * Imagens de alto aspect\_ratio são automaticamente redimensionadas para otimizar custos
   * As chamadas de ferramentas também consomem tokens adicionais

3. **Ordem do conteúdo**:
   * A ordem dos elementos no array `content` afeta a compreensão do modelo
   * Recomenda-se colocar as instruções de texto primeiro e depois as imagens

4. **Combinações multimodais**:
   * Você pode misturar vários textos e imagens em uma única requisição
   * Suporta conversas em múltiplas rodadas com coerência de contexto

5. **Limitações de uso das ferramentas**:
   * Ao usar várias ferramentas simultaneamente, o modelo seleciona inteligentemente a mais apropriada
   * O function calling requer definições claras de funções e descrições de parâmetros
   * Os resultados da pesquisa na web podem ser limitados por região e tempo

6. **Compatibilidade com a API**:
   * Totalmente compatível com o formato da API OpenAI Responses
   * Migre seu código OpenAI existente de forma transparente
   * Suporta todos os recursos de extensão de ferramentas da OpenAI