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

# Create a response

Cria uma resposta em streaming ou não-streaming usando o formato da API OpenAI Responses.

## Autenticação

<ParamField header="Authorization" type="string" required>
  Token Bearer. Use sua chave de API como token Bearer no cabeçalho Authorization.

  Formato: `Bearer <SUNRA_KEY>`
</ParamField>

## Requisição

Este endpoint espera um objeto.

<ParamField body="model" type="string" required>
  ID do modelo usado para gerar a resposta. Navegue pelos modelos disponíveis em [sunra.ai/models](https://sunra.ai/models).
</ParamField>

<ParamField body="input" type="string | object[]">
  Entrada para a requisição de resposta. Pode ser uma string ou um array de itens de entrada.

  <Expandable title="propriedades (para array)">
    <ParamField body="type" type="string">
      O tipo de item de entrada. Valores suportados: `message`, `item_reference`.
    </ParamField>

    <ParamField body="role" type="string">
      O papel do autor da mensagem. Valores suportados: `user`, `assistant`, `system`.
    </ParamField>

    <ParamField body="content" type="string | object[]">
      O conteúdo da mensagem de entrada. Pode ser uma string ou um array de partes de conteúdo.
    </ParamField>

    <ParamField body="id" type="string">
      O ID do item. Obrigatório para mensagens `assistant` no histórico de conversa.
    </ParamField>

    <ParamField body="status" type="string">
      O status do item. Obrigatório para mensagens `assistant` no histórico de conversa.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="instructions" type="string | null">
  Insere uma mensagem de sistema (ou desenvolvedor) como primeiro item no contexto do modelo. Quando usado com `input`, as instruções são inseridas no início da entrada.
</ParamField>

<ParamField body="stream" type="boolean" default={false}>
  Se definido como `true`, a resposta será transmitida em streaming via eventos server-sent (SSE).
</ParamField>

<ParamField body="max_output_tokens" type="integer">
  Um limite superior para o número de tokens de saída, incluindo tokens de saída visíveis e tokens de raciocínio.
</ParamField>

<ParamField body="temperature" type="number" default={1}>
  Temperatura de amostragem entre 0 e 2. Valores mais altos aumentam a aleatoriedade.
</ParamField>

<ParamField body="top_p" type="number" default={1}>
  Parâmetro de amostragem por núcleo. Uma alternativa à amostragem por temperatura.
</ParamField>

<ParamField body="frequency_penalty" type="number" default={0}>
  Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base na sua frequência existente no texto.
</ParamField>

<ParamField body="presence_penalty" type="number" default={0}>
  Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base em se já aparecem no texto.
</ParamField>

<ParamField body="tools" type="object[]">
  Um array de ferramentas que o modelo pode chamar.

  <Expandable title="propriedades">
    <ParamField body="type" type="string" required>
      O tipo de ferramenta. Valores suportados: `function`, `web_search_preview`.
    </ParamField>

    <ParamField body="name" type="string">
      O nome da função. Obrigatório quando o tipo é `function`.
    </ParamField>

    <ParamField body="description" type="string">
      Uma descrição da função.
    </ParamField>

    <ParamField body="parameters" type="object">
      Um objeto JSON Schema definindo os parâmetros da função.
    </ParamField>

    <ParamField body="strict" type="boolean" default={false}>
      Indica se a aderência estrita ao esquema está habilitada.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="tool_choice" type="string | object">
  Controla o comportamento de seleção de ferramentas. Valores de string suportados: `none`, `auto`, `required`. Também pode especificar uma função particular.
</ParamField>

<ParamField body="parallel_tool_calls" type="boolean" default={true}>
  Indica se deve permitir que o modelo execute chamadas de ferramentas em paralelo.
</ParamField>

<ParamField body="text" type="object">
  Configuração para o formato de resposta de texto.

  <Expandable title="propriedades">
    <ParamField body="format" type="object">
      A configuração do formato de texto.

      <Expandable title="propriedades">
        <ParamField body="type" type="string" required>
          O tipo de formato. Valores suportados: `text`, `json_object`, `json_schema`.
        </ParamField>

        <ParamField body="name" type="string">
          O nome do formato de resposta. Obrigatório quando o tipo é `json_schema`.
        </ParamField>

        <ParamField body="schema" type="object">
          O esquema JSON. Obrigatório quando o tipo é `json_schema`.
        </ParamField>

        <ParamField body="strict" type="boolean">
          Indica se a aderência estrita ao esquema está habilitada.
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="reasoning" type="object">
  Configuração para a saída de raciocínio.

  <Expandable title="propriedades">
    <ParamField body="effort" type="string">
      Restringe o esforço de raciocínio. Valores suportados: `low`, `medium`, `high`.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="store" type="boolean" default={true}>
  Indica se a resposta gerada deve ser armazenada para recuperação posterior.
</ParamField>

<ParamField body="metadata" type="object">
  Conjunto de 16 pares chave-valor que podem ser anexados à resposta. As chaves são strings com máximo de 64 caracteres. Os valores são strings com máximo de 512 caracteres.
</ParamField>

<ParamField body="user" type="string">
  Um identificador único representando seu usuário final. Máximo de 128 caracteres.
</ParamField>

## Resposta

Objeto de resposta bem-sucedido.

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

<ResponseField name="object" type="string">
  O tipo de objeto. Sempre `response`.
</ResponseField>

<ResponseField name="created_at" type="number">
  Marca temporal Unix (em segundos) de quando a resposta foi criada.
</ResponseField>

<ResponseField name="status" type="string">
  O status da resposta. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`.
</ResponseField>

<ResponseField name="model" type="string">
  O modelo usado para gerar a resposta.
</ResponseField>

<ResponseField name="output" type="object[]">
  Um array de itens de conteúdo gerados pelo modelo.

  <Expandable title="propriedades">
    <ResponseField name="type" type="string">
      O tipo de item de saída. Por exemplo, `message`.
    </ResponseField>

    <ResponseField name="id" type="string">
      O ID único do item de saída.
    </ResponseField>

    <ResponseField name="role" type="string">
      O papel. Sempre `assistant`.
    </ResponseField>

    <ResponseField name="status" type="string">
      O status da mensagem. Por exemplo, `completed`.
    </ResponseField>

    <ResponseField name="content" type="object[]">
      O conteúdo da mensagem de saída.

      <Expandable title="propriedades">
        <ResponseField name="type" type="string">
          Tipo de conteúdo. Por exemplo, `output_text`.
        </ResponseField>

        <ResponseField name="text" type="string">
          O conteúdo de texto gerado.
        </ResponseField>

        <ResponseField name="annotations" type="object[]">
          Anotações para o conteúdo (por exemplo, citações de pesquisa web).
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="usage" type="object">
  Estatísticas de uso de tokens para a resposta.

  <Expandable title="propriedades">
    <ResponseField name="input_tokens" type="integer">
      O número de tokens de entrada.
    </ResponseField>

    <ResponseField name="output_tokens" type="integer">
      O número de tokens de saída.
    </ResponseField>

    <ResponseField name="total_tokens" type="integer">
      O número total de tokens.
    </ResponseField>

    <ResponseField name="input_tokens_details" type="object">
      Detalhamento dos tokens de entrada.

      <Expandable title="propriedades">
        <ResponseField name="cached_tokens" type="integer">
          O número de tokens em cache.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="output_tokens_details" type="object">
      Detalhamento dos tokens de saída.

      <Expandable title="propriedades">
        <ResponseField name="reasoning_tokens" type="integer">
          O número de tokens de raciocínio.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="temperature" type="number">
  A temperatura de amostragem utilizada.
</ResponseField>

<ResponseField name="top_p" type="number">
  O valor de amostragem por núcleo utilizado.
</ResponseField>

<ResponseField name="max_output_tokens" type="integer | null">
  A configuração de tokens de saída máximos utilizada.
</ResponseField>

<ResponseField name="error" type="object | null">
  Um objeto de erro se a geração falhou.
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api-llm.sunra.ai/v1/responses \
    -H "Authorization: Bearer <SUNRA_KEY>" \
    -H "Content-Type: application/json" \
    -d '{
      "model": "openai/gpt-4o",
      "input": [
        {
          "type": "message",
          "role": "user",
          "content": "Hello, how are you?"
        }
      ]
    }'
  ```

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

  response = requests.post(
      "https://api-llm.sunra.ai/v1/responses",
      headers={
          "Authorization": "Bearer <SUNRA_KEY>",
          "Content-Type": "application/json"
      },
      json={
          "model": "openai/gpt-4o",
          "input": [
              {
                  "type": "message",
                  "role": "user",
                  "content": "Hello, how are you?"
              }
          ]
      }
  )
  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch("https://api-llm.sunra.ai/v1/responses", {
    method: "POST",
    headers: {
      "Authorization": "Bearer <SUNRA_KEY>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      model: "openai/gpt-4o",
      input: [
        {
          type: "message",
          role: "user",
          content: "Hello, how are you?"
        }
      ]
    })
  });
  const data = await response.json();
  console.log(data);
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "id": "resp-abc123",
    "object": "response",
    "created_at": 1704067200,
    "status": "completed",
    "model": "openai/gpt-4o",
    "output": [
      {
        "type": "message",
        "id": "msg_abc123",
        "role": "assistant",
        "status": "completed",
        "content": [
          {
            "type": "output_text",
            "text": "Hello! I'm doing well, thank you for asking. How can I help you today?",
            "annotations": []
          }
        ]
      }
    ],
    "temperature": 1.0,
    "top_p": 1.0,
    "max_output_tokens": null,
    "usage": {
      "input_tokens": 15,
      "output_tokens": 18,
      "total_tokens": 33,
      "input_tokens_details": {
        "cached_tokens": 0
      },
      "output_tokens_details": {
        "reasoning_tokens": 0
      }
    },
    "error": null
  }
  ```
</ResponseExample>