> ## 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

Crea una respuesta en streaming o no-streaming utilizando el formato de la API OpenAI Responses.

## Autenticación

<ParamField header="Authorization" type="string" required>
  Token Bearer. Use su clave API como token Bearer en el encabezado Authorization.

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

## Solicitud

Este endpoint espera un objeto.

<ParamField body="model" type="string" required>
  ID del modelo utilizado para generar la respuesta. Explore los modelos disponibles en [sunra.ai/models](https://sunra.ai/models).
</ParamField>

<ParamField body="input" type="string | object[]">
  Entrada para la solicitud de respuesta. Puede ser una cadena de texto o un array de elementos de entrada.

  <Expandable title="propiedades (para array)">
    <ParamField body="type" type="string">
      El tipo de elemento de entrada. Valores admitidos: `message`, `item_reference`.
    </ParamField>

    <ParamField body="role" type="string">
      El rol del autor del mensaje. Valores admitidos: `user`, `assistant`, `system`.
    </ParamField>

    <ParamField body="content" type="string | object[]">
      El contenido del mensaje de entrada. Puede ser una cadena de texto o un array de partes de contenido.
    </ParamField>

    <ParamField body="id" type="string">
      El ID del elemento. Requerido para mensajes `assistant` en el historial de conversación.
    </ParamField>

    <ParamField body="status" type="string">
      El estado del elemento. Requerido para mensajes `assistant` en el historial de conversación.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="instructions" type="string | null">
  Inserta un mensaje de sistema (o desarrollador) como primer elemento en el contexto del modelo. Cuando se usa con `input`, las instrucciones se insertan al inicio de la entrada.
</ParamField>

<ParamField body="stream" type="boolean" default={false}>
  Si se establece en `true`, la respuesta se transmitirá en streaming mediante eventos server-sent (SSE).
</ParamField>

<ParamField body="max_output_tokens" type="integer">
  Un límite superior para el número de tokens de salida, incluyendo tokens de salida visibles y tokens de razonamiento.
</ParamField>

<ParamField body="temperature" type="number" default={1}>
  Temperatura de muestreo entre 0 y 2. Valores más altos aumentan la aleatoriedad.
</ParamField>

<ParamField body="top_p" type="number" default={1}>
  Parámetro de muestreo por núcleo. Una alternativa al muestreo por temperatura.
</ParamField>

<ParamField body="frequency_penalty" type="number" default={0}>
  Número entre -2.0 y 2.0. Los valores positivos penalizan los nuevos tokens según su frecuencia existente en el texto.
</ParamField>

<ParamField body="presence_penalty" type="number" default={0}>
  Número entre -2.0 y 2.0. Los valores positivos penalizan los nuevos tokens según si ya aparecen en el texto.
</ParamField>

<ParamField body="tools" type="object[]">
  Un array de herramientas que el modelo puede llamar.

  <Expandable title="propiedades">
    <ParamField body="type" type="string" required>
      El tipo de herramienta. Valores admitidos: `function`, `web_search_preview`.
    </ParamField>

    <ParamField body="name" type="string">
      El nombre de la función. Requerido cuando el tipo es `function`.
    </ParamField>

    <ParamField body="description" type="string">
      Una descripción de la función.
    </ParamField>

    <ParamField body="parameters" type="object">
      Un objeto JSON Schema que define los parámetros de la función.
    </ParamField>

    <ParamField body="strict" type="boolean" default={false}>
      Indica si la adherencia estricta al esquema está habilitada.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="tool_choice" type="string | object">
  Controla el comportamiento de selección de herramientas. Valores de cadena admitidos: `none`, `auto`, `required`. También puede especificar una función particular.
</ParamField>

<ParamField body="parallel_tool_calls" type="boolean" default={true}>
  Indica si se debe permitir que el modelo ejecute llamadas a herramientas en paralelo.
</ParamField>

<ParamField body="text" type="object">
  Configuración para el formato de respuesta de texto.

  <Expandable title="propiedades">
    <ParamField body="format" type="object">
      La configuración del formato de texto.

      <Expandable title="propiedades">
        <ParamField body="type" type="string" required>
          El tipo de formato. Valores admitidos: `text`, `json_object`, `json_schema`.
        </ParamField>

        <ParamField body="name" type="string">
          El nombre del formato de respuesta. Requerido cuando el tipo es `json_schema`.
        </ParamField>

        <ParamField body="schema" type="object">
          El esquema JSON. Requerido cuando el tipo es `json_schema`.
        </ParamField>

        <ParamField body="strict" type="boolean">
          Indica si la adherencia estricta al esquema está habilitada.
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="reasoning" type="object">
  Configuración para la salida de razonamiento.

  <Expandable title="propiedades">
    <ParamField body="effort" type="string">
      Restringe el esfuerzo de razonamiento. Valores admitidos: `low`, `medium`, `high`.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="store" type="boolean" default={true}>
  Indica si la respuesta generada debe almacenarse para su recuperación posterior.
</ParamField>

<ParamField body="metadata" type="object">
  Conjunto de 16 pares clave-valor que se pueden adjuntar a la respuesta. Las claves son cadenas de máximo 64 caracteres. Los valores son cadenas de máximo 512 caracteres.
</ParamField>

<ParamField body="user" type="string">
  Un identificador único que representa a su usuario final. Máximo de 128 caracteres.
</ParamField>

## Respuesta

Objeto de respuesta exitoso.

<ResponseField name="id" type="string">
  Identificador único de la respuesta.
</ResponseField>

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

<ResponseField name="created_at" type="number">
  Marca de tiempo Unix (en segundos) de cuándo se creó la respuesta.
</ResponseField>

<ResponseField name="status" type="string">
  El estado de la respuesta. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`.
</ResponseField>

<ResponseField name="model" type="string">
  El modelo utilizado para generar la respuesta.
</ResponseField>

<ResponseField name="output" type="object[]">
  Un array de elementos de contenido generados por el modelo.

  <Expandable title="propiedades">
    <ResponseField name="type" type="string">
      El tipo de elemento de salida. Por ejemplo, `message`.
    </ResponseField>

    <ResponseField name="id" type="string">
      El ID único del elemento de salida.
    </ResponseField>

    <ResponseField name="role" type="string">
      El rol. Siempre `assistant`.
    </ResponseField>

    <ResponseField name="status" type="string">
      El estado del mensaje. Por ejemplo, `completed`.
    </ResponseField>

    <ResponseField name="content" type="object[]">
      El contenido del mensaje de salida.

      <Expandable title="propiedades">
        <ResponseField name="type" type="string">
          Tipo de contenido. Por ejemplo, `output_text`.
        </ResponseField>

        <ResponseField name="text" type="string">
          El contenido de texto generado.
        </ResponseField>

        <ResponseField name="annotations" type="object[]">
          Anotaciones para el contenido (por ejemplo, citas de búsqueda web).
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="usage" type="object">
  Estadísticas de uso de tokens para la respuesta.

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

    <ResponseField name="output_tokens" type="integer">
      El número de tokens de salida.
    </ResponseField>

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

    <ResponseField name="input_tokens_details" type="object">
      Desglose de los tokens de entrada.

      <Expandable title="propiedades">
        <ResponseField name="cached_tokens" type="integer">
          El número de tokens en caché.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="output_tokens_details" type="object">
      Desglose de los tokens de salida.

      <Expandable title="propiedades">
        <ResponseField name="reasoning_tokens" type="integer">
          El número de tokens de razonamiento.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="temperature" type="number">
  La temperatura de muestreo utilizada.
</ResponseField>

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

<ResponseField name="max_output_tokens" type="integer | null">
  La configuración de tokens de salida máximos utilizada.
</ResponseField>

<ResponseField name="error" type="object | null">
  Un objeto de error si la generación falló.
</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>