ChatGPT · Schema

ChatCompletionContentPart

AgentsAIChatGPTEmbeddingsFine-TuningGPT-4GPT-5Language ModelOpenAIRealtime

Properties

Name Type Description
type string The type of the content part.
text string The text content. Required when type is text.
image_url object The image URL content. Required when type is image_url.
input_audio object The audio content. Required when type is input_audio.
View JSON Schema on GitHub

JSON Schema

chatgpt-chatcompletioncontentpart-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ChatCompletionContentPart",
  "title": "ChatCompletionContentPart",
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of the content part.",
      "enum": [
        "text",
        "image_url",
        "input_audio"
      ],
      "example": "text"
    },
    "text": {
      "type": "string",
      "description": "The text content. Required when type is text.",
      "example": "example_value"
    },
    "image_url": {
      "type": "object",
      "description": "The image URL content. Required when type is image_url.",
      "properties": {
        "url": {
          "type": "string",
          "format": "uri",
          "description": "Either a URL of the image or the base64 encoded image data.\n"
        },
        "detail": {
          "type": "string",
          "description": "Specifies the detail level of the image. low uses fewer\ntokens; high enables detailed image understanding.\n",
          "enum": [
            "auto",
            "low",
            "high"
          ],
          "default": "auto"
        }
      },
      "example": "https://www.example.com"
    },
    "input_audio": {
      "type": "object",
      "description": "The audio content. Required when type is input_audio.",
      "properties": {
        "data": {
          "type": "string",
          "description": "Base64 encoded audio data."
        },
        "format": {
          "type": "string",
          "description": "The format of the encoded audio data.",
          "enum": [
            "wav",
            "mp3"
          ]
        }
      },
      "example": "example_value"
    }
  }
}