快速入门

API 参考

其他资源

首页 / Agent / 文档 / execute

execute - 执行接口 按工具计费

执行接口用于调用指定的工具能力并返回结果。这是 Agent API 的核心接口,根据工具的计费规则消耗次数或 Credits。

⚠ 计费接口:执行接口会按照工具的计费规则消耗次数,免费工具保持免费,付费工具按原价计费。

接口地址

POST https://api.jisuapi.com/agent/execute

请求参数

参数名类型必填说明
tool_idstring工具标识符(从 search 接口获取)
paramsobject工具所需的参数对象(JSON)
search_idstring关联的搜索 ID(推荐传递)
idempotency_keystring幂等键,防止重复执行

请求头

Header说明
AuthorizationBearer {appkey}APPKEY 认证
Content-Typeapplication/json请求体格式

响应格式

成功响应(status: 0)

{
  "status": 0,
  "msg": "ok",
  "data": {
    "province": "北京",
    "city": "北京",
    "company": "中国移动",
    "cardtype": "GSM",
    "areacode": "010",
    "zip": "100000"
  },
  "meta": {
    "tool_id": "shouji_query",
    "execution_id": "exe_20260603_120102_xxx",
    "charge": {
      "planned_layer": "free",
      "final_layer": "free",
      "calnum": 1,
      "unitprice": 0.0,
      "cost": 0.0,
      "credits_cost": 0,
      "layers": [
        {
          "layer": "free",
          "deducted": 1,
          "remain": 99
        }
      ]
    },
    "elapsed_ms": 138,
    "upstream_ms": 120
  },
  "request_id": "req_..."
}

失败响应

{
  "status": 302,
  "msg": "工具参数缺失或格式错误",
  "data": null
}

错误码

statusmsg说明
101APPKEY为空或不存在未提供有效的APPKEY
103APPKEY无请求此数据权限未开通该接口
104请求超过次数限制次数不足
203tool_id 不能为空参数错误
301未找到 tooltool_id 无效或已下架
302工具参数缺失或格式错误params 参数有误
401需要实名认证该工具需要实名认证
402需要企业认证该工具需要企业认证
501上游超时上游接口响应超时
502上游错误上游接口返回错误

请求示例

基础执行

curl -X POST "https://api.jisuapi.com/agent/execute" \
  -H "Authorization: Bearer 你的APPKEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_id": "shouji_query",
    "params": {
      "mobile": "13800138000"
    }
  }'

带完整上下文的执行

curl -X POST "https://api.jisuapi.com/agent/execute" \
  -H "Authorization: Bearer 你的APPKEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_id": "weather_forecast",
    "search_id": "sch_20260603120001",
    "params": {
      "city": "北京",
      "days": 7
    }
  }'

幂等执行(防重复)

curl -X POST "https://api.jisuapi.com/agent/execute" \
  -H "Authorization: Bearer 你的APPKEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_id": "sms_send",
    "idempotency_key": "unique-key-12345",
    "params": {
      "mobile": "13800138000",
      "content": "验证码:123456"
    }
  }'

Python 示例

import requests

url = "https://api.jisuapi.com/agent/execute"
headers = {
    "Authorization": "Bearer 你的APPKEY",
    "Content-Type": "application/json"
}
data = {
    "tool_id": "shouji_query",
    "params": {"mobile": "13800138000"}
}

response = requests.post(url, headers=headers, json=data)
result = response.json()

if result["status"] == 0:
    print("查询成功:")
    print(result["data"])
    print(f"执行ID: {result['meta']['execution_id']}")
    print(f"计费: {result['meta']['charge']['cost']} 元")
else:
    print(f"查询失败: {result['msg']}")

计费说明

三级计费层级

计费流程

系统按以下顺序扣费:免费额度 → 套餐包 → Credits。响应中的 charge.layers 显示实际扣费明细。

最佳实践

常见问题

Q: 如何知道工具需要哪些参数?

A: 先调用 search 接口搜索工具,返回结果中包含参数说明。也可以查看原接口文档。

Q: 执行失败会扣费吗?

A: 一般不会。只有成功返回数据时才会扣费。因参数错误等客户端问题导致的失败不计费。

Q: idempotency_key 的有效期是多久?

A: 幂等键默认有效期为 24 小时,期间使用相同的幂等键会返回首次执行的结果。