# OpenAI API Compatibility ## Request Address ```bash https://api.xiaomimimo.com/v1/chat/completions ``` ## Request Headers The API supports the following two authentication methods. Please choose one and add it to the request headers: 1. Method 1: `api-key` field authentication, format: ```json api-key: $MIMO_API_KEY Content-Type: application/json ``` 1. Method 2: `Authorization: Bearer` authentication, format: ```json Authorization: Bearer $MIMO_API_KEY Content-Type: application/json ``` ## Request body text is supported.", "children": [ { "name": "Text content part", "type": "object", "isBold": false, "children": [ { "name": "text", "type": "string", "isBold": true, "required": true, "description": "The text content." }, { "name": "type", "type": "string", "isBold": true, "required": true, "description": "The type of the content part." } ] } ] } ] }, { "name": "role", "type": "string", "isBold": true, "required": true, "description": "The role of the message author.
Available options: developer" }, { "name": "name", "type": "string", "isBold": true, "required": false, "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." } ] }, { "name": "System message", "type": "object", "isBold": false, "description": "Developer-provided instructions that the model should follow, regardless of messages sent by the user.", "children": [ { "name": "content", "type": [ "string", "array" ], "isBold": true, "required": true, "description": "The contents of the system message.", "children": [ { "name": "Text content", "type": "string", "isBold": false, "description": "The contents of the system message." }, { "name": "Array of content parts", "type": "array", "isBold": false, "description": "An array of content parts with a defined type. For system messages, only type text is supported.", "children": [ { "name": "Text content part", "type": "object", "isBold": false, "children": [ { "name": "text", "type": "string", "isBold": true, "required": true, "description": "The text content." }, { "name": "type", "type": "string", "isBold": true, "required": true, "description": "The type of the content part." } ] } ] } ] }, { "name": "role", "type": "string", "isBold": true, "required": true, "description": "Role of the message author.
Available options: system" }, { "name": "name", "type": "string", "isBold": true, "required": false, "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." } ] }, { "name": "User message", "type": "object", "isBold": false, "description": "Messages sent by an end user, containing prompts or additional context information.", "children": [ { "name": "content", "type": [ "string", "array" ], "isBold": true, "required": true, "description": "The contents of the user message.
Note: When generating audio using the mimo-v2.5-tts-voicedesign model, messages with role user are required. You may provide an assistant role message to specify the text for audio synthesis. If optimize_text_preview is set to true, the assistant message can be omitted. Moreover, audio parameters can be configured via audio. For detailed usage, please refer to Speech Synthesis.
", "children": [ { "name": "Text content", "type": "string", "isBold": false, "description": "The text contents of the message." }, { "name": "Array of content parts", "type": "array", "isBold": false, "description": "An array of content parts with a defined type. Supported options differ based on the model being used to generate the response. Can contain text, image, audio or video inputs.
Currently, only the mimo-v2.5 and mimo-v2-omni models support image, audio, or video input.
", "children": [ { "name": "Text content part", "type": "object", "isBold": false, "children": [ { "name": "text", "type": "string", "isBold": true, "required": true, "description": "The text content." }, { "name": "type", "type": "string", "isBold": true, "required": true, "description": "The type of the content part." } ] }, { "name": "Image content part", "type": "object", "isBold": false, "children": [ { "name": "image_url", "type": "object", "isBold": true, "required": true, "children": [ { "name": "url", "type": "string", "isBold": true, "required": true, "description": "Either a URL of the image or the base64 encoded image data." } ] }, { "name": "type", "type": "string", "isBold": true, "required": true, "description": "The type of the content part.
Available options: image_url" } ] }, { "name": "Audio content part", "type": "object", "isBold": false, "children": [ { "name": "input_audio", "type": "object", "isBold": true, "required": true, "children": [ { "name": "data", "type": "string", "isBold": true, "required": true, "description": "Either a URL of the audio or the base64 encoded audio data." } ] }, { "name": "type", "type": "string", "isBold": true, "required": true, "description": "The type of the content part.
Available options: input_audio" } ] }, { "name": "Video content part", "type": "object", "isBold": false, "children": [ { "name": "video_url", "type": "object", "isBold": true, "required": true, "children": [ { "name": "url", "type": "string", "isBold": true, "required": true, "description": "Either a URL of the video or the base64 encoded video data." } ] }, { "name": "fps", "type": "number", "isBold": true, "required": false, "defaultValue": "2", "description": "Number of frames sampled per second.
Required range: [0.1, 10.0]" }, { "name": "media_resolution", "type": "string", "isBold": true, "required": false, "defaultValue": "default", "description": "Resolution level.
Available options: default, max" }, { "name": "type", "type": "string", "isBold": true, "required": true, "description": "The type of the content part.
Available options: video_url" } ] } ] } ] }, { "name": "role", "type": "string", "isBold": true, "required": true, "description": "Role of the message author.
Available options: user" }, { "name": "name", "type": "string", "isBold": true, "required": false, "description": "An optional name for the participant. Provides model information to differentiate between participants of the same role." } ] }, { "name": "Assistant message", "type": "object", "isBold": false, "description": "Messages sent by the model in response to user messages.", "children": [ { "name": "role", "type": "string", "isBold": true, "required": true, "description": "Role of the message author.
Available options: assistant" }, { "name": "content", "type": [ "string", "array" ], "isBold": true, "required": false, "description": "The contents of the assistant message. Required unless tool_calls is specified.
Note: To generate audio, you must add a message with role set to assistant, which needs to specify the text for speech synthesis. When using the mimo-v2.5-tts-voicedesign model, a message with the role of user is required. If optimize_text_preview is set to true, the assistant message can be omitted. Additionally, audio parameters can be configured via audio. For detailed usage, please refer to Speech Synthesis.
", "children": [ { "name": "Text content", "type": "string", "isBold": false, "description": "The contents of the assistant message." }, { "name": "Array of content parts", "type": "array", "isBold": false, "description": "An array of content parts with a defined type. Can be one or more of type text.", "children": [ { "name": "Text content part", "type": "object", "isBold": false, "children": [ { "name": "text", "type": "string", "isBold": true, "required": true, "description": "The text content." }, { "name": "type", "type": "string", "isBold": true, "required": true, "description": "The type of the content part." } ] } ] } ] }, { "name": "name", "type": "string", "isBold": true, "required": false, "description": "An optional name for the participant. Provides model information to differentiate between participants of the same role." }, { "name": "tool_calls", "type": "array", "isBold": true, "required": false, "description": "The tool calls generated by the model, such as function calls.", "children": [ { "name": "Function tool call", "type": "object", "isBold": false, "description": "A call to a function tool created by the model.", "children": [ { "name": "function", "type": "object", "isBold": true, "required": true, "description": "The function that the model called.", "children": [ { "name": "arguments", "type": "string", "isBold": true, "required": true, "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": "name", "type": "string", "isBold": true, "required": true, "description": "The name of the function to call." } ] }, { "name": "id", "type": "string", "isBold": true, "required": true, "description": "The ID of the tool call." }, { "name": "type", "type": "string", "isBold": true, "required": true, "description": "Tool type. Currently, only function is supported." } ] } ] } ] }, { "name": "Tool message", "type": "object", "isBold": false, "children": [ { "name": "content", "type": [ "string", "array" ], "isBold": true, "required": true, "description": "The contents of the tool message.", "children": [ { "name": "Text content", "type": "string", "isBold": false, "description": "The contents of the tool message." }, { "name": "Array of content parts", "type": "array", "isBold": false, "description": "An array of content parts with a defined type. For tool messages, only type text is supported.", "children": [ { "name": "Text content part", "type": "object", "isBold": false, "children": [ { "name": "text", "type": "string", "isBold": true, "required": true, "description": "The text content." }, { "name": "type", "type": "string", "isBold": true, "required": true, "description": "The type of the content part." } ] } ] } ] }, { "name": "role", "type": "string", "isBold": true, "required": true, "description": "Role of the message author.
Available options: tool" }, { "name": "tool_call_id", "type": "string", "isBold": true, "required": true, "description": "Tool call that this message is responding to." } ] } ] }, { "name": "model", "type": "string", "isBold": true, "required": true, "description": "Model ID is used to generate the response.
Available options: mimo-v2.5-pro, mimo-v2.5, mimo-v2.5-tts, mimo-v2.5-tts-voicedesign, mimo-v2.5-tts-voiceclone, mimo-v2-pro, mimo-v2-omni, mimo-v2-tts, mimo-v2-flash" }, { "name": "audio", "type": "object", "isBold": true, "required": false, "description": "Parameters for audio output. For details, please refer to Speech Synthesis.
Note: To generate audio, you must add a message with role set to assistant, which needs to specify the text for speech synthesis. Additionally, when using the mimo-v2.5-tts-voicedesign model, a message with the role of user is required. If optimize_text_preview is set to true, the assistant message can be omitted. For detailed usage, please refer to Speech Synthesis.
Currently, only the mimo-v2.5-tts, mimo-v2.5-tts-voicedesign, mimo-v2.5-tts-voiceclone and mimo-v2-tts models are supported.
", "children": [ { "name": "format", "type": "string", "isBold": true, "required": false, "defaultValue": "wav", "description": "Specifies the output audio format. Default: wav, or pcm when you set stream: true.
Passing in pcm or pcm16 both indicate specifying the use of the pcm16 format.
Available options: wav, mp3, pcm, pcm16" }, { "name": "optimize_text_preview", "type": "boolean", "isBold": true, "required": false, "defaultValue": "false", "description": "Enables intelligent optimization of the target audio broadcast text.
When set to true, the input target text is intelligently polished; if no target text is provided, a broadcast-adapted target text is automatically generated. The finalized processed text is then fed into the model for speech synthesis.
Note: When this parameter is set to true, the assistant role message for specifying speech synthesis content can be omitted.
Currently, only the mimo-v2.5-tts-voicedesign model is supported.
" }, { "name": "voice", "type": "string", "isBold": true, "description": "The voice ID of the built-in voice or the base64 encoding of the audio sample.
Available options:
" } ] }, { "name": "frequency_penalty", "type": [ "number", "null" ], "isBold": true, "required": false, "defaultValue": "0", "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.
Required range: [-2.0, 2.0]" }, { "name": "max_completion_tokens", "type": [ "integer", "null" ], "isBold": true, "required": false, "description": "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.
Required range: [1, 131072]" }, { "name": "presence_penalty", "type": [ "number", "null" ], "isBold": true, "required": false, "defaultValue": "0", "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.
Required range: [-2.0, 2.0]" }, { "name": "response_format", "type": "object", "isBold": true, "required": false, "description": "An object specifying the format that the model must output.
mimo-v2.5-tts, mimo-v2.5-tts-voicedesign, mimo-v2.5-tts-voiceclone and mimo-v2-tts models are not supported.
", "children": [ { "name": "Text", "type": "object", "isBold": false, "description": "Default response format. Used to generate text responses.", "children": [ { "name": "type", "type": "string", "isBold": true, "required": true, "description": "The type of response format being defined. Always text." } ] }, { "name": "JSON object", "type": "object", "isBold": false, "description": "JSON object response format. Note that the model will not generate JSON without a system or user message instructing it to do so.", "children": [ { "name": "type", "type": "string", "isBold": true, "required": true, "description": "The type of response format being defined. Always json_object." } ] } ] }, { "name": "stop", "type": [ "string", "array", "null" ], "isBold": true, "required": false, "defaultValue": "null", "description": "Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
mimo-v2.5-tts, mimo-v2.5-tts-voicedesign, mimo-v2.5-tts-voiceclone and mimo-v2-tts models are not supported.
" }, { "name": "stream", "type": [ "boolean", "null" ], "isBold": true, "required": false, "defaultValue": "false", "description": "If set to true, the model response data will be streamed to the client as it is generated using server-sent events." }, { "name": "thinking", "type": "object", "isBold": true, "required": false, "description": "This parameter is used to control whether the model enables the chain of thought.
Note: During the multi-turn tool calls process in thinking mode, the model returns a reasoning_content field alongside tool_calls. To continue the conversation, it is recommended to keep all previous reasoning_content in the messages array for each subsequent request to achieve the best performance.
In thinking mode, the mimo-v2.5-pro and mimo-v2.5 models do not support customizing the temperature parameter. Even if this parameter is passed in, it will be forcibly overridden and take effect with the model's recommended default value of 1.0.
mimo-v2.5-tts, mimo-v2.5-tts-voicedesign, mimo-v2.5-tts-voiceclone and mimo-v2-tts models are not supported.
", "children": [ { "name": "type", "type": "string", "isBold": true, "required": true, "description": "Whether to enable the chain of thought.
Available options: enabled, disabled" } ] }, { "name": "temperature", "type": "number", "isBold": true, "required": false, "description": "What sampling temperature to use, between 0 and 1.5. 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.
In thinking mode, the mimo-v2.5-pro and mimo-v2.5 models do not support customizing the temperature parameter. Even if this parameter is passed in, it will be forcibly overridden and take effect with the model's recommended default value of 1.0.
Required range: [0, 1.5]" }, { "name": "tool_choice", "type": "string", "isBold": true, "required": false, "description": "Controls how the model selects a tool.
Note: When a value other than auto is passed to tool_choice, the backend will remove this field by default, and the model response behavior will still be equivalent to the auto mode (this logic is subject to future adjustments).
mimo-v2.5-tts, mimo-v2.5-tts-voicedesign, mimo-v2.5-tts-voiceclone and mimo-v2-tts models are not supported.
Available options: auto" }, { "name": "tools", "type": "array", "isBold": true, "required": false, "description": "A list of tools the model may call. You can provide function tools.
Note: During the multi-turn tool calls process in thinking mode, the model returns a reasoning_content field alongside tool_calls. To continue the conversation, it is recommended to keep all previous reasoning_content in the messages array for each subsequent request to achieve the best performance.
mimo-v2.5-tts, mimo-v2.5-tts-voicedesign, mimo-v2.5-tts-voiceclone and mimo-v2-tts models are not supported.
", "children": [ { "name": "Function tool", "type": "object", "isBold": false, "description": "A function tool that can be used to generate a response.", "children": [ { "name": "function", "type": "object", "isBold": true, "required": true, "children": [ { "name": "name", "type": "string", "isBold": true, "required": true, "description": "The name of the tool function. Must be a-z, A-Z, 0-9, or contain underscores (_) and dashes (-), with a maximum length of 64.
Required string length: 1 - 64" }, { "name": "description", "type": "string", "isBold": true, "required": false, "description": "A description of what the function does, used by the model to choose when and how to call the function." }, { "name": "parameters", "type": "object", "isBold": true, "required": false, "description": "The parameters the functions accept, described as a JSON Schema object.
Omitting parameters defines a function with an empty parameter list." }, { "name": "strict", "type": "boolean", "isBold": true, "required": false, "defaultValue": "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." } ] }, { "name": "type", "type": "string", "isBold": true, "required": true, "description": "Tool type. Currently, only function is supported." } ] }, { "name": "Web search tool", "type": "object", "isBold": false, "description": "A web search tool that can be used to generate a response.For details, please refer to Web Search.
Note：Web Search plugin must be activated before use.
", "children": [ { "name": "user_location", "type": "object", "isBold": true, "required": false, "children": [ { "name": "type", "type": "string", "isBold": true, "required": true, "description": "approximate" }, { "name": "country", "type": "string", "isBold": true, "required": false, "description": "country" }, { "name": "region", "type": "string", "isBold": true, "required": false, "description": "region" }, { "name": "city", "type": "string", "isBold": true, "required": false, "description": "city" }, { "name": "district", "type": "string", "isBold": true, "required": false, "description": "district" }, { "name": "longitude", "type": "long", "isBold": true, "required": false, "description": "longitude " }, { "name": "latitude", "type": "long", "isBold": true, "required": false, "description": "latitude" } ] }, { "name": "type", "type": "string", "isBold": true, "required": true, "description": "Tool type. Currently, only web_search is supported." }, { "name": "force_search", "type": "string", "isBold": true, "required": false, "defaultValue": "false", "description": "Whether to enable forced search. true for forced search, false for the model to decide whether search is needed." }, { "name": "max_keyword", "type": "integer", "isBold": true, "required": false, "defaultValue": "5", "description": "Limit the maximum number of keywords that can be used in a single search.
Required range: [1, 50]" }, { "name": "limit", "type": "integer", "isBold": true, "required": false, "defaultValue": "5", "description": "Limit the maximum number of results returned by a single search operation.
Required range: [1, 50]" } ] } ] }, { "name": "top_p", "type": "number", "isBold": true, "required": false, "defaultValue": "0.95", "description": "The probability threshold for nucleus sampling, which controls the diversity of the text that the model generates. A higher top_p value results in more diverse text. A lower top_p value results in more deterministic text.
Because both temperature and top_p control the diversity of the generated text, we recommend that you set only one of them.
Required range: [0.01, 1.0]" } ]`} /> ## Chat response object (non-streaming output) 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, tool_calls if the model called a tool, content_filter if content was omitted due to a flag from our content filters, repetition_truncation if the model detects repetition." }, { "name": "index", "type": "integer", "isBold": true, "description": "The index of the choice in the list of choices." }, { "name": "message", "type": "object", "isBold": true, "description": "A chat completion message generated by the model.", "children": [ { "name": "content", "type": "string", "isBold": true, "description": "The contents of the message." }, { "name": "reasoning_content", "type": "string", "isBold": true, "description": "The reasoning contents of the assistant message, before the final answer." }, { "name": "role", "type": "string", "isBold": true, "description": "The role of the author of this message." }, { "name": "tool_calls", "type": "array", "isBold": true, "description": "After a function call is initiated, the model returns the tool to be called and the parameters that are Required for the call. This parameter can contain one or more tool response objects.", "children": [ { "name": "Function tool call", "type": "object", "isBold": false, "description": "A call to a function tool created by the model.", "children": [ { "name": "function", "type": "object", "isBold": true, "description": "The function that the model called.", "children": [ { "name": "arguments", "type": "string", "isBold": true, "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": "name", "type": "string", "isBold": true, "description": "The name of the function to call." } ] }, { "name": "id", "type": "string", "isBold": true, "description": "The ID of the tool call." }, { "name": "type", "type": "string", "isBold": true, "description": "The type of the tool. Currently, only function is supported." } ] } ] }, { "name": "annotations", "type": "array", "isBold": true, "description": "After web search, the model returns annotations for all referenced URLs.", "children": [ { "name": "web_search tool call", "type": "object", "isBold": false, "description": "A call to a web search tool created by the model.", "children": [ { "name": "logo_url", "type": "string", "isBold": true, "description": "Logo url." }, { "name": "publish_time", "type": "string", "isBold": true, "description": "Publish time." }, { "name": "site_name", "type": "string", "isBold": true, "description": "Site name." }, { "name": "summary", "type": "string", "isBold": true, "description": "Summary." }, { "name": "title", "type": "string", "isBold": true, "description": "Title." }, { "name": "type", "type": "string", "isBold": true, "description": "Type." }, { "name": "url", "type": "string", "isBold": true, "description": "Url." } ] } ] }, { "name": "error_message", "type": "string", "isBold": true, "description": "Error message of web search." }, { "name": "audio", "type": "object", "isBold": true, "description": "If the audio output is requested, this object contains data about the audio response from the model.", "children": [ { "name": "id", "type": "string", "isBold": true, "description": "Unique identifier for this audio response." }, { "name": "data", "type": "string", "isBold": true, "description": "Base64 encoded audio bytes generated by the model, in the format specified in the request." }, { "name": "expires_at", "type": [ "number", "null" ], "isBold": true, "description": "The Unix timestamp (in seconds) for when this audio response expires. Currently always null." }, { "name": "transcript", "type": [ "string", "null" ], "isBold": true, "description": "Transcript of the audio generated by the model. Currently always null." } ] }, { "name": "final_text_preview", "type": "string", "isBold": true, "description": "The final audio broadcast text after intelligent optimization and polishing. This field is only returned when the request parameter optimize_text_preview is set to true." } ] } ] }, { "name": "created", "type": "integer", "isBold": true, "description": "The Unix timestamp (in seconds) of when the chat completion was created." }, { "name": "id", "type": "string", "isBold": true, "description": "A unique identifier for the chat completion." }, { "name": "model", "type": "string", "isBold": true, "description": "The model to generate the completion." }, { "name": "object", "type": "string", "isBold": true, "description": "The object type, which is always chat.completion." }, { "name": "usage", "type": [ "object", "null" ], "isBold": true, "description": "Usage statistics for the completion request.", "children": [ { "name": "completion_tokens", "type": "integer", "isBold": true, "description": "Number of tokens in the generated completion." }, { "name": "prompt_tokens", "type": "integer", "isBold": true, "description": "Number of tokens in the prompt." }, { "name": "total_tokens", "type": "integer", "isBold": true, "description": "Total number of tokens used in the request (prompt + completion)." }, { "name": "completion_tokens_details", "type": "object", "isBold": true, "description": "Breakdown of tokens used in a completion.", "children": [ { "name": "reasoning_tokens", "type": "integer", "isBold": true, "description": "Tokens generated by the model for reasoning." } ] }, { "name": "prompt_tokens_details", "type": "object", "isBold": true, "description": "Breakdown of tokens used in the prompt.", "children": [ { "name": "cached_tokens", "type": "integer", "isBold": true, "description": "Number of tokens served from cache." }, { "name": "audio_tokens", "type": "integer", "isBold": true, "description": "Audio input tokens present in the prompt." }, { "name": "image_tokens", "type": "integer", "isBold": true, "description": "Image input tokens present in the prompt." }, { "name": "video_tokens", "type": "integer", "isBold": true, "description": "Video input tokens present in the prompt." } ] }, { "name": "web_search_usage", "type": "object", "isBold": true, "description": "Detailed usage of the web search API.", "children": [ { "name": "tool_usage", "type": "integer", "isBold": true, "description": "Number of API calls in web search." }, { "name": "page_usage", "type": "integer", "isBold": true, "description": "Number of web pages returned by the web search API." } ] } ] } ]`} /> ## Chat response chunk object (streaming output) tool_calls list, starting from 0." }, { "name": "function", "type": "object", "isBold": true, "description": "The function to be called.", "children": [ { "name": "arguments", "type": "string", "isBold": true, "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": "name", "type": "string", "isBold": true, "description": "The name of the function to call." } ] }, { "name": "id", "type": "string", "isBold": true, "description": "The ID of the tool call." }, { "name": "type", "type": "string", "isBold": true, "description": "The type of the tool. Currently, only function is supported." } ] }, { "name": "annotations", "type": "array", "isBold": true, "description": "After web search, the model returns annotations for all referenced URLs.", "children": [ { "name": "web_search tool call", "type": "object", "isBold": false, "description": "A call to a web search tool created by the model.", "children": [ { "name": "logo_url", "type": "string", "isBold": true, "description": "Logo url." }, { "name": "publish_time", "type": "string", "isBold": true, "description": "Publish time." }, { "name": "site_name", "type": "string", "isBold": true, "description": "Site name." }, { "name": "summary", "type": "string", "isBold": true, "description": "Summary." }, { "name": "title", "type": "string", "isBold": true, "description": "Title." }, { "name": "type", "type": "string", "isBold": true, "description": "Type." }, { "name": "url", "type": "string", "isBold": true, "description": "Url." } ] } ] }, { "name": "error_message", "type": "string", "isBold": true, "description": "Error message of web search." }, { "name": "audio", "type": [ "object", "null" ], "isBold": true, "description": "If the audio output modality is requested, this object contains data about the audio response from the model.", "children": [ { "name": "id", "type": "string", "isBold": true, "description": "Unique identifier for this audio response." }, { "name": "data", "type": "string", "isBold": true, "description": "Base64 encoded audio bytes generated by the model, in the format specified in the request." }, { "name": "expires_at", "type": [ "number", "null" ], "isBold": true, "description": "The Unix timestamp (in seconds) for when this audio response expires. Currently always null." }, { "name": "transcript", "type": [ "string", "null" ], "isBold": true, "description": "Transcript of the audio generated by the model. Currently always null." } ] }, { "name": "final_text_preview", "type": "string", "isBold": true, "description": "The final audio broadcast text after intelligent optimization and polishing. This field is only returned when the request parameter optimize_text_preview is set to true." } ] }, { "name": "finish_reason", "type": [ "string", "null" ], "isBold": true, "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, tool_calls if the model called a tool, content_filter if content was omitted due to a flag from our content filters, repetition_truncation if the model detects repetition." }, { "name": "index", "type": "integer", "isBold": true, "description": "The index of the choice in the list of choices." } ] }, { "name": "created", "type": "integer", "isBold": true, "description": "The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp." }, { "name": "id", "type": "string", "isBold": true, "description": "A unique identifier for the chat completion. Each chunk has the same ID." }, { "name": "model", "type": "string", "isBold": true, "description": "The model to generate the completion." }, { "name": "object", "type": "string", "isBold": true, "description": "The object type, which is always chat.completion.chunk." }, { "name": "usage", "type": [ "object", "null" ], "isBold": true, "description": "Usage statistics for the completion request.", "children": [ { "name": "completion_tokens", "type": "integer", "isBold": true, "description": "Number of tokens in the generated completion." }, { "name": "prompt_tokens", "type": "integer", "isBold": true, "description": "Number of tokens in the prompt." }, { "name": "total_tokens", "type": "integer", "isBold": true, "description": "Total number of tokens used in the request (prompt + completion)." }, { "name": "completion_tokens_details", "type": "object", "isBold": true, "description": "Breakdown of tokens used in a completion.", "children": [ { "name": "reasoning_tokens", "type": "integer", "isBold": true, "description": "Tokens generated by the model for reasoning." } ] }, { "name": "prompt_tokens_details", "type": "object", "isBold": true, "description": "Breakdown of tokens used in the prompt.", "children": [ { "name": "cached_tokens", "type": "integer", "isBold": true, "description": "Number of tokens served from cache." }, { "name": "audio_tokens", "type": "integer", "isBold": true, "description": "Audio input tokens present in the prompt." }, { "name": "image_tokens", "type": "integer", "isBold": true, "description": "Image input tokens present in the prompt." }, { "name": "video_tokens", "type": "integer", "isBold": true, "description": "Video input tokens present in the prompt." } ] }, { "name": "web_search_usage", "type": "object", "isBold": true, "description": "Detailed usage of the web search API.", "children": [ { "name": "tool_usage", "type": "integer", "isBold": true, "description": "Number of API calls in web search." }, { "name": "page_usage", "type": "integer", "isBold": true, "description": "Number of web pages returned by the web search API." } ] } ] } ]`} />