tenant.openai.chat.completions

请求参数

Authorization

Bearer Token

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

Body 参数application/json

示例

{
    "audio": {
        "format": "mp3",
        "voice": "alloy"
    },
    "frequency_penalty": 0,
    "logit_bias": {
        "property1": 0,
        "property2": 0
    },
    "logprobs": true,
    "max_completion_tokens": 0,
    "max_tokens": 0,
    "messages": [
        {
            "annotations": [
                {
                    "type": "string",
                    "url_citation": {
                        "end_index": 0,
                        "start_index": 0,
                        "title": "string",
                        "url": "string"
                    }
                }
            ],
            "audio": {
                "data": "string",
                "expires_at": 0,
                "id": "string",
                "transcript": "string"
            },
            "content": null,
            "name": "string",
            "refusal": "string",
            "role": "system",
            "tool_call_id": "string",
            "tool_calls": [
                {
                    "function": {
                        "arguments": "string",
                        "name": "string"
                    },
                    "id": "string",
                    "index": 0,
                    "type": "string"
                }
            ]
        }
    ],
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "modalities": [
        "audio"
    ],
    "model": "string",
    "n": 0,
    "parallel_tool_calls": true,
    "presence_penalty": 0,
    "reasoning_effort": "string",
    "response_format": {
        "json_schema": {
            "name": "string",
            "schema": {},
            "strict": true
        },
        "type": "text"
    },
    "seed": 0,
    "service_tier": "string",
    "stop": [
        "string"
    ],
    "store": true,
    "stream": true,
    "stream_options": {
        "include_usage": true
    },
    "temperature": 0,
    "tool_choice": null,
    "tools": [
        {
            "function": {
                "description": "string",
                "name": "string",
                "parameters": {},
                "strict": true
            },
            "type": "function"
        }
    ],
    "top_logprobs": 0,
    "top_p": 0,
    "user": "string",
    "web_search_options": {
        "search_context_size": "low",
        "user_location": {
            "approximate": {
                "city": "string",
                "country": "string",
                "region": "string",
                "timezone": "string"
            },
            "type": "string"
        }
    }
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/tenant//release//openai-compatible/v1/chat/completions' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "audio": {
        "format": "mp3",
        "voice": "alloy"
    },
    "frequency_penalty": 0,
    "logit_bias": {
        "property1": 0,
        "property2": 0
    },
    "logprobs": true,
    "max_completion_tokens": 0,
    "max_tokens": 0,
    "messages": [
        {
            "annotations": [
                {
                    "type": "string",
                    "url_citation": {
                        "end_index": 0,
                        "start_index": 0,
                        "title": "string",
                        "url": "string"
                    }
                }
            ],
            "audio": {
                "data": "string",
                "expires_at": 0,
                "id": "string",
                "transcript": "string"
            },
            "content": null,
            "name": "string",
            "refusal": "string",
            "role": "system",
            "tool_call_id": "string",
            "tool_calls": [
                {
                    "function": {
                        "arguments": "string",
                        "name": "string"
                    },
                    "id": "string",
                    "index": 0,
                    "type": "string"
                }
            ]
        }
    ],
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "modalities": [
        "audio"
    ],
    "model": "string",
    "n": 0,
    "parallel_tool_calls": true,
    "presence_penalty": 0,
    "reasoning_effort": "string",
    "response_format": {
        "json_schema": {
            "name": "string",
            "schema": {},
            "strict": true
        },
        "type": "text"
    },
    "seed": 0,
    "service_tier": "string",
    "stop": [
        "string"
    ],
    "store": true,
    "stream": true,
    "stream_options": {
        "include_usage": true
    },
    "temperature": 0,
    "tool_choice": null,
    "tools": [
        {
            "function": {
                "description": "string",
                "name": "string",
                "parameters": {},
                "strict": true
            },
            "type": "function"
        }
    ],
    "top_logprobs": 0,
    "top_p": 0,
    "user": "string",
    "web_search_options": {
        "search_context_size": "low",
        "user_location": {
            "approximate": {
                "city": "string",
                "country": "string",
                "region": "string",
                "timezone": "string"
            },
            "type": "string"
        }
    }
}'

返回响应

🟢200成功

application/json

调用成功

Body

示例

{
    "choices": [
        {
            "finish_reason": "stop",
            "index": 0,
            "logprobs": {
                "content": [
                    {
                        "bytes": [
                            0
                        ],
                        "logprob": 0,
                        "token": "string",
                        "top_logprobs": [
                            {
                                "bytes": [
                                    0
                                ],
                                "logprob": 0,
                                "token": "string"
                            }
                        ]
                    }
                ],
                "refusal": [
                    {
                        "bytes": [
                            0
                        ],
                        "logprob": 0,
                        "token": "string",
                        "top_logprobs": [
                            {
                                "bytes": [
                                    0
                                ],
                                "logprob": 0,
                                "token": "string"
                            }
                        ]
                    }
                ]
            },
            "message": {
                "annotations": [
                    {
                        "type": "string",
                        "url_citation": {
                            "end_index": 0,
                            "start_index": 0,
                            "title": "string",
                            "url": "string"
                        }
                    }
                ],
                "audio": {
                    "data": "string",
                    "expires_at": 0,
                    "id": "string",
                    "transcript": "string"
                },
                "content": null,
                "name": "string",
                "refusal": "string",
                "role": "system",
                "tool_call_id": "string",
                "tool_calls": [
                    {
                        "function": {
                            "arguments": "string",
                            "name": "string"
                        },
                        "id": "string",
                        "index": 0,
                        "type": "string"
                    }
                ]
            }
        }
    ],
    "created": 0,
    "id": "string",
    "model": "string",
    "object": "string",
    "service_tier": "string",
    "system_fingerprint": "string",
    "usage": {
        "completion_tokens": 0,
        "completion_tokens_details": {
            "accepted_prediction_tokens": 0,
            "audio_tokens": 0,
            "reasoning_tokens": 0,
            "rejected_prediction_tokens": 0
        },
        "prompt_tokens": 0,
        "prompt_tokens_details": {
            "audio_tokens": 0,
            "cached_tokens": 0
        },
        "total_tokens": 0
    }
}