{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/compoid-com/json-schema/compoid-com-batch-chat-completion-request-schema.json",
  "title": "BatchChatCompletionRequest",
  "description": "Request model for the /v1/chat/completions/batch endpoint.\n\nAccepts the same fields as ChatCompletionRequest except that ``messages``\nis a list of conversations (each conversation is a\n``list[ChatCompletionMessageParam]``).  Each conversation is processed\nindependently and the response contains one choice per conversation,\nindexed 0, 1, ..., N-1.\n\nCurrent limitations compared to the single-conversation endpoint:\n- Streaming is not supported (``stream`` must be False or omitted).\n- Tool use is not supported (``tools`` must be omitted).\n- Beam search is not supported (``use_beam_search`` must be False or omitted).\n- The ``n`` parameter must be 1 (or omitted).",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/compoid-com-openapi.yml#/components/schemas/BatchChatCompletionRequest",
  "properties": {
    "messages": {
      "items": {
        "items": {
          "anyOf": [
            {
              "$ref": "#/$defs/ChatCompletionDeveloperMessageParam"
            },
            {
              "$ref": "#/$defs/ChatCompletionSystemMessageParam"
            },
            {
              "$ref": "#/$defs/ChatCompletionUserMessageParam"
            },
            {
              "$ref": "#/$defs/ChatCompletionAssistantMessageParam"
            },
            {
              "$ref": "#/$defs/ChatCompletionToolMessageParam"
            },
            {
              "$ref": "#/$defs/ChatCompletionFunctionMessageParam"
            },
            {
              "$ref": "#/$defs/CustomChatCompletionMessageParam"
            },
            {
              "$ref": "#/$defs/openai_harmony__Message"
            }
          ]
        },
        "type": "array",
        "minItems": 1
      },
      "type": "array",
      "minItems": 1,
      "title": "Messages"
    },
    "model": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Model"
    },
    "frequency_penalty": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Frequency Penalty"
    },
    "logit_bias": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "number"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Logit Bias"
    },
    "logprobs": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Logprobs",
      "default": false
    },
    "top_logprobs": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Top Logprobs",
      "default": 0
    },
    "logprob_token_ids": {
      "anyOf": [
        {
          "items": {
            "type": "integer"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Logprob Token Ids",
      "description": "Specific vocab token IDs to return logprobs for at each generated position, in addition to the sampled token. Requires `logprobs=True`."
    },
    "max_tokens": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Max Tokens"
    },
    "max_completion_tokens": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Max Completion Tokens"
    },
    "n": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "N",
      "default": 1
    },
    "presence_penalty": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Presence Penalty"
    },
    "response_format": {
      "anyOf": [
        {},
        {
          "type": "null"
        }
      ],
      "title": "Response Format"
    },
    "seed": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9.223372036854776e+18,
          "minimum": -9.223372036854776e+18
        },
        {
          "type": "null"
        }
      ],
      "title": "Seed"
    },
    "stop": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "items": {
            "type": "string"
          },
          "type": "array",
          "maxItems": 4
        },
        {
          "type": "null"
        }
      ],
      "title": "Stop"
    },
    "temperature": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Temperature"
    },
    "top_p": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Top P"
    },
    "user": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "User"
    },
    "tool_choice": {
      "anyOf": [
        {
          "type": "string",
          "const": "none"
        },
        {
          "type": "null"
        }
      ],
      "title": "Tool Choice",
      "default": "none"
    },
    "include_reasoning": {
      "type": "boolean",
      "title": "Include Reasoning",
      "default": true
    },
    "best_of": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Best Of"
    },
    "use_beam_search": {
      "type": "boolean",
      "title": "Use Beam Search",
      "default": false
    },
    "top_k": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Top K"
    },
    "min_p": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Min P"
    },
    "repetition_penalty": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Repetition Penalty"
    },
    "watermarking": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Watermarking"
    },
    "length_penalty": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Length Penalty",
      "default": 1.0
    },
    "early_stopping": {
      "type": "boolean",
      "title": "Early Stopping",
      "default": false
    },
    "structured_outputs": {
      "anyOf": [
        {
          "$ref": "#/$defs/StructuredOutputsParams"
        },
        {
          "type": "null"
        }
      ]
    },
    "request_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Request Id"
    },
    "add_generation_prompt": {
      "type": "boolean",
      "title": "Add Generation Prompt",
      "default": true
    },
    "continue_final_message": {
      "type": "boolean",
      "title": "Continue Final Message",
      "default": false
    },
    "chat_template": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Chat Template"
    },
    "chat_template_kwargs": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Chat Template Kwargs"
    },
    "media_io_kwargs": {
      "anyOf": [
        {
          "additionalProperties": {
            "additionalProperties": true,
            "type": "object"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Media Io Kwargs"
    },
    "mm_processor_kwargs": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Mm Processor Kwargs"
    },
    "priority": {
      "type": "integer",
      "maximum": 9.223372036854776e+18,
      "minimum": -9.223372036854776e+18,
      "title": "Priority",
      "default": 0
    },
    "cache_salt": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cache Salt"
    },
    "include_stop_str_in_output": {
      "type": "boolean",
      "title": "Include Stop Str In Output",
      "default": false
    },
    "guided_decoding_backend": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Guided Decoding Backend"
    },
    "echo": {
      "type": "boolean",
      "title": "Echo",
      "default": false
    },
    "return_tokens_as_token_ids": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Return Tokens As Token Ids"
    },
    "return_token_ids": {
      "type": "boolean",
      "title": "Return Token Ids",
      "default": false
    }
  },
  "additionalProperties": true,
  "type": "object",
  "required": [
    "messages"
  ],
  "$defs": {
    "Audio": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "id"
      ],
      "title": "Audio",
      "description": "Data about a previous audio response from the model.\n[Learn more](https://developers.openai.com/api/docs/guides/audio)."
    },
    "AudioURL": {
      "properties": {
        "url": {
          "type": "string",
          "title": "Url"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "url"
      ],
      "title": "AudioURL"
    },
    "Author": {
      "properties": {
        "role": {
          "$ref": "#/$defs/Role"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Name"
        }
      },
      "type": "object",
      "required": [
        "role"
      ],
      "title": "Author"
    },
    "ChatCompletionAssistantMessageParam": {
      "properties": {
        "role": {
          "type": "string",
          "const": "assistant",
          "title": "Role"
        },
        "audio": {
          "anyOf": [
            {
              "$ref": "#/$defs/Audio"
            },
            {
              "type": "null"
            }
          ]
        },
        "content": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "items": {
                "anyOf": [
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartTextParam"
                  },
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartRefusalParam"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Content"
        },
        "function_call": {
          "anyOf": [
            {
              "$ref": "#/$defs/FunctionCall"
            },
            {
              "type": "null"
            }
          ]
        },
        "name": {
          "type": "string",
          "title": "Name"
        },
        "refusal": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Refusal"
        },
        "tool_calls": {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/ChatCompletionMessageFunctionToolCallParam"
              },
              {
                "$ref": "#/$defs/ChatCompletionMessageCustomToolCallParam"
              }
            ]
          },
          "type": "array",
          "title": "Tool Calls"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "role"
      ],
      "title": "ChatCompletionAssistantMessageParam",
      "description": "Messages sent by the model in response to user messages."
    },
    "ChatCompletionContentPartAudioEmbedsParam": {
      "properties": {
        "audio_embeds": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "additionalProperties": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "items": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "number"
                        }
                      ]
                    },
                    "type": "array"
                  }
                ]
              },
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Audio Embeds"
        },
        "type": {
          "type": "string",
          "const": "audio_embeds",
          "title": "Type"
        },
        "uuid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Uuid"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "type"
      ],
      "title": "ChatCompletionContentPartAudioEmbedsParam"
    },
    "ChatCompletionContentPartAudioParam": {
      "properties": {
        "audio_url": {
          "$ref": "#/$defs/AudioURL"
        },
        "type": {
          "type": "string",
          "const": "audio_url",
          "title": "Type"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "audio_url",
        "type"
      ],
      "title": "ChatCompletionContentPartAudioParam"
    },
    "ChatCompletionContentPartImageEmbedsParam": {
      "properties": {
        "image_embeds": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "additionalProperties": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "items": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "number"
                        }
                      ]
                    },
                    "type": "array"
                  }
                ]
              },
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Image Embeds"
        },
        "type": {
          "type": "string",
          "const": "image_embeds",
          "title": "Type"
        },
        "uuid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Uuid"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "type"
      ],
      "title": "ChatCompletionContentPartImageEmbedsParam"
    },
    "ChatCompletionContentPartImageParam": {
      "properties": {
        "image_url": {
          "$ref": "#/$defs/ImageURL"
        },
        "type": {
          "type": "string",
          "const": "image_url",
          "title": "Type"
        },
        "prompt_cache_breakpoint": {
          "$ref": "#/$defs/PromptCacheBreakpoint"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "image_url",
        "type"
      ],
      "title": "ChatCompletionContentPartImageParam",
      "description": "Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision)."
    },
    "ChatCompletionContentPartInputAudioParam": {
      "properties": {
        "input_audio": {
          "$ref": "#/$defs/InputAudio"
        },
        "type": {
          "type": "string",
          "const": "input_audio",
          "title": "Type"
        },
        "prompt_cache_breakpoint": {
          "$ref": "#/$defs/PromptCacheBreakpoint"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "input_audio",
        "type"
      ],
      "title": "ChatCompletionContentPartInputAudioParam",
      "description": "Learn about [audio inputs](https://developers.openai.com/api/docs/guides/audio)."
    },
    "ChatCompletionContentPartPromptEmbedsParam": {
      "properties": {
        "data": {
          "type": "string",
          "title": "Data"
        },
        "type": {
          "type": "string",
          "const": "prompt_embeds",
          "title": "Type"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "data",
        "type"
      ],
      "title": "ChatCompletionContentPartPromptEmbedsParam"
    },
    "ChatCompletionContentPartRefusalParam": {
      "properties": {
        "refusal": {
          "type": "string",
          "title": "Refusal"
        },
        "type": {
          "type": "string",
          "const": "refusal",
          "title": "Type"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "refusal",
        "type"
      ],
      "title": "ChatCompletionContentPartRefusalParam"
    },
    "ChatCompletionContentPartTextParam": {
      "properties": {
        "text": {
          "type": "string",
          "title": "Text"
        },
        "type": {
          "type": "string",
          "const": "text",
          "title": "Type"
        },
        "prompt_cache_breakpoint": {
          "$ref": "#/$defs/PromptCacheBreakpoint"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "text",
        "type"
      ],
      "title": "ChatCompletionContentPartTextParam",
      "description": "Learn about [text inputs](https://developers.openai.com/api/docs/guides/text)."
    },
    "ChatCompletionContentPartVideoEmbedsParam": {
      "properties": {
        "video_embeds": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "additionalProperties": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "items": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "number"
                        }
                      ]
                    },
                    "type": "array"
                  }
                ]
              },
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Video Embeds"
        },
        "type": {
          "type": "string",
          "const": "video_embeds",
          "title": "Type"
        },
        "uuid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Uuid"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "type"
      ],
      "title": "ChatCompletionContentPartVideoEmbedsParam"
    },
    "ChatCompletionContentPartVideoParam": {
      "properties": {
        "video_url": {
          "$ref": "#/$defs/VideoURL"
        },
        "type": {
          "type": "string",
          "const": "video_url",
          "title": "Type"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "video_url",
        "type"
      ],
      "title": "ChatCompletionContentPartVideoParam"
    },
    "ChatCompletionDeveloperMessageParam": {
      "properties": {
        "content": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "items": {
                "$ref": "#/$defs/ChatCompletionContentPartTextParam"
              },
              "type": "array"
            }
          ],
          "title": "Content"
        },
        "role": {
          "type": "string",
          "const": "developer",
          "title": "Role"
        },
        "name": {
          "type": "string",
          "title": "Name"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "content",
        "role"
      ],
      "title": "ChatCompletionDeveloperMessageParam",
      "description": "Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, `developer` messages\nreplace the previous `system` messages."
    },
    "ChatCompletionFunctionMessageParam": {
      "properties": {
        "content": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Content"
        },
        "name": {
          "type": "string",
          "title": "Name"
        },
        "role": {
          "type": "string",
          "const": "function",
          "title": "Role"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "content",
        "name",
        "role"
      ],
      "title": "ChatCompletionFunctionMessageParam"
    },
    "ChatCompletionFunctionToolParam": {
      "properties": {
        "function": {
          "$ref": "#/$defs/openai__types__shared_params__function_definition__FunctionDefinition"
        },
        "type": {
          "type": "string",
          "const": "function",
          "title": "Type"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "function",
        "type"
      ],
      "title": "ChatCompletionFunctionToolParam",
      "description": "A function tool that can be used to generate a response."
    },
    "ChatCompletionMessageCustomToolCallParam": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id"
        },
        "custom": {
          "$ref": "#/$defs/Custom"
        },
        "type": {
          "type": "string",
          "const": "custom",
          "title": "Type"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "id",
        "custom",
        "type"
      ],
      "title": "ChatCompletionMessageCustomToolCallParam",
      "description": "A call to a custom tool created by the model."
    },
    "ChatCompletionMessageFunctionToolCallParam": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id"
        },
        "function": {
          "$ref": "#/$defs/Function"
        },
        "type": {
          "type": "string",
          "const": "function",
          "title": "Type"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "id",
        "function",
        "type"
      ],
      "title": "ChatCompletionMessageFunctionToolCallParam",
      "description": "A call to a function tool created by the model."
    },
    "ChatCompletionSystemMessageParam": {
      "properties": {
        "content": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "items": {
                "$ref": "#/$defs/ChatCompletionContentPartTextParam"
              },
              "type": "array"
            }
          ],
          "title": "Content"
        },
        "role": {
          "type": "string",
          "const": "system",
          "title": "Role"
        },
        "name": {
          "type": "string",
          "title": "Name"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "content",
        "role"
      ],
      "title": "ChatCompletionSystemMessageParam",
      "description": "Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, use `developer` messages\nfor this purpose instead."
    },
    "ChatCompletionToolMessageParam": {
      "properties": {
        "content": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "items": {
                "$ref": "#/$defs/ChatCompletionContentPartTextParam"
              },
              "type": "array"
            }
          ],
          "title": "Content"
        },
        "role": {
          "type": "string",
          "const": "tool",
          "title": "Role"
        },
        "tool_call_id": {
          "type": "string",
          "title": "Tool Call Id"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "content",
        "role",
        "tool_call_id"
      ],
      "title": "ChatCompletionToolMessageParam"
    },
    "ChatCompletionUserMessageParam": {
      "properties": {
        "content": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "items": {
                "anyOf": [
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartTextParam"
                  },
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartImageParam"
                  },
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartInputAudioParam"
                  },
                  {
                    "$ref": "#/$defs/File"
                  }
                ]
              },
              "type": "array"
            }
          ],
          "title": "Content"
        },
        "role": {
          "type": "string",
          "const": "user",
          "title": "Role"
        },
        "name": {
          "type": "string",
          "title": "Name"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "content",
        "role"
      ],
      "title": "ChatCompletionUserMessageParam",
      "description": "Messages sent by an end user, containing prompts or additional context\ninformation."
    },
    "Custom": {
      "properties": {
        "input": {
          "type": "string",
          "title": "Input"
        },
        "name": {
          "type": "string",
          "title": "Name"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "input",
        "name"
      ],
      "title": "Custom",
      "description": "The custom tool that the model called."
    },
    "CustomChatCompletionContentSimpleAudioParam": {
      "properties": {
        "audio_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Audio Url"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "title": "CustomChatCompletionContentSimpleAudioParam",
      "description": "A simpler version of the param that only accepts a plain audio_url.\n\nExample:\n{\n    \"audio_url\": \"https://example.com/audio.mp3\"\n}"
    },
    "CustomChatCompletionContentSimpleImageParam": {
      "properties": {
        "image_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Image Url"
        },
        "uuid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Uuid"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "title": "CustomChatCompletionContentSimpleImageParam",
      "description": "A simpler version of the param that only accepts a plain image_url.\nThis is supported by OpenAI API, although it is not documented.\n\nExample:\n{\n    \"image_url\": \"https://example.com/image.jpg\"\n}"
    },
    "CustomChatCompletionContentSimpleVideoParam": {
      "properties": {
        "video_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Video Url"
        },
        "uuid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Uuid"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "title": "CustomChatCompletionContentSimpleVideoParam",
      "description": "A simpler version of the param that only accepts a plain audio_url.\n\nExample:\n{\n    \"video_url\": \"https://example.com/video.mp4\"\n}"
    },
    "CustomChatCompletionContentToolReferenceParam": {
      "properties": {
        "name": {
          "type": "string",
          "title": "Name"
        },
        "type": {
          "type": "string",
          "const": "tool_reference",
          "title": "Type"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "title": "CustomChatCompletionContentToolReferenceParam",
      "description": "A tool reference content param that only accepts a plain tool name.\n\nExample:\n{\n    \"name\": \"get_weather\",\n    \"type\": \"tool_reference\"\n}"
    },
    "CustomChatCompletionMessageParam": {
      "properties": {
        "role": {
          "type": "string",
          "title": "Role"
        },
        "content": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "items": {
                "anyOf": [
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartTextParam"
                  },
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartImageParam"
                  },
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartInputAudioParam"
                  },
                  {
                    "$ref": "#/$defs/File"
                  },
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartAudioParam"
                  },
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartVideoParam"
                  },
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartRefusalParam"
                  },
                  {
                    "$ref": "#/$defs/CustomChatCompletionContentSimpleImageParam"
                  },
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartImageEmbedsParam"
                  },
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartAudioEmbedsParam"
                  },
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartVideoEmbedsParam"
                  },
                  {
                    "$ref": "#/$defs/ChatCompletionContentPartPromptEmbedsParam"
                  },
                  {
                    "$ref": "#/$defs/CustomChatCompletionContentSimpleAudioParam"
                  },
                  {
                    "$ref": "#/$defs/CustomChatCompletionContentSimpleVideoParam"
                  },
                  {
                    "$ref": "#/$defs/CustomChatCompletionContentToolReferenceParam"
                  },
                  {
                    "type": "string"
                  },
                  {
                    "$ref": "#/$defs/CustomThinkCompletionContentParam"
                  }
                ]
              },
              "type": "array"
            }
          ],
          "title": "Content"
        },
        "name": {
          "type": "string",
          "title": "Name"
        },
        "tool_call_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Tool Call Id"
        },
        "tool_calls": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ChatCompletionMessageFunctionToolCallParam"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Tool Calls"
        },
        "reasoning": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Reasoning"
        },
        "tools": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ChatCompletionFunctionToolParam"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Tools"
        },
        "task": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Task"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "role"
      ],
      "title": "CustomChatCompletionMessageParam",
      "description": "Enables custom roles in the Chat Completion API."
    },
    "CustomThinkCompletionContentParam": {
      "properties": {
        "thinking": {
          "type": "string",
          "title": "Thinking"
        },
        "closed": {
          "type": "boolean",
          "title": "Closed"
        },
        "type": {
          "type": "string",
          "const": "thinking",
          "title": "Type"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "thinking",
        "type"
      ],
      "title": "CustomThinkCompletionContentParam",
      "description": "A Think Completion Content Param that accepts a plain text and a boolean.\n\nExample:\n{\n    \"thinking\": \"I am thinking about the answer\",\n    \"closed\": True,\n    \"type\": \"thinking\"\n}"
    },
    "File": {
      "properties": {
        "file": {
          "$ref": "#/$defs/FileFile"
        },
        "type": {
          "type": "string",
          "const": "file",
          "title": "Type"
        },
        "prompt_cache_breakpoint": {
          "$ref": "#/$defs/FilePromptCacheBreakpoint"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "file",
        "type"
      ],
      "title": "File",
      "description": "Learn about [file inputs](https://developers.openai.com/api/docs/guides/text) for text generation."
    },
    "FileFile": {
      "properties": {
        "file_data": {
          "type": "string",
          "title": "File Data"
        },
        "file_id": {
          "type": "string",
          "title": "File Id"
        },
        "filename": {
          "type": "string",
          "title": "Filename"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "title": "FileFile"
    },
    "FilePromptCacheBreakpoint": {
      "properties": {
        "mode": {
          "type": "string",
          "const": "explicit",
          "title": "Mode"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "mode"
      ],
      "title": "FilePromptCacheBreakpoint",
      "description": "Marks the exact end of a reusable prompt prefix.\n\nThe breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block."
    },
    "Function": {
      "properties": {
        "arguments": {
          "type": "string",
          "title": "Arguments"
        },
        "name": {
          "type": "string",
          "title": "Name"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "arguments",
        "name"
      ],
      "title": "Function",
      "description": "The function that the model called."
    },
    "FunctionCall": {
      "properties": {
        "arguments": {
          "type": "string",
          "title": "Arguments"
        },
        "name": {
          "type": "string",
          "title": "Name"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "arguments",
        "name"
      ],
      "title": "FunctionCall",
      "description": "Deprecated and replaced by `tool_calls`.\n\nThe name and arguments of a function that should be called, as generated by the model."
    },
    "ImageURL": {
      "properties": {
        "url": {
          "type": "string",
          "title": "Url"
        },
        "detail": {
          "type": "string",
          "enum": [
            "auto",
            "low",
            "high",
            "original"
          ],
          "title": "Detail"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "url"
      ],
      "title": "ImageURL"
    },
    "InputAudio": {
      "properties": {
        "data": {
          "type": "string",
          "title": "Data"
        },
        "format": {
          "type": "string",
          "enum": [
            "wav",
            "mp3"
          ],
          "title": "Format"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "data",
        "format"
      ],
      "title": "InputAudio"
    },
    "PromptCacheBreakpoint": {
      "properties": {
        "mode": {
          "type": "string",
          "const": "explicit",
          "title": "Mode"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "mode"
      ],
      "title": "PromptCacheBreakpoint",
      "description": "Marks the exact end of a reusable prompt prefix.\n\nThe breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block."
    },
    "Role": {
      "type": "string",
      "enum": [
        "user",
        "assistant",
        "system",
        "developer",
        "tool"
      ],
      "title": "Role",
      "description": "The role of a message author (mirrors ``chat::Role``)."
    },
    "StructuredOutputsParams": {
      "properties": {
        "json": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Json"
        },
        "regex": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Regex"
        },
        "choice": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Choice"
        },
        "grammar": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Grammar"
        },
        "json_object": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "title": "Json Object"
        },
        "disable_any_whitespace": {
          "type": "boolean",
          "title": "Disable Any Whitespace",
          "default": false
        },
        "disable_additional_properties": {
          "type": "boolean",
          "title": "Disable Additional Properties",
          "default": false
        },
        "whitespace_pattern": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Whitespace Pattern"
        },
        "structural_tag": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Structural Tag"
        },
        "_backend": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Backend"
        },
        "_backend_was_auto": {
          "type": "boolean",
          "title": "Backend Was Auto",
          "default": false
        }
      },
      "type": "object",
      "title": "StructuredOutputsParams"
    },
    "VideoURL": {
      "properties": {
        "url": {
          "type": "string",
          "title": "Url"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "url"
      ],
      "title": "VideoURL"
    },
    "openai__types__shared_params__function_definition__FunctionDefinition": {
      "properties": {
        "name": {
          "type": "string",
          "title": "Name"
        },
        "description": {
          "type": "string",
          "title": "Description"
        },
        "parameters": {
          "additionalProperties": true,
          "type": "object",
          "title": "Parameters"
        },
        "strict": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "title": "Strict"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "name"
      ],
      "title": "FunctionDefinition"
    },
    "openai_harmony__Content": {
      "properties": {},
      "type": "object",
      "title": "Content"
    },
    "openai_harmony__Message": {
      "properties": {
        "author": {
          "$ref": "#/$defs/Author"
        },
        "content": {
          "items": {
            "$ref": "#/$defs/openai_harmony__Content"
          },
          "type": "array",
          "title": "Content"
        },
        "channel": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Channel"
        },
        "recipient": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Recipient"
        },
        "content_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Content Type"
        }
      },
      "type": "object",
      "required": [
        "author"
      ],
      "title": "Message"
    }
  }
}