codex/codex-rs/app-server-protocol/schema/json/v2/ModelListResponse.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "InputModality": {
      "description": "Canonical user-input modality tags advertised by a model.",
      "oneOf": [
        {
          "description": "Plain text turns and tool payloads.",
          "enum": [
            "text"
          ],
          "type": "string"
        },
        {
          "description": "Image attachments included in user turns.",
          "enum": [
            "image"
          ],
          "type": "string"
        },
        {
          "description": "Audio attachments included in user turns.",
          "enum": [
            "audio"
          ],
          "type": "string"
        }
      ]
    },
    "Model": {
      "properties": {
        "additionalSpeedTiers": {
          "default": [],
          "description": "Deprecated: use `serviceTiers` instead.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "availabilityNux": {
          "anyOf": [
            {
              "$ref": "#/definitions/ModelAvailabilityNux"
            },
            {
              "type": "null"
            }
          ]
        },
        "defaultReasoningEffort": {
          "$ref": "#/definitions/ReasoningEffort"
        },
        "defaultServiceTier": {
          "default": null,
          "description": "Catalog default service tier id for this model, when one is configured.",
          "type": [
            "string",
            "null"
          ]
        },
        "description": {
          "type": "string"
        },
        "displayName": {
          "type": "string"
        },
        "hidden": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "inputModalities": {
          "default": [
            "text",
            "image"
          ],
          "items": {
            "$ref": "#/definitions/InputModality"
          },
          "type": "array"
        },
        "isDefault": {
          "type": "boolean"
        },
        "model": {
          "type": "string"
        },
        "modelSpecialty": {
          "default": null,
          "type": [
            "string",
            "null"
          ]
        },
        "multiAgentVersion": {
          "anyOf": [
            {
              "$ref": "#/definitions/MultiAgentVersion"
            },
            {
              "type": "null"
            }
          ],
          "description": "Multi-agent runtime declared by this model, when available."
        },
        "serviceTiers": {
          "default": [],
          "items": {
            "$ref": "#/definitions/ModelServiceTier"
          },
          "type": "array"
        },
        "supportedReasoningEfforts": {
          "items": {
            "$ref": "#/definitions/ReasoningEffortOption"
          },
          "type": "array"
        },
        "supportsPersonality": {
          "default": false,
          "type": "boolean"
        },
        "upgrade": {
          "type": [
            "string",
            "null"
          ]
        },
        "upgradeInfo": {
          "anyOf": [
            {
              "$ref": "#/definitions/ModelUpgradeInfo"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "defaultReasoningEffort",
        "description",
        "displayName",
        "hidden",
        "id",
        "isDefault",
        "model",
        "supportedReasoningEfforts"
      ],
      "type": "object"
    },
    "ModelAvailabilityNux": {
      "properties": {
        "message": {
          "type": "string"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "ModelServiceTier": {
      "properties": {
        "description": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "description",
        "id",
        "name"
      ],
      "type": "object"
    },
    "ModelUpgradeInfo": {
      "properties": {
        "migrationMarkdown": {
          "type": [
            "string",
            "null"
          ]
        },
        "model": {
          "type": "string"
        },
        "modelLink": {
          "type": [
            "string",
            "null"
          ]
        },
        "upgradeCopy": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "model"
      ],
      "type": "object"
    },
    "MultiAgentVersion": {
      "description": "Multi-agent runtime supported by a model.",
      "enum": [
        "disabled",
        "v1",
        "v2"
      ],
      "type": "string"
    },
    "ReasoningEffort": {
      "description": "A non-empty reasoning effort value advertised by the model.",
      "minLength": 1,
      "type": "string"
    },
    "ReasoningEffortOption": {
      "properties": {
        "description": {
          "type": "string"
        },
        "reasoningEffort": {
          "$ref": "#/definitions/ReasoningEffort"
        }
      },
      "required": [
        "description",
        "reasoningEffort"
      ],
      "type": "object"
    }
  },
  "properties": {
    "data": {
      "items": {
        "$ref": "#/definitions/Model"
      },
      "type": "array"
    },
    "nextCursor": {
      "description": "Opaque cursor to pass to the next call to continue after the last item. If None, there are no more items to return.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "data"
  ],
  "title": "ModelListResponse",
  "type": "object"
}