大模型API接口使用文档
摘要:本文档详细介绍如何调用大模型 API 接口,不依赖额外的环境,包括获取可用模型列表、使用 curl 或 Python OpenAI 库进行问答测试、常见错误排查以及 Postman 测试方法。文档涵盖无 API Key 和有 API Key 两种场景,帮助业主快速上手。
常见步骤
- 首先是否ping通网络
- 查看提供大模型接口是否存在api-key
- 根据api-key不同情况,调用不同的方法
目录
- 大模型API接口使用文档
- 接口基本信息
- 前提条件
- 一、获取可用模型列表(如果有模型名称跳过该步骤)
- 情况 1:无 API Key(接口未启用认证)
- 使用 curl 获取
- 使用 Python OpenAI 接口获取
- 情况 2:有 API Key(接口已启用认证)
- 使用 curl 获取
- 使用 Python OpenAI 接口获取
- 预期输出示例
- 二、使用代码测试, qwen3\.5 模型进行问答
- 情况 1:无 API Key(接口未启用认证)
- 使用 curl 进行问答
- 使用 Python OpenAI 接口进行问答
- 情况 2:有 API Key(接口已启用认证)
- 使用 curl 进行问答
- 使用 Python OpenAI 接口进行问答
- 三、常见错误及解决方法
- 1. 网页解析失败 / 不支持的网页类型
- 2. 模型不存在
- 3. 认证失败
- 4. 连接失败
- 四、使用postman进行测试
- 获取模型名称
- 根据上图获取的大模型名称(Qwen3.5-397B-A17B-w8a8-mtp) 进行测试
接口基本信息
根据提供的大模型API接口,推断出基础地址,一般常用的api接口如下所示
基础地址:
http://127.0.0.1:31476/xxxxx/v1聊天补全接口:
http://127.0.0.1:31476/xxxxxx/v1/chat/completions模型列表接口:
http://127.0.0.1:31476/xxxxxxx/v1/models兼容标准:OpenAI API 规范
示例模型:qwen3.5(通义千问 3.5)
前提条件
确保网络可以访问大模型地址
已安装 curl 工具(用于命令行测试)
(可选)已安装 Python 3.7+ 和 openai 库(
pip install openai)
一、获取可用模型列表(如果有模型名称跳过该步骤)
重要提示:模型名称不能从 URL 中推断,必须通过/v1/models接口获取。
情况 1:无 API Key(接口未启用认证)
使用 curl 获取
curlhttp://127.0.0.1:31476/v1/models使用 Python OpenAI 接口获取
fromopenaiimportOpenAI# 初始化客户端(无API Key)client=OpenAI(base_url="http://127.0.0.1:31476/v1",api_key="dummy_key"# 即使不需要认证,也需要填写任意非空字符串)# 获取模型列表models=client.models.list()# 打印所有可用模型print("可用模型列表:")formodelinmodels.data:print(f"-{model.id}")情况 2:有 API Key(接口已启用认证)
使用 curl 获取
curlhttp://127.0.0.1:31476/v1/models\-H"Authorization: Bearer YOUR_API_KEY"使用 Python OpenAI 接口获取
fromopenaiimportOpenAI# 初始化客户端(有API Key)client=OpenAI(base_url="http://127.0.0.1:31476/v1",api_key="YOUR_API_KEY"# 替换为实际的API Key)# 获取模型列表models=client.models.list()# 打印所有可用模型print("可用模型列表:")formodelinmodels.data:print(f"-{model.id}")预期输出示例
可用模型列表: - qwen3.5 - qwen3.5-72b - qwen3.5-14b - qwen3.5-7b二、使用代码测试, qwen3.5 模型进行问答
一般需要修改api-key和model名称
情况 1:无 API Key(接口未启用认证)
使用 curl 进行问答
curlhttp://127.0.0.1:31476/v1/chat/completions\-H"Content-Type: application/json"\-d'{ "model": "qwen3.5", "messages": [ { "role": "user", "content": "你好,请介绍一下自己" } ], "temperature": 0.7, "max_tokens": 1000 }'使用 Python OpenAI 接口进行问答
fromopenaiimportOpenAI# 初始化客户端(无API Key)client=OpenAI(base_url="http://127.0.0.1:31476/v1",api_key="dummy_key"# 即使不需要认证,也需要填写任意非空字符串)# 发送聊天请求response=client.chat.completions.create(model="qwen3.5",messages=[{"role":"user","content":"你好,请介绍一下自己"}],temperature=0.7,max_tokens=1000)# 打印响应结果print("模型回复:")print(response.choices[0].message.content)流式输出demo
fromopenaiimportOpenAI client=OpenAI(base_url="http://127.0.0.1:31476/v1",api_key="dummy_key")# 开启流式输出stream=client.chat.completions.create(model="qwen35_27b",messages=[{"role":"user","content":"你是谁?"}],temperature=0.8,extra_body={"enable_thinking":True},stream=True)print("AI(需要等待一段时间): ",end="",flush=True)forchunkinstream:# 跳过空内容块ifchunk.choicesandchunk.choices[0].delta.content:print(chunk.choices[0].delta.content,end="",flush=True)# print(chunk)print("\n")情况 2:有 API Key(接口已启用认证)
使用 curl 进行问答
curlhttp://127.0.0.1:31476/v1/chat/completions\-H"Content-Type: application/json"\-H"Authorization: Bearer YOUR_API_KEY"\-d'{ "model": "qwen3.5", "messages": [ { "role": "user", "content": "你好,请介绍一下自己" } ], "temperature": 0.7, "max_tokens": 1000 }'使用 Python OpenAI 接口进行问答
fromopenaiimportOpenAI# 初始化客户端(有API Key)client=OpenAI(base_url="http://127.0.0.1:31476/v1",api_key="YOUR_API_KEY"# 替换为实际的API Key)# 发送聊天请求response=client.chat.completions.create(model="qwen3.5",messages=[{"role":"user","content":"你好,请介绍一下自己"}],temperature=0.7,max_tokens=1000)# 打印响应结果print("模型回复:")print(response.choices[0].message.content)三、常见错误及解决方法
1. 网页解析失败 / 不支持的网页类型
错误信息:“网页解析失败,可能是不支持的网页类型,请检查网页或稍后重试”
原因:直接在浏览器中访问 API 接口地址,浏览器无法解析 JSON 响应
解决方法:使用 curl 命令、Postman 或 Python 代码等工具访问,不要直接在浏览器中打开
2. 模型不存在
错误信息:“The model
xxxdoes not exist”原因:使用了错误的模型名称
解决方法:通过
/v1/models接口获取正确的模型名称
3. 认证失败
错误信息:“Invalid API Key” 或 “Unauthorized"或者"Token is missing”
原因:API Key 错误或接口需要认证但未提供
解决方法:检查 API Key 是否正确,或联系管理员获取有效的 API Key
4. 连接失败
错误信息:“Connection refused” 或 “无法连接到服务器”
原因:网络不通或服务未启动
解决方法:
检查网络是否可以访问目标网络和端口
联系管理员确认服务是否正常运行
四、使用postman进行测试
一种方法可以在postman点击import 根据curl命令导入到postman中直接测试访问
第二种方法如图