检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
模型API接入接口规范 当前模型网关支持文本对话（Chat）、文本向量化（Embeddings）、文本排序（Rerank）三种类型的API接入。模型API接入之前，请确保符合相对应的接口规范，其中Chat接口和Embeddings接口需要符合OpenAI接口规范，Rerank接口需要符合AI引擎标准协议。
API 模型调用 应用中心 知识中心
API概览 AppStage接口的分类与说明如表1所示。 表1 API概览 类型 说明 模型调用 包含文本对话类、文本向量化类模型服务调用接口。 应用中心 包含Agent调用、用户配置（工作流、技能）调用、文件盒子等接口。 知识中心 包含知识库和知识数据集的创建、删除、执行及查询等接口。
如何调用API 构造请求 认证鉴权 返回结果
新增平台API Key API Key是每个用户单独的身份认证，是个人调用应用接口的依据，必须妥善保管。租户开发的Agent在调用平台接口时需要进行平台鉴权认证，可以使用“平台API Key”进行平台的鉴权认证。 背景信息 对于华为或者第三方运营的商业化模型服务，支持通过API接入到
重定向到OrgID的退出页完成OrgID侧的退出逻辑。 /callback/logout接口 该接口为OrgID的回调接口，当用户从OrgID侧发起退出登录时，会通知到应用侧。此时会回调该接口，不同于/app/logout退出接口，该接口只需清理demo应用自身会话，完成自身退出登录。 父主题： 集成OrgID登录功能
如何获取Agent发布时要所需的API Key？ 填写AI原生应用引擎平台的API Key，生成方式请参见新增平台API Key。仅AI原生应用引擎管理员角色可以创建API Key，请通过管理员获取。 父主题： AI原生应用引擎
则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于文本对话接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。
应用中心 调用知识检索流 调用流 调用技能 文件盒子上传文件 文件盒子删除文件 调用Agent 父主题： API
{ } } API Key认证 API Key全称为应用程序接口密钥，是一种用于验证和授权API请求的代码。它通常是一串字符，用于识别调用API的应用程序和开发者。 获取API Key 以管理员身份登录AI原生应用引擎工作台，参考创建API Key获取。 使用API Key鉴权
AI原生应用引擎鉴权API Key。 1.以管理员身份登录AI原生应用引擎工作台，在左侧导航栏选择“系统管理 > 平台租户鉴权”。 2.在“平台租户鉴权”页面，选择“平台API Key”页签，单击“新增平台API Key”。 3.在“新增平台API Key”对话框中的输入框设置API Key名称，用以区分API
"assistant", "content": "你好，有什么我可以帮助你的吗？" }, "logprobs": null }], "object": "chat.completion" } 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。
模型调用 文本对话 文本向量化 父主题： API
查询知识库最新执行记录 修改知识库召回状态 创建知识数据集 查询知识数据集详情 删除知识数据集 执行知识数据集 查询知识数据集最新执行记录 父主题： API
鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。仅AI原生应用引擎管理员角色可以创建API Key，请通过管理员获取。 h-user-id 是 String 用户ID，在session接口返回体中可获取userId。
AI原生应用引擎鉴权API Key。 1.以管理员身份登录AI原生应用引擎工作台，在左侧导航栏选择“系统管理 > 平台租户鉴权”。 2.在“平台租户鉴权”页面，选择“平台API Key”页签，单击“新增平台API Key”。 3.在“新增平台API Key”对话框中的输入框设置API Key名称，用以区分API
Authorization 是 String 鉴权信息，填写租户管理员已创建的API Key，前缀加Bearer与空格。 h-user-id 否 String 用户ID，引用文件时为必填，可先调用一次本接口，从响应中的user_id字段获取。 表3 请求Body参数 参数 是否必选
鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。仅AI原生应用引擎管理员角色可以创建API Key，请通过管理员获取。 h-user-id 是 String 用户ID，在session接口返回体中可获取userId。
AI原生应用引擎鉴权API Key。 1.以管理员身份登录AI原生应用引擎工作台，在左侧导航栏选择“系统管理 > 平台租户鉴权”。 2.在“平台租户鉴权”页面，选择“平台API Key”页签，单击“新增平台API Key”。 3.在“新增平台API Key”对话框中的输入框设置API Key名称，用以区分API
AI原生应用引擎鉴权API Key。 1.以管理员身份登录AI原生应用引擎工作台，在左侧导航栏选择“系统管理 > 平台租户鉴权”。 2.在“平台租户鉴权”页面，选择“平台API Key”页签，单击“新增平台API Key”。 3.在“新增平台API Key”对话框中的输入框设置API Key名称，用以区分API
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
