j9九游会登录/ 应用平台 appstage/ / api操作指引
更新时间：2025-12-03 gmt 08:00

api操作指引-j9九游会登录

agent发布，发布渠道选择“api”时，会将agent生成为api接口。用户调用此接口时，调用流程如下。

前提条件

agent已发布，且发布渠道选择“api”，发布agent具体操作请参考在ai原生应用引擎中发布agent。

获取api接口信息

  1. 进入ai原生应用引擎。
  2. 在ai原生应用引擎左侧导航，选择“agent编排中心 > 我的agent”。
  3. 在“我创建的”页签，在需要调用的agent对应的“发布地址”列下，鼠标移动至上，如图1所示，查看复制api接口地址。
    图1 获取api信息

获取鉴权信息

调用api需要进行平台鉴权，api key获取方法请参考创建ak/sk访问密钥。

构造请求

curl命令调用agent请求示例：
{
  curl --location --request post '{{ 第二步获得的api地址 }}'
  --header 'authorization: bearer {{ 第三步获得的apikey }}'
  --header 'content-type: application/json'
  --data-raw '{
      "query": "{{ 输入问题 }}",
      "memory": [], // 包含迄今为止历史对话的消息列表	list[dict]	这是一个结构体的列表，每个元素类似如下：{"role": "user", "content": "你好"} role 只支持user,assistant,tool 其一，content 不得为空。
  }'
}
python调用agent代码示例：
import requests
url = {{ 获取api接口信息获取的api地址 }}
payload="{\n \"query\": \"您好"\n}"
headers = {
'content-type': 'application/json',
'authorization': 'bearer {{ 获取鉴权信息获取的apikey }}',
}
response = requests.request("post", url, headers=headers, data=payload)

请求参数

表1 请求参数说明

参数

是否必选

参数类型

描述

query

string

true

用户的问题。

memory

array[object]

true

历史对话内容。

示例：{"role": "user", "content": "你好"}，role支持user、assistant、tool。

user_id

string

true

自定义的用户id，与conversation_id共同使用可以使agent自动获取相同对话id下的前几轮对话内容。与memory不同时生效，memory存在时memory优先生效。

conversation_id

string

true

自定义的对话id，与user_id共同使用可以使agent自动获取相同对话id下的前几轮对话内容。与memory不同时生效，memory存在时memory优先生效。

variables

object

true

填写一般变量和敏感变量。

示例：{"common_variables":{"k1":"v1"}, "sensitive_variables":{"k2":"v2"}}}，其中common_variables表示一般变量，sensitive_variables表示敏感变量。如果agent中设置了敏感变量，敏感变量为必传。

响应参数

表2 响应参数说明

参数

参数类型

描述

request_id

string

请求id。

agent_id

string

agent的id。

user_id

string

用户id。

conversation_id

string

会话id。

type

string

返回类型。

  • hint：表示提示将要调用的工具、知识库和工作流。
  • tool：表示工具调用结果。
  • knowledge：表示知识库调用结果。
  • workflow：表示工作流调用结果。
  • message：表示大模型返回的对话或总结内容。

data

object

返回的具体内容。

  • 表3：type为hint时，返回toolhintchunk。
  • 表4：type为tool、knowledge、workflow时，返回toolinvokechunk。
  • 表5 modelresponsechunk：type为message时，返回modelresponsechunk。
表3 toolhintchunk

参数

参数类型

描述

id

string

工具、工作流或者知识库的唯一id。

name

string

工具、工作流或者知识库的名称。

type

string
  • tool：表示工具。
  • workflow：表示工作流。
  • knowledge：表示知识库。
表4 toolinvokechunk

参数

参数类型

描述

id

string

工具、工作流或者知识库的唯一id。

name

string

工具、工作流或者知识库的名称。

status

string

调用状态。

success：表示调用成功。

failed：标识调用失败。

request

object

调用请求。

response

object

调用结果。
表5 modelresponsechunk

参数

参数类型

描述

id

string

唯一id

content

string

返回消息内容，当前只支持流式。

url

object

图片、视频的url。

raw

object

大模型的原始返回。

错误码

请参见错误码。

相关文档

网站地图