> ## Documentation Index > Fetch the complete documentation index at: https://docs.aihubmix.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a Chat Completion > **Starting a new project?** We recommend trying [Responses](https://developers.openai.com/api/docs/api-reference/responses) to take advantage of the latest OpenAI platform features. Compare [Chat Completions with Responses](https://developers.openai.com/api/docs/guides/responses-vs-chat-completions?api-mode=responses). --- Creates a model response for the given chat conversation. Learn more in the [text generation](https://developers.openai.com/api/docs/guides/text-generation), [vision](https://developers.openai.com/api/docs/guides/vision), and [audio](https://developers.openai.com/api/docs/guides/audio) guides. Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, [refer to the reasoning guide](https://developers.openai.com/api/docs/guides/reasoning). Returns a chat completion object, or a streamed sequence of chat completion chunk objects if the request is streamed. ## OpenAPI ````yaml /openapi.json post /v1/chat/completions openapi: 3.1.0 info: title: AIHubMix Gateway API description: | Unified multi-protocol gateway. Exposes three native shapes side-by-side: - OpenAI (`/v1/chat/completions`, `/v1/responses`, ...) - Anthropic (`/v1/messages`) - Gemini (`/v1beta/models/{model}:generateContent`) Each vendor's native SDK connects directly. Gateway-only fields are marked with `x-source.authority: gateway`. contact: name: AIHubMix Team version: 2.1.1 x-upstream: vendorSpecs: packageVersion: 0.1.1 installedFrom: npm sources: openai/official: version: '2026-05-31' hash: >- sha256:a203971a0bc0cd3b903b9488e3ac40eaa161a274dfaf172c1da73eee029147a8 anthropic/official: version: '2026-05-31' hash: >- sha256:f9d488f9290d78a081bed62fa0c040476b5d009f3db92c06c8e279e69df73fc9 layers: - role: L0-base source: avs://openai/official protocol: openai authority: official - role: L0-base source: avs://anthropic/official protocol: anthropic authority: official - role: gateway-other source: gateway/anthropic-mappings.yml protocol: all authority: gateway - role: horizontal-auth source: gateway/auth.yml protocol: all authority: gateway - role: horizontal-errors source: gateway/errors.yml protocol: all authority: gateway - role: L3-gateway source: gateway/openai-gateway.yml protocol: openai authority: gateway - role: gateway-other source: gateway/openai-image-mappings.yml protocol: all authority: gateway - role: gateway-other source: gateway/openai-mappings.yml protocol: all authority: gateway - role: L2-passthrough source: gateway/openai-passthrough.yml protocol: openai authority: gateway servers: - url: https://aihubmix.com description: Production - url: https://api.inferera.com description: Backup (use when the primary domain is unreachable) security: - gatewayBearer: [] tags: - name: OpenAI Compatible description: >- OpenAI-compatible endpoints (chat, completions, embeddings, images, audio, videos, moderations). - name: Anthropic Compatible description: Anthropic-native endpoints (messages with Anthropic protocol). - name: Google Vertex AI Compatible description: Google Gemini / Vertex AI endpoints. paths: /v1/chat/completions: post: tags: - OpenAI Compatible summary: Create a Chat Completion description: >- **Starting a new project?** We recommend trying [Responses](https://developers.openai.com/api/docs/api-reference/responses) to take advantage of the latest OpenAI platform features. Compare [Chat Completions with Responses](https://developers.openai.com/api/docs/guides/responses-vs-chat-completions?api-mode=responses). --- Creates a model response for the given chat conversation. Learn more in the [text generation](https://developers.openai.com/api/docs/guides/text-generation), [vision](https://developers.openai.com/api/docs/guides/vision), and [audio](https://developers.openai.com/api/docs/guides/audio) guides. Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, [refer to the reasoning guide](https://developers.openai.com/api/docs/guides/reasoning). Returns a chat completion object, or a streamed sequence of chat completion chunk objects if the request is streamed. operationId: createChatCompletion requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateChatCompletionRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateChatCompletionResponse' text/event-stream: schema: $ref: '#/components/schemas/CreateChatCompletionStreamResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/GatewayError' '401': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/GatewayError' '403': description: Permission denied content: application/json: schema: $ref: '#/components/schemas/GatewayError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GatewayError' '429': description: Rate limited content: application/json: schema: $ref: '#/components/schemas/GatewayError' 5XX: description: Server / upstream error content: application/json: schema: $ref: '#/components/schemas/GatewayError' components: schemas: CreateChatCompletionRequest: allOf: - $ref: '#/components/schemas/CreateModelResponseProperties' - type: object properties: messages: description: > A list of messages comprising the conversation so far. Depending on the [model](https://developers.openai.com/api/docs/models) you use, different message types (modalities) are supported, like [text](https://developers.openai.com/api/docs/guides/text-generation), [images](https://developers.openai.com/api/docs/guides/vision), and [audio](https://developers.openai.com/api/docs/guides/audio). type: array minItems: 1 items: $ref: '#/components/schemas/ChatCompletionRequestMessage' x-providers: anthropic: transform: split_system_from_messages bedrock: transform: split_system_from_messages gemini: to: - contents transform: openai_messages_to_gemini_contents vertex: to: - contents transform: openai_messages_to_gemini_contents model: $ref: '#/components/schemas/ModelIdsShared' description: > Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models. modalities: $ref: '#/components/schemas/ResponseModalities' verbosity: $ref: '#/components/schemas/Verbosity' reasoning_effort: $ref: '#/components/schemas/ReasoningEffort' max_completion_tokens: description: > An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning). type: integer nullable: true frequency_penalty: type: number default: 0 minimum: -2 maximum: 2 nullable: true description: > Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. presence_penalty: type: number default: 0 minimum: -2 maximum: 2 nullable: true description: > Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. web_search_options: type: object title: Web search description: > This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search?api-mode=chat). properties: user_location: type: object nullable: true required: - type - approximate description: | Approximate location parameters for the search. properties: type: type: string description: > The type of location approximation. Always `approximate`. enum: - approximate approximate: $ref: '#/components/schemas/WebSearchLocation' search_context_size: $ref: '#/components/schemas/WebSearchContextSize' top_logprobs: description: > An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested. `logprobs` must be set to `true` if this parameter is used. type: integer minimum: 0 maximum: 20 nullable: true response_format: description: > An object specifying the format that the model must output. Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs). Setting to `{ "type": "json_object" }` enables the older JSON mode, which ensures the message the model generates is valid JSON. Using `json_schema` is preferred for models that support it. oneOf: - $ref: '#/components/schemas/ResponseFormatText' - $ref: '#/components/schemas/ResponseFormatJsonSchema' - $ref: '#/components/schemas/ResponseFormatJsonObject' discriminator: propertyName: type audio: type: object nullable: true description: > Parameters for audio output. Required when audio output is requested with `modalities: ["audio"]`. [Learn more](https://developers.openai.com/api/docs/guides/audio). required: - voice - format properties: voice: $ref: '#/components/schemas/VoiceIdsOrCustomVoice' description: > The voice the model uses to respond. Supported built-in voices are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`, `marin`, and `cedar`. You may also provide a custom voice object with an `id`, for example `{ "id": "voice_1234" }`. format: type: string enum: - wav - aac - mp3 - flac - opus - pcm16 description: > Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`, or `pcm16`. store: type: boolean default: false nullable: true description: > Whether or not to store the output of this chat completion request for use in our [model distillation](https://developers.openai.com/api/docs/guides/distillation) or [evals](https://developers.openai.com/api/docs/guides/evals) products. Supports text and image inputs. Note: image inputs over 8MB will be dropped. stream: description: > If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). See the [Streaming section below](https://developers.openai.com/api/docs/api-reference/chat/streaming) for more information, along with the [streaming responses](https://developers.openai.com/api/docs/guides/streaming-responses) guide for more information on how to handle the streaming events. type: boolean nullable: true default: false stop: $ref: '#/components/schemas/StopConfiguration' logit_bias: type: object default: null nullable: true additionalProperties: type: integer description: > Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. logprobs: description: > Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. type: boolean default: false nullable: true max_tokens: description: > The maximum number of [tokens](/tokenizer) that can be generated in the chat completion. This value can be used to control [costs](https://openai.com/api/pricing/) for text generated via API. This value is now deprecated in favor of `max_completion_tokens`, and is not compatible with [o-series models](https://developers.openai.com/api/docs/guides/reasoning). type: integer nullable: true deprecated: true x-providers: openai: to: - max_completion_tokens gemini: to: - generationConfig - maxOutputTokens vertex: to: - generationConfig - maxOutputTokens 'n': type: integer minimum: 1 maximum: 128 default: 1 example: 1 nullable: true description: >- How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs. prediction: nullable: true description: > Configuration for a [Predicted Output](https://developers.openai.com/api/docs/guides/predicted-outputs), which can greatly improve response times when large parts of the model response are known ahead of time. This is most common when you are regenerating a file with only minor changes to most of the content. oneOf: - $ref: '#/components/schemas/PredictionContent' seed: type: integer minimum: -9223372036854776000 maximum: 9223372036854776000 nullable: true deprecated: true description: > This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. stream_options: $ref: '#/components/schemas/ChatCompletionStreamOptions' tools: type: array description: > A list of tools the model may call. You can provide either [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools) or [function tools](https://developers.openai.com/api/docs/guides/function-calling). items: oneOf: - $ref: '#/components/schemas/ChatCompletionTool' - $ref: '#/components/schemas/CustomToolChatCompletions' x-providers: anthropic: transform: openai_tools_to_anthropic_tools bedrock: transform: openai_tools_to_anthropic_tools gemini: to: - tools transform: openai_tools_to_gemini_tools vertex: to: - tools transform: openai_tools_to_gemini_tools tool_choice: $ref: '#/components/schemas/ChatCompletionToolChoiceOption' parallel_tool_calls: $ref: '#/components/schemas/ParallelToolCalls' function_call: deprecated: true description: > Deprecated in favor of `tool_choice`. Controls which (if any) function is called by the model. `none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function. Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. `none` is the default when no functions are present. `auto` is the default if functions are present. oneOf: - type: string description: > `none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function. enum: - none - auto - $ref: '#/components/schemas/ChatCompletionFunctionCallOption' functions: deprecated: true description: | Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for. type: array minItems: 1 maxItems: 128 items: $ref: '#/components/schemas/ChatCompletionFunctions' required: - model - messages x-source: from: avs://openai/official authority: official properties: top_k: type: integer minimum: 0 description: | Top-K sampling — only the K highest-probability tokens are considered. Passed through to Anthropic (pre-Claude-Opus-4.6) / Gemini / Vertex / Cohere. Ignored by OpenAI / Azure. x-source: from: gateway authority: derived x-providers-default: drop x-providers: anthropic: {} bedrock: {} cohere: {} gemini: to: - generationConfig - topK vertex: to: - generationConfig - topK CreateChatCompletionResponse: type: object description: >- Represents a chat completion response returned by model, based on the provided input. properties: id: type: string description: A unique identifier for the chat completion. choices: type: array description: >- A list of chat completion choices. Can be more than one if `n` is greater than 1. items: type: object required: - finish_reason - index - message - logprobs properties: finish_reason: type: string description: > The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function. enum: - stop - length - tool_calls - content_filter - function_call index: type: integer description: The index of the choice in the list of choices. message: $ref: '#/components/schemas/ChatCompletionResponseMessage' logprobs: anyOf: - description: Log probability information for the choice. type: object properties: content: anyOf: - description: >- A list of message content tokens with log probability information. type: array items: $ref: '#/components/schemas/ChatCompletionTokenLogprob' - type: 'null' refusal: anyOf: - description: >- A list of message refusal tokens with log probability information. type: array items: $ref: '#/components/schemas/ChatCompletionTokenLogprob' - type: 'null' required: - content - refusal - type: 'null' created: type: integer format: unixtime description: >- The Unix timestamp (in seconds) of when the chat completion was created. model: type: string description: The model used for the chat completion. service_tier: $ref: '#/components/schemas/ServiceTier' system_fingerprint: type: string deprecated: true description: > This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. object: type: string description: The object type, which is always `chat.completion`. enum: - chat.completion usage: $ref: '#/components/schemas/CompletionUsage' required: - choices - created - id - model - object x-source: from: avs://openai/official authority: official CreateChatCompletionStreamResponse: type: object description: > Represents a streamed chunk of a chat completion response returned by the model, based on the provided input. [Learn more](https://developers.openai.com/api/docs/guides/streaming-responses). properties: id: type: string description: >- A unique identifier for the chat completion. Each chunk has the same ID. choices: type: array description: > A list of chat completion choices. Can contain more than one elements if `n` is greater than 1. Can also be empty for the last chunk if you set `stream_options: {"include_usage": true}`. items: type: object required: - delta - finish_reason - index properties: delta: $ref: '#/components/schemas/ChatCompletionStreamResponseDelta' logprobs: description: Log probability information for the choice. type: object nullable: true properties: content: description: >- A list of message content tokens with log probability information. type: array items: $ref: '#/components/schemas/ChatCompletionTokenLogprob' nullable: true refusal: description: >- A list of message refusal tokens with log probability information. type: array items: $ref: '#/components/schemas/ChatCompletionTokenLogprob' nullable: true required: - content - refusal finish_reason: type: string description: > The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function. enum: - stop - length - tool_calls - content_filter - function_call nullable: true index: type: integer description: The index of the choice in the list of choices. created: type: integer format: unixtime description: >- The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp. model: type: string description: The model to generate the completion. service_tier: $ref: '#/components/schemas/ServiceTier' system_fingerprint: type: string deprecated: true description: > This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. object: type: string description: The object type, which is always `chat.completion.chunk`. enum: - chat.completion.chunk usage: $ref: '#/components/schemas/CompletionUsage' nullable: true description: > An optional field that will only be present when you set `stream_options: {"include_usage": true}` in your request. When present, it contains a null value **except for the last chunk** which contains the token usage statistics for the entire request. **NOTE:** If the stream is interrupted or cancelled, you may not receive the final usage chunk which contains the total token usage for the request. required: - choices - created - id - model - object x-source: from: avs://openai/official authority: official GatewayError: type: object description: | OpenAI-compatible error envelope. Top-level `error` object carrying `message` / `type` / `param` / `code`. `request_id` lives in the `X-Request-Id` response header, not in the body. The legacy `upstream` field is no longer emitted. x-source: from: gateway authority: gateway required: - error properties: error: type: object required: - message properties: message: type: string description: Human-readable error message. type: type: string nullable: true description: > Error category. OpenAI-compatible values include invalid_request_error / authentication_error / permission_error / not_found_error / rate_limit_error, etc. The upstream value is passed through verbatim; the enum is not fixed. param: type: string nullable: true description: Name of the offending field, when applicable. code: nullable: true description: | Sub-error code. May be a string or integer (the gateway treats `code` as an arbitrary type). CreateModelResponseProperties: allOf: - $ref: '#/components/schemas/ModelResponseProperties' - type: object properties: top_logprobs: description: > An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested. type: integer minimum: 0 maximum: 20 x-source: from: avs://openai/official authority: official ChatCompletionRequestMessage: oneOf: - $ref: '#/components/schemas/ChatCompletionRequestDeveloperMessage' - $ref: '#/components/schemas/ChatCompletionRequestSystemMessage' - $ref: '#/components/schemas/ChatCompletionRequestUserMessage' - $ref: '#/components/schemas/ChatCompletionRequestAssistantMessage' - $ref: '#/components/schemas/ChatCompletionRequestToolMessage' - $ref: '#/components/schemas/ChatCompletionRequestFunctionMessage' discriminator: propertyName: role x-source: from: avs://openai/official authority: official ModelIdsShared: example: gpt-5.4 anyOf: - type: string - type: string enum: - gpt-5.4 - gpt-5.4-mini - gpt-5.4-nano - gpt-5.4-mini-2026-03-17 - gpt-5.4-nano-2026-03-17 - gpt-5.3-chat-latest - gpt-5.2 - gpt-5.2-2025-12-11 - gpt-5.2-chat-latest - gpt-5.2-pro - gpt-5.2-pro-2025-12-11 - gpt-5.1 - gpt-5.1-2025-11-13 - gpt-5.1-codex - gpt-5.1-mini - gpt-5.1-chat-latest - gpt-5 - gpt-5-mini - gpt-5-nano - gpt-5-2025-08-07 - gpt-5-mini-2025-08-07 - gpt-5-nano-2025-08-07 - gpt-5-chat-latest - gpt-4.1 - gpt-4.1-mini - gpt-4.1-nano - gpt-4.1-2025-04-14 - gpt-4.1-mini-2025-04-14 - gpt-4.1-nano-2025-04-14 - o4-mini - o4-mini-2025-04-16 - o3 - o3-2025-04-16 - o3-mini - o3-mini-2025-01-31 - o1 - o1-2024-12-17 - o1-preview - o1-preview-2024-09-12 - o1-mini - o1-mini-2024-09-12 - gpt-4o - gpt-4o-2024-11-20 - gpt-4o-2024-08-06 - gpt-4o-2024-05-13 - gpt-4o-audio-preview - gpt-4o-audio-preview-2024-10-01 - gpt-4o-audio-preview-2024-12-17 - gpt-4o-audio-preview-2025-06-03 - gpt-4o-mini-audio-preview - gpt-4o-mini-audio-preview-2024-12-17 - gpt-4o-search-preview - gpt-4o-mini-search-preview - gpt-4o-search-preview-2025-03-11 - gpt-4o-mini-search-preview-2025-03-11 - chatgpt-4o-latest - codex-mini-latest - gpt-4o-mini - gpt-4o-mini-2024-07-18 - gpt-4-turbo - gpt-4-turbo-2024-04-09 - gpt-4-0125-preview - gpt-4-turbo-preview - gpt-4-1106-preview - gpt-4-vision-preview - gpt-4 - gpt-4-0314 - gpt-4-0613 - gpt-4-32k - gpt-4-32k-0314 - gpt-4-32k-0613 - gpt-3.5-turbo - gpt-3.5-turbo-16k - gpt-3.5-turbo-0301 - gpt-3.5-turbo-0613 - gpt-3.5-turbo-1106 - gpt-3.5-turbo-0125 - gpt-3.5-turbo-16k-0613 x-source: from: avs://openai/official authority: official ResponseModalities: anyOf: - type: array description: > Output types that you would like the model to generate. Most models are capable of generating text, which is the default: `["text"]` The `gpt-4o-audio-preview` model can also be used to [generate audio](https://developers.openai.com/api/docs/guides/audio). To request that this model generate both text and audio responses, you can use: `["text", "audio"]` items: type: string enum: - text - audio - type: 'null' x-source: from: avs://openai/official authority: official Verbosity: anyOf: - type: string enum: - low - medium - high default: medium description: > Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are `low`, `medium`, and `high`. - type: 'null' x-source: from: avs://openai/official authority: official ReasoningEffort: anyOf: - type: string enum: - none - minimal - low - medium - high - xhigh default: medium description: > Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. - `xhigh` is supported for all models after `gpt-5.1-codex-max`. - type: 'null' x-source: from: avs://openai/official authority: official WebSearchLocation: type: object title: Web search location description: Approximate location parameters for the search. properties: country: type: string description: > The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`. region: type: string description: | Free text input for the region of the user, e.g. `California`. city: type: string description: | Free text input for the city of the user, e.g. `San Francisco`. timezone: type: string description: > The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. x-source: from: avs://openai/official authority: official WebSearchContextSize: type: string description: > High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. enum: - low - medium - high default: medium x-source: from: avs://openai/official authority: official ResponseFormatText: type: object title: Text description: | Default response format. Used to generate text responses. properties: type: type: string description: The type of response format being defined. Always `text`. enum: - text required: - type x-source: from: avs://openai/official authority: official ResponseFormatJsonSchema: type: object title: JSON schema description: > JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs). properties: type: type: string description: The type of response format being defined. Always `json_schema`. enum: - json_schema json_schema: type: object title: JSON schema description: | Structured Outputs configuration options, including a JSON Schema. properties: description: type: string description: > A description of what the response format is for, used by the model to determine how to respond in the format. name: type: string description: > The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. schema: $ref: '#/components/schemas/ResponseFormatJsonSchemaSchema' strict: anyOf: - type: boolean default: false description: > Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. To learn more, read the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs). - type: 'null' required: - name required: - type - json_schema x-source: from: avs://openai/official authority: official ResponseFormatJsonObject: type: object title: JSON object description: > JSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so. properties: type: type: string description: The type of response format being defined. Always `json_object`. enum: - json_object required: - type x-source: from: avs://openai/official authority: official VoiceIdsOrCustomVoice: title: Voice description: | A built-in voice name or a custom voice reference. anyOf: - $ref: '#/components/schemas/VoiceIdsShared' - type: object description: Custom voice reference. additionalProperties: false required: - id properties: id: type: string description: The custom voice ID, e.g. `voice_1234`. example: voice_1234 x-source: from: avs://openai/official authority: official StopConfiguration: description: | Not supported with latest reasoning models `o3` and `o4-mini`. Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. default: null nullable: true oneOf: - type: string default: <|endoftext|> example: |+ nullable: true - type: array minItems: 1 maxItems: 4 items: type: string example: '["\n"]' x-source: from: avs://openai/official authority: official PredictionContent: type: object title: Static Content description: > Static predicted output content, such as the content of a text file that is being regenerated. required: - type - content properties: type: type: string enum: - content description: | The type of the predicted content you want to provide. This type is currently always `content`. content: description: > The content that should be matched when generating a model response. If generated tokens would match this content, the entire model response can be returned much more quickly. oneOf: - type: string title: Text content description: | The content used for a Predicted Output. This is often the text of a file you are regenerating with minor changes. - type: array description: >- An array of content parts with a defined type. Supported options differ based on the [model](https://developers.openai.com/api/docs/models) being used to generate the response. Can contain text inputs. title: Array of content parts items: $ref: >- #/components/schemas/ChatCompletionRequestMessageContentPartText minItems: 1 x-source: from: avs://openai/official authority: official ChatCompletionStreamOptions: anyOf: - description: > Options for streaming response. Only set this when you set `stream: true`. type: object default: null properties: include_usage: type: boolean description: > If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value. **NOTE:** If the stream is interrupted, you may not receive the final usage chunk which contains the total token usage for the request. include_obfuscation: type: boolean description: > When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an `obfuscation` field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set `include_obfuscation` to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API. - type: 'null' x-source: from: avs://openai/official authority: official ChatCompletionTool: type: object title: Function tool description: | A function tool that can be used to generate a response. properties: type: type: string enum: - function description: The type of the tool. Currently, only `function` is supported. function: $ref: '#/components/schemas/FunctionObject' cache_control: additionalProperties: false properties: ttl: description: |- The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. enum: - 5m - 1h title: Ttl type: string type: const: ephemeral title: Type type: string required: - type title: CacheControlEphemeral type: object description: | Per-tool prompt-cache breakpoint. When set on a tool, everything from the conversation start up through that tool definition is cached. Currently supported for Anthropic / Bedrock only. x-source: from: avs://anthropic/official authority: official required: - type - function x-source: from: avs://openai/official authority: official CustomToolChatCompletions: type: object title: Custom tool description: | A custom tool that processes input using a specified format. properties: type: type: string enum: - custom description: The type of the custom tool. Always `custom`. custom: type: object title: Custom tool properties description: | Properties of the custom tool. properties: name: type: string description: The name of the custom tool, used to identify it in tool calls. description: type: string description: > Optional description of the custom tool, used to provide more context. format: description: > The input format for the custom tool. Default is unconstrained text. oneOf: - type: object title: Text format description: Unconstrained free-form text. properties: type: type: string enum: - text description: Unconstrained text format. Always `text`. required: - type additionalProperties: false - type: object title: Grammar format description: A grammar defined by the user. properties: type: type: string enum: - grammar description: Grammar format. Always `grammar`. grammar: type: object title: Grammar format description: Your chosen grammar. properties: definition: type: string description: The grammar definition. syntax: type: string description: >- The syntax of the grammar definition. One of `lark` or `regex`. enum: - lark - regex required: - definition - syntax required: - type - grammar additionalProperties: false required: - name required: - type - custom x-source: from: avs://openai/official authority: official ChatCompletionToolChoiceOption: description: > Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. `none` is the default when no tools are present. `auto` is the default if tools are present. oneOf: - type: string title: Tool choice mode description: > `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools. enum: - none - auto - required - $ref: '#/components/schemas/ChatCompletionAllowedToolsChoice' - $ref: '#/components/schemas/ChatCompletionNamedToolChoice' - $ref: '#/components/schemas/ChatCompletionNamedToolChoiceCustom' x-source: from: avs://openai/official authority: official ParallelToolCalls: description: >- Whether to enable [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. type: boolean default: true x-source: from: avs://openai/official authority: official ChatCompletionFunctionCallOption: type: object description: > Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. properties: name: type: string description: The name of the function to call. required: - name x-source: from: avs://openai/official authority: official ChatCompletionFunctions: type: object deprecated: true properties: description: type: string description: >- A description of what the function does, used by the model to choose when and how to call the function. name: type: string description: >- The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. parameters: $ref: '#/components/schemas/FunctionParameters' required: - name x-source: from: avs://openai/official authority: official ChatCompletionResponseMessage: type: object description: A chat completion message generated by the model. properties: content: anyOf: - type: string description: The contents of the message. - type: 'null' refusal: anyOf: - type: string description: The refusal message generated by the model. - type: 'null' tool_calls: $ref: '#/components/schemas/ChatCompletionMessageToolCalls' annotations: type: array description: > Annotations for the message, when applicable, as when using the [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search?api-mode=chat). items: type: object description: | A URL citation when using web search. required: - type - url_citation properties: type: type: string description: The type of the URL citation. Always `url_citation`. enum: - url_citation url_citation: type: object description: A URL citation when using web search. required: - end_index - start_index - url - title properties: end_index: type: integer description: >- The index of the last character of the URL citation in the message. start_index: type: integer description: >- The index of the first character of the URL citation in the message. url: type: string format: uri description: The URL of the web resource. title: type: string description: The title of the web resource. role: type: string enum: - assistant description: The role of the author of this message. function_call: type: object deprecated: true description: >- Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model. properties: arguments: type: string description: >- The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. name: type: string description: The name of the function to call. required: - name - arguments audio: anyOf: - type: object description: > If the audio output modality is requested, this object contains data about the audio response from the model. [Learn more](https://developers.openai.com/api/docs/guides/audio). required: - id - expires_at - data - transcript properties: id: type: string description: Unique identifier for this audio response. expires_at: type: integer format: unixtime description: > The Unix timestamp (in seconds) for when this audio response will no longer be accessible on the server for use in multi-turn conversations. data: type: string description: > Base64 encoded audio bytes generated by the model, in the format specified in the request. transcript: type: string description: Transcript of the audio generated by the model. - type: 'null' reasoning_content: type: string nullable: true description: > Model-generated reasoning text (thinking / chain-of-thought). Streams independently of `content`. Also accepted on the request side to replay the previous assistant turn's reasoning in multi-turn conversations. x-source: from: gateway authority: gateway x-providers-default: drop x-providers: anthropic: from: - content - '*' - thinking transform: extract_thinking_text bedrock: from: - content - '*' - thinking transform: extract_thinking_text deepseek: from: - choices - '0' - message - reasoning_content reasoning_details: type: array nullable: true description: | Structured reasoning trace. Each element mirrors the upstream shape (Anthropic thinking block / OpenAI Responses reasoning item / Gemini thought) — no fixed schema; branch on the `type` field. items: type: object additionalProperties: true x-source: from: gateway authority: gateway x-providers-default: drop x-providers: anthropic: from: - content transform: anthropic_thinking_to_reasoning_details bedrock: from: - content transform: anthropic_thinking_to_reasoning_details gemini: from: - candidates - '0' - content - parts transform: gemini_thoughts_to_reasoning_details required: - role - content - refusal x-source: from: avs://openai/official authority: official ChatCompletionTokenLogprob: type: object properties: token: description: The token. type: string logprob: description: >- The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely. type: number bytes: anyOf: - description: >- A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. type: array items: type: integer - type: 'null' top_logprobs: description: >- List of the most likely tokens and their log probability, at this token position. The number of entries may be fewer than the requested `top_logprobs`. type: array items: type: object properties: token: description: The token. type: string logprob: description: >- The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely. type: number bytes: anyOf: - description: >- A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. type: array items: type: integer - type: 'null' required: - token - logprob - bytes required: - token - logprob - bytes - top_logprobs x-source: from: avs://openai/official authority: official ServiceTier: anyOf: - type: string description: | Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://developers.openai.com/api/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. - When not set, the default behavior is 'auto'. When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. enum: - auto - default - flex - scale - priority default: auto - type: 'null' x-source: from: avs://openai/official authority: official CompletionUsage: type: object description: Usage statistics for the completion request. properties: completion_tokens: type: integer default: 0 description: Number of tokens in the generated completion. prompt_tokens: type: integer default: 0 description: Number of tokens in the prompt. total_tokens: type: integer default: 0 description: Total number of tokens used in the request (prompt + completion). completion_tokens_details: type: object description: Breakdown of tokens used in a completion. properties: accepted_prediction_tokens: type: integer default: 0 description: | When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion. audio_tokens: type: integer default: 0 description: Audio input tokens generated by the model. reasoning_tokens: type: integer default: 0 description: Tokens generated by the model for reasoning. rejected_prediction_tokens: type: integer default: 0 description: > When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits. prompt_tokens_details: type: object description: Breakdown of tokens used in the prompt. properties: audio_tokens: type: integer default: 0 description: Audio input tokens present in the prompt. cached_tokens: type: integer default: 0 description: Cached tokens present in the prompt. required: - prompt_tokens - completion_tokens - total_tokens x-source: from: avs://openai/official authority: official ChatCompletionStreamResponseDelta: type: object description: A chat completion delta generated by streamed model responses. properties: content: anyOf: - type: string description: The contents of the chunk message. - type: 'null' function_call: deprecated: true type: object description: >- Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model. properties: arguments: type: string description: >- The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. name: type: string description: The name of the function to call. tool_calls: type: array items: $ref: '#/components/schemas/ChatCompletionMessageToolCallChunk' role: type: string enum: - developer - system - user - assistant - tool description: The role of the author of this message. refusal: anyOf: - type: string description: The refusal message generated by the model. - type: 'null' x-source: from: avs://openai/official authority: official ModelResponseProperties: type: object properties: metadata: $ref: '#/components/schemas/Metadata' top_logprobs: anyOf: - description: > An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested. type: integer minimum: 0 maximum: 20 - type: 'null' temperature: anyOf: - type: number minimum: 0 maximum: 2 default: 1 example: 1 description: > What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. - type: 'null' x-providers: gemini: to: - generationConfig - temperature vertex: to: - generationConfig - temperature top_p: anyOf: - type: number minimum: 0 maximum: 1 default: 1 example: 1 description: > An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - type: 'null' x-providers: gemini: to: - generationConfig - topP vertex: to: - generationConfig - topP user: type: string example: user-1234 deprecated: true description: > This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#safety-identifiers). safety_identifier: type: string maxLength: 64 example: safety-identifier-1234 description: > A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string example: prompt-cache-key-1234 description: > Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/ServiceTier' prompt_cache_retention: anyOf: - type: string enum: - in_memory - 24h description: > The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention). - type: 'null' x-source: from: avs://openai/official authority: official ChatCompletionRequestDeveloperMessage: type: object title: Developer message description: > Developer-provided instructions that the model should follow, regardless of messages sent by the user. With o1 models and newer, `developer` messages replace the previous `system` messages. properties: content: description: The contents of the developer message. oneOf: - type: string description: The contents of the developer message. title: Text content - type: array description: >- An array of content parts with a defined type. For developer messages, only type `text` is supported. title: Array of content parts items: $ref: >- #/components/schemas/ChatCompletionRequestMessageContentPartText minItems: 1 role: type: string enum: - developer description: The role of the messages author, in this case `developer`. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. required: - content - role x-source: from: avs://openai/official authority: official ChatCompletionRequestSystemMessage: type: object title: System message description: > Developer-provided instructions that the model should follow, regardless of messages sent by the user. With o1 models and newer, use `developer` messages for this purpose instead. properties: content: description: The contents of the system message. oneOf: - type: string description: The contents of the system message. title: Text content - type: array description: >- An array of content parts with a defined type. For system messages, only type `text` is supported. title: Array of content parts items: $ref: >- #/components/schemas/ChatCompletionRequestSystemMessageContentPart minItems: 1 role: type: string enum: - system description: The role of the messages author, in this case `system`. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. required: - content - role x-source: from: avs://openai/official authority: official ChatCompletionRequestUserMessage: type: object title: User message description: | Messages sent by an end user, containing prompts or additional context information. properties: content: description: | The contents of the user message. oneOf: - type: string description: The text contents of the message. title: Text content - type: array description: >- An array of content parts with a defined type. Supported options differ based on the [model](https://developers.openai.com/api/docs/models) being used to generate the response. Can contain text, image, or audio inputs. title: Array of content parts items: $ref: >- #/components/schemas/ChatCompletionRequestUserMessageContentPart minItems: 1 role: type: string enum: - user description: The role of the messages author, in this case `user`. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. required: - content - role x-source: from: avs://openai/official authority: official ChatCompletionRequestAssistantMessage: type: object title: Assistant message description: | Messages sent by the model in response to user messages. properties: content: anyOf: - oneOf: - type: string description: The contents of the assistant message. title: Text content - type: array description: >- An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`. title: Array of content parts items: $ref: >- #/components/schemas/ChatCompletionRequestAssistantMessageContentPart minItems: 1 description: > The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified. - type: 'null' refusal: anyOf: - type: string description: The refusal message by the assistant. - type: 'null' role: type: string enum: - assistant description: The role of the messages author, in this case `assistant`. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. audio: anyOf: - type: object description: > Data about a previous audio response from the model. [Learn more](https://developers.openai.com/api/docs/guides/audio). required: - id properties: id: type: string description: > Unique identifier for a previous audio response from the model. - type: 'null' tool_calls: $ref: '#/components/schemas/ChatCompletionMessageToolCalls' function_call: anyOf: - type: object deprecated: true description: >- Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model. properties: arguments: type: string description: >- The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. name: type: string description: The name of the function to call. required: - arguments - name - type: 'null' reasoning_content: type: string nullable: true description: > Model-generated reasoning text (thinking / chain-of-thought). Streams independently of `content`. Also accepted on the request side to replay the previous assistant turn's reasoning in multi-turn conversations. x-source: from: gateway authority: gateway x-providers-default: drop x-providers: anthropic: from: - content - '*' - thinking transform: extract_thinking_text bedrock: from: - content - '*' - thinking transform: extract_thinking_text deepseek: from: - choices - '0' - message - reasoning_content reasoning_details: type: array nullable: true description: | Structured reasoning trace. Each element mirrors the upstream shape (Anthropic thinking block / OpenAI Responses reasoning item / Gemini thought) — no fixed schema; branch on the `type` field. items: type: object additionalProperties: true x-source: from: gateway authority: gateway x-providers-default: drop x-providers: anthropic: from: - content transform: anthropic_thinking_to_reasoning_details bedrock: from: - content transform: anthropic_thinking_to_reasoning_details gemini: from: - candidates - '0' - content - parts transform: gemini_thoughts_to_reasoning_details required: - role x-source: from: avs://openai/official authority: official ChatCompletionRequestToolMessage: type: object title: Tool message properties: role: type: string enum: - tool description: The role of the messages author, in this case `tool`. content: oneOf: - type: string description: The contents of the tool message. title: Text content - type: array description: >- An array of content parts with a defined type. For tool messages, only type `text` is supported. title: Array of content parts items: $ref: >- #/components/schemas/ChatCompletionRequestToolMessageContentPart minItems: 1 description: The contents of the tool message. tool_call_id: type: string description: Tool call that this message is responding to. required: - role - content - tool_call_id x-source: from: avs://openai/official authority: official ChatCompletionRequestFunctionMessage: type: object title: Function message deprecated: true properties: role: type: string enum: - function description: The role of the messages author, in this case `function`. content: anyOf: - type: string description: The contents of the function message. - type: 'null' name: type: string description: The name of the function to call. required: - role - content - name x-source: from: avs://openai/official authority: official ResponseFormatJsonSchemaSchema: type: object title: JSON schema description: | The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). additionalProperties: true x-source: from: avs://openai/official authority: official VoiceIdsShared: example: ash anyOf: - type: string - type: string enum: - alloy - ash - ballad - coral - echo - sage - shimmer - verse - marin - cedar x-source: from: avs://openai/official authority: official ChatCompletionRequestMessageContentPartText: type: object title: Text content part description: > Learn about [text inputs](https://developers.openai.com/api/docs/guides/text-generation). properties: type: type: string enum: - text description: The type of the content part. text: type: string description: The text content. cache_control: additionalProperties: false properties: ttl: description: |- The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. enum: - 5m - 1h title: Ttl type: string type: const: ephemeral title: Type type: string required: - type title: CacheControlEphemeral type: object description: | Anthropic prompt-cache breakpoint. When set on a content block, everything from the conversation start up through that block is cached on Anthropic's servers (5m or 1h TTL — see the `ttl` field). Currently supported for Anthropic / Bedrock only; ignored by other providers. x-source: from: avs://anthropic/official authority: official x-providers-default: drop x-providers: anthropic: {} bedrock: {} required: - type - text x-source: from: avs://openai/official authority: official FunctionObject: type: object properties: description: type: string description: >- A description of what the function does, used by the model to choose when and how to call the function. name: type: string description: >- The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. parameters: $ref: '#/components/schemas/FunctionParameters' strict: anyOf: - type: boolean default: false description: >- Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://developers.openai.com/api/docs/guides/function-calling). - type: 'null' required: - name x-source: from: avs://openai/official authority: official ChatCompletionAllowedToolsChoice: type: object title: Allowed tools description: | Constrains the tools available to the model to a pre-defined set. properties: type: type: string enum: - allowed_tools description: Allowed tool configuration type. Always `allowed_tools`. allowed_tools: $ref: '#/components/schemas/ChatCompletionAllowedTools' required: - type - allowed_tools x-source: from: avs://openai/official authority: official ChatCompletionNamedToolChoice: type: object title: Function tool choice description: >- Specifies a tool the model should use. Use to force the model to call a specific function. properties: type: type: string enum: - function description: For function calling, the type is always `function`. function: type: object properties: name: type: string description: The name of the function to call. required: - name required: - type - function x-source: from: avs://openai/official authority: official ChatCompletionNamedToolChoiceCustom: type: object title: Custom tool choice description: >- Specifies a tool the model should use. Use to force the model to call a specific custom tool. properties: type: type: string enum: - custom description: For custom tool calling, the type is always `custom`. custom: type: object properties: name: type: string description: The name of the custom tool to call. required: - name required: - type - custom x-source: from: avs://openai/official authority: official FunctionParameters: type: object description: >- The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://developers.openai.com/api/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. additionalProperties: true x-source: from: avs://openai/official authority: official ChatCompletionMessageToolCalls: type: array description: The tool calls generated by the model, such as function calls. items: oneOf: - $ref: '#/components/schemas/ChatCompletionMessageToolCall' - $ref: '#/components/schemas/ChatCompletionMessageCustomToolCall' discriminator: propertyName: type x-source: from: avs://openai/official authority: official ChatCompletionMessageToolCallChunk: type: object properties: index: type: integer id: type: string description: The ID of the tool call. type: type: string enum: - function description: The type of the tool. Currently, only `function` is supported. function: type: object properties: name: type: string description: The name of the function to call. arguments: type: string description: >- The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. required: - index x-source: from: avs://openai/official authority: official Metadata: anyOf: - type: object description: > Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. additionalProperties: type: string - type: 'null' x-source: from: avs://openai/official authority: official ChatCompletionRequestSystemMessageContentPart: oneOf: - $ref: '#/components/schemas/ChatCompletionRequestMessageContentPartText' x-source: from: avs://openai/official authority: official ChatCompletionRequestUserMessageContentPart: oneOf: - $ref: '#/components/schemas/ChatCompletionRequestMessageContentPartText' - $ref: '#/components/schemas/ChatCompletionRequestMessageContentPartImage' - $ref: '#/components/schemas/ChatCompletionRequestMessageContentPartAudio' - $ref: '#/components/schemas/ChatCompletionRequestMessageContentPartFile' x-source: from: avs://openai/official authority: official ChatCompletionRequestAssistantMessageContentPart: oneOf: - $ref: '#/components/schemas/ChatCompletionRequestMessageContentPartText' - $ref: '#/components/schemas/ChatCompletionRequestMessageContentPartRefusal' discriminator: propertyName: type x-source: from: avs://openai/official authority: official ChatCompletionRequestToolMessageContentPart: oneOf: - $ref: '#/components/schemas/ChatCompletionRequestMessageContentPartText' x-source: from: avs://openai/official authority: official ChatCompletionAllowedTools: type: object title: Allowed tools description: | Constrains the tools available to the model to a pre-defined set. properties: mode: type: string enum: - auto - required description: > Constrains the tools available to the model to a pre-defined set. `auto` allows the model to pick from among the allowed tools and generate a message. `required` requires the model to call one or more of the allowed tools. tools: type: array description: > A list of tool definitions that the model should be allowed to call. For the Chat Completions API, the list of tool definitions might look like: ```json [ { "type": "function", "function": { "name": "get_weather" } }, { "type": "function", "function": { "name": "get_time" } } ] ``` items: type: object description: | A tool definition that the model should be allowed to call. additionalProperties: true required: - mode - tools x-source: from: avs://openai/official authority: official ChatCompletionMessageToolCall: type: object title: Function tool call description: | A call to a function tool created by the model. properties: id: type: string description: The ID of the tool call. type: type: string enum: - function description: The type of the tool. Currently, only `function` is supported. function: type: object description: The function that the model called. properties: name: type: string description: The name of the function to call. arguments: type: string description: >- The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. required: - name - arguments required: - id - type - function x-source: from: avs://openai/official authority: official ChatCompletionMessageCustomToolCall: type: object title: Custom tool call description: | A call to a custom tool created by the model. properties: id: type: string description: The ID of the tool call. type: type: string enum: - custom description: The type of the tool. Always `custom`. custom: type: object description: The custom tool that the model called. properties: name: type: string description: The name of the custom tool to call. input: type: string description: The input for the custom tool call generated by the model. required: - name - input required: - id - type - custom x-source: from: avs://openai/official authority: official ChatCompletionRequestMessageContentPartImage: type: object title: Image content part description: > Learn about [image inputs](https://developers.openai.com/api/docs/guides/vision). properties: type: type: string enum: - image_url description: The type of the content part. image_url: type: object properties: url: type: string description: Either a URL of the image or the base64 encoded image data. format: uri detail: type: string description: >- Specifies the detail level of the image. Learn more in the [Vision guide](https://developers.openai.com/api/docs/guides/vision#low-or-high-fidelity-image-understanding). enum: - auto - low - high default: auto required: - url cache_control: additionalProperties: false properties: ttl: description: |- The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. enum: - 5m - 1h title: Ttl type: string type: const: ephemeral title: Type type: string required: - type title: CacheControlEphemeral type: object description: | Anthropic prompt-cache breakpoint. When set on a content block, everything from the conversation start up through that block is cached on Anthropic's servers (5m or 1h TTL — see the `ttl` field). Currently supported for Anthropic / Bedrock only; ignored by other providers. x-source: from: avs://anthropic/official authority: official x-providers-default: drop x-providers: anthropic: {} bedrock: {} required: - type - image_url x-source: from: avs://openai/official authority: official ChatCompletionRequestMessageContentPartAudio: type: object title: Audio content part description: > Learn about [audio inputs](https://developers.openai.com/api/docs/guides/audio). properties: type: type: string enum: - input_audio description: The type of the content part. Always `input_audio`. input_audio: type: object properties: data: type: string description: Base64 encoded audio data. format: type: string enum: - wav - mp3 description: > The format of the encoded audio data. Currently supports "wav" and "mp3". required: - data - format cache_control: additionalProperties: false properties: ttl: description: |- The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. enum: - 5m - 1h title: Ttl type: string type: const: ephemeral title: Type type: string required: - type title: CacheControlEphemeral type: object description: | Anthropic prompt-cache breakpoint. When set on a content block, everything from the conversation start up through that block is cached on Anthropic's servers (5m or 1h TTL — see the `ttl` field). Currently supported for Anthropic / Bedrock only; ignored by other providers. x-source: from: avs://anthropic/official authority: official x-providers-default: drop x-providers: anthropic: {} bedrock: {} required: - type - input_audio x-source: from: avs://openai/official authority: official ChatCompletionRequestMessageContentPartFile: type: object title: File content part description: > Learn about [file inputs](https://developers.openai.com/api/docs/guides/text) for text generation. properties: type: type: string enum: - file description: The type of the content part. Always `file`. file: type: object properties: filename: type: string description: > The name of the file, used when passing the file to the model as a string. file_data: type: string description: > The base64 encoded file data, used when passing the file to the model as a string. file_id: type: string description: | The ID of an uploaded file to use as input. cache_control: additionalProperties: false properties: ttl: description: |- The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. enum: - 5m - 1h title: Ttl type: string type: const: ephemeral title: Type type: string required: - type title: CacheControlEphemeral type: object description: | Anthropic prompt-cache breakpoint. When set on a content block, everything from the conversation start up through that block is cached on Anthropic's servers (5m or 1h TTL — see the `ttl` field). Currently supported for Anthropic / Bedrock only; ignored by other providers. x-source: from: avs://anthropic/official authority: official x-providers-default: drop x-providers: anthropic: {} bedrock: {} required: - type - file x-source: from: avs://openai/official authority: official ChatCompletionRequestMessageContentPartRefusal: type: object title: Refusal content part properties: type: type: string enum: - refusal description: The type of the content part. refusal: type: string description: The refusal message generated by the model. required: - type - refusal x-source: from: avs://openai/official authority: official securitySchemes: gatewayBearer: type: http scheme: bearer bearerFormat: API Key description: | Gateway-issued API key, formatted as `sk-gateway-xxxxxxxx`. Used by OpenAI-shaped endpoints (/v1/chat/completions, etc.). x-source: from: gateway authority: gateway ````