Crear conversación de chat

Cuerpo de solicitud · application/json

Tipo

object

Campos obligatorios

modelmessages

Cuerpo de solicitud obligatorio

• modelstringObligatorio

  ID del modelo

• messagesarrayObligatorio

  Lista de mensajes de conversación

  Campos secundarios de messages (1)

  • []objectOpcional
    Campos secundarios de [] (6)

    • rolestringObligatorio

      Rol del mensaje

      Enumeración

      ["system","user","assistant","tool","developer"]

    • contentunionObligatorio

      Contenido del mensaje

      Rama oneOf 1

      Tipo: string
      Rama oneOf 2

      Tipo: array

      • []objectOpcional
        Campos secundarios de [] (6)

        • typestringOpcional

          Enumeración

          ["text","image_url","input_audio","file","video_url"]

        • textstringOpcional

        • image_urlunionOpcional

          Admite URL/Base64 como cadena u objeto {url, detail} en wire; solo modelos con imágenes. No garantiza visión en todos los modelos.

          Rama oneOf 1

          URL de imagen o URL de datos Base64.

          Tipo: string
          Rama oneOf 2

          El objeto debe incluir al menos url; Message.ParseContent normaliza detail omitido a high. El soporte depende del modelo visual elegido.

          Tipo: object

          Obligatorio en esta rama: url

          • urlstringObligatorio

            URL de imagen o base64

          • detailstringOpcional

            Enumeración

            ["low","high","auto"]

        • input_audioobjectOpcional
          Campos secundarios de input_audio (2)

          • datastringOpcional

            Audio codificado en Base64

          • formatstringOpcional

            Enumeración

            ["wav","mp3"]

        • fileobjectOpcional
          Campos secundarios de file (3)

          • filenamestringOpcional

          • file_datastringOpcional

          • file_idstringOpcional

        • video_urlstringOpcional

          La entrada wire real que lee Message.ParseContent es una cadena URL de vídeo, solo para modelos con entrada de vídeo. Un objeto {url: ...} no entra en los resultados de contenido/medición de ese parser y no se publica como contrato utilizable.

    • namestringOpcional

      Nombre del remitente

    • tool_callsarrayOpcional
      Campos secundarios de tool_calls (1)

      • []objectOpcional
        Campos secundarios de [] (3)

        • idstringOpcional

        • typestringOpcional

        • functionobjectOpcional
          Campos secundarios de function (2)

          • namestringOpcional

          • argumentsstringOpcional

    • tool_call_idstringOpcional

      ID de llamada de herramienta (mensajes con rol tool)

    • reasoning_contentstringOpcional

      Contenido de razonamiento

• temperaturenumberOpcional

  Temperatura de muestreo. Soporte y límites según modelo; sin valores predeterminados uniformes garantizados.

• top_pnumberOpcional

  Parámetro de muestreo de núcleo. Soporte y límites según modelo; no se garantizan valores predeterminados uniformes.

• nintegerOpcional

  Cantidad que generar. Soporte y límites según modelo; no se garantizan valores predeterminados uniformes.

• streambooleanOpcional

  Si la respuesta es en streaming

  Valor predeterminado

  false

• stream_optionsobjectOpcional

  Opciones de uso en el flujo de Chat; la compatibilidad y la devolución de datos de uso dependen del modelo elegido.

  Campos secundarios de stream_options (1)

  • include_usagebooleanOpcional

• stopunionOpcional

  Secuencias de parada

  Rama oneOf 1

  Tipo: string
  Rama oneOf 2

  Tipo: array

  • []stringOpcional

• max_tokensintegerOpcional

  Máximo de tokens generados. Soporte y límites según modelo; no se garantizan valores predeterminados uniformes.

• max_completion_tokensintegerOpcional

  Máximo de tokens de compleción. Soporte y límites según modelo; no se garantizan valores predeterminados uniformes.

• presence_penaltynumberOpcional

  El soporte y los límites dependen del modelo elegido; no se garantizan valores predeterminados uniformes.

• frequency_penaltynumberOpcional

  El soporte y los límites dependen del modelo elegido; no se garantizan valores predeterminados uniformes.

• logit_biasobjectOpcional
  Campos secundarios de logit_bias (1)

  • [key]numberOpcional

• userstringOpcional

• toolsarrayOpcional
  Campos secundarios de tools (1)

  • []objectOpcional
    Campos secundarios de [] (2)

    • typestringOpcional

    • functionobjectOpcional
      Campos secundarios de function (3)

      • namestringOpcional

      • descriptionstringOpcional

      • parametersobjectOpcional

        Definición de parámetros en formato JSON Schema

• tool_choiceunionOpcional
  Rama oneOf 1

  Tipo: string

  Enumeración: ["none","auto","required"]
  Rama oneOf 2

  Tipo: object

  • typestringOpcional

  • functionobjectOpcional
    Campos secundarios de function (1)

    • namestringOpcional

• response_formatobjectOpcional
  Campos secundarios de response_format (2)

  • typestringOpcional

    Enumeración

    ["text","json_object","json_schema"]

  • json_schemaobjectOpcional

    Definición JSON Schema

• seedintegerOpcional

  El soporte y los límites dependen del modelo elegido; no se garantizan valores predeterminados uniformes.

• reasoning_effortstringOpcional

  Intensidad de razonamiento (modelos compatibles). Soporte y límites según modelo, sin valores predeterminados uniformes garantizados.

• modalitiesarrayOpcional
  Campos secundarios de modalities (1)

  • []stringOpcional

    Enumeración

    ["text","audio"]

• audioobjectOpcional
  Campos secundarios de audio (2)

  • voicestringOpcional

  • formatstringOpcional

• parallel_tool_callsbooleanOpcional

  Las llamadas paralelas a herramientas dependen del modelo elegido. Chat acepta un booleano; Responses acepta valores JSON del protocolo compatible.

• storebooleanOpcional

  La posibilidad de guardar solicitudes y respuestas depende del modelo elegido y de las capacidades admitidas del servicio. Esto no ofrece una API general de almacenamiento de conversaciones.

• prompt_cache_keystringOpcional

  Identificador de correlación de caché de prompt del servicio; depende del modelo, sin garantía de acierto o soporte. Chat acepta cadenas; Responses, valores JSON del protocolo del servicio.

• prompt_cache_retentionunknownOpcional

  Valor JSON de control de retención de caché del prompt del servicio; depende del modelo. No hay enumeración, valor predeterminado ni garantía de retención uniformes.

• service_tierunknownOpcional

  Nivel de servicio solicitado, que puede afectar al coste. Se ignora de forma predeterminada y solo se aplica si está admitido. Los valores dependen del modelo elegido.

HTTP 200

{
  "type": "string",
  "description": "SSE 事件流，协议事件/用量/结束符取当前接口，错误可能在流内。"
}

HTTP 400

HTTP 401

HTTP 403

HTTP 429

HTTP 500