ResponseFormat

December 16, 2025 ยท View on GitHub

Specify the format that the model must output. By default it will use { "type": "text" }. Setting to { "type": "json_object" } enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. Setting to { "type": "json_schema" } enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide.

Fields

FieldTypeRequiredDescription
typeOptional[models.ResponseFormats]:heavy_minus_sign:N/A
json_schemaOptionalNullable[models.JSONSchema]:heavy_minus_sign:N/A