This commit is contained in:
Ahmed Ibrahim
2026-03-18 14:31:58 -07:00
parent 8adbf6b15b
commit 8287818db4
8 changed files with 66 additions and 828 deletions
+26 -5
View File
@@ -806,61 +806,75 @@
},
"ModelProviderInfo": {
"additionalProperties": false,
"description": "Serializable representation of a provider definition.",
"properties": {
"base_url": {
"description": "Base URL for the provider's OpenAI-compatible API.",
"type": "string"
},
"env_http_headers": {
"additionalProperties": {
"type": "string"
},
"description": "Optional HTTP headers to include in requests to this provider where the (key, value) pairs are the header name and _environment variable_ whose value should be used. If the environment variable is not set, or the value is empty, the header will not be included in the request.",
"type": "object"
},
"env_key": {
"description": "Environment variable that stores the user's API key for this provider.",
"type": "string"
},
"env_key_instructions": {
"description": "Optional instructions to help the user get a valid value for the variable and set it.",
"type": "string"
},
"experimental_bearer_token": {
"description": "Value to use with `Authorization: Bearer <token>` header. Use of this config is discouraged in favor of `env_key` for security reasons, but this may be necessary when using this programmatically.",
"type": "string"
},
"http_headers": {
"additionalProperties": {
"type": "string"
},
"description": "Additional HTTP headers to include in requests to this provider where the (key, value) pairs are the header name and value.",
"type": "object"
},
"name": {
"description": "Friendly display name.",
"type": "string"
},
"query_params": {
"additionalProperties": {
"type": "string"
},
"description": "Optional query parameters to append to the base URL.",
"type": "object"
},
"request_max_retries": {
"description": "Maximum number of times to retry a failed HTTP request to this provider.",
"format": "uint64",
"minimum": 0.0,
"type": "integer"
},
"requires_openai_auth": {
"default": false,
"description": "Does this provider require an OpenAI API Key or ChatGPT login token? If true, user is presented with login screen on first run, and login preference and token/key are stored in auth.json. If false (which is the default), login screen is skipped, and API key (if needed) comes from the \"env_key\" environment variable.",
"type": "boolean"
},
"stream_idle_timeout_ms": {
"description": "Idle timeout (in milliseconds) to wait for activity on a streaming response before treating the connection as lost.",
"format": "uint64",
"minimum": 0.0,
"type": "integer"
},
"stream_max_retries": {
"description": "Number of times to retry reconnecting a dropped streaming response before failing.",
"format": "uint64",
"minimum": 0.0,
"type": "integer"
},
"supports_websockets": {
"default": false,
"description": "Whether this provider supports the Responses API WebSocket transport.",
"type": "boolean"
},
"websocket_connect_timeout_ms": {
@@ -875,7 +889,8 @@
"$ref": "#/definitions/WireApi"
}
],
"default": "responses"
"default": "responses",
"description": "Which wire protocol this provider expects."
}
},
"required": [
@@ -1765,10 +1780,16 @@
"type": "object"
},
"WireApi": {
"enum": [
"responses"
],
"type": "string"
"description": "Wire protocol that the provider speaks.",
"oneOf": [
{
"description": "The Responses API exposed by OpenAI at `/v1/responses`.",
"enum": [
"responses"
],
"type": "string"
}
]
}
},
"description": "Base config deserialized from ~/.codex/config.toml.",