API 参考

取得工具契约

GET/v1/tools/{id}

统一支持 flat 常量按次、input 按输入预计算和 usage 按最终用量。pricing.quote_required 决定是否必须报价，requires_usage 决定是否必须提供费用上限并等待权威最终用量；二者不由 schema_version 推断。metered_pricing 关闭时仅限制需要最终用量的新调用，常量/输入规则若不需要最终用量仍可使用。当前 Key 需具备工具授权，运行身份和结果以原 Key 为界。工具总开关关闭时目录为空；匿名目录不能作为可执行授权。

鉴权与权限

使用当前 GloopAPI Key。模型、功能与权限以当前 Key 的目录及接口说明为准。

Authorization: Bearer $GLOOP_API_KEY

鉴权方案： BearerAuth

请求

路径参数

idstring必填
目录工具 ID 或原工具运行 ID，取当前操作对象。

查询参数

versionstring选填
省略取 current version，创建运行须指定目录版本。

响应与错误

HTTP 200

取得工具契约成功

application/json

类型: object
必填字段: category_idcollection_idtagsidnamedescriptionversionpricinginput_schemaoutput_schemaread_only

category_idstring必填
工具分类标识。
collection_idstring必填
工具集合标识。
tagsarray必填
公开搜索标签。
tags 子字段（1）
- []string选填
idstring必填
该对象的公开标识符；用于对应详情路径。
namestring必填
用户可读名称。
descriptionstring必填
公开用途说明。
versionstring必填
契约/能力或工具版本；运行使用目录返回的工具版本。
pricingobject必填
公开销售价格，以当前报价和计费规则为准。
pricing 子字段（9）
- schema_versioninteger选填
  工具计价规则版本。
- ruleunknown选填
  由所选工具的 schema 或协议定义的 JSON 值；不假定固定字段。
- quote_requiredboolean必填
  新运行是否必须先确认报价。
- currencystring必填
  报价/账务币种。
- unitstring必填
  call 按次或按输入预计算；usage 按最终用量。具体语义看 mode。
- amountstring选填
  mode=flat 时为完整常量美元金额，含零价；input/usage 不提供可误读的常量金额。
- price_versioninteger必填
  销售价格修订版本。
- modestring必填
  销售价格的计价语义：flat 常量按次、input 按输入预计算、usage 按最终用量。与 schema_version 数据格式无关。
  
  枚举
  ["flat","input","usage"]
- requires_usageboolean必填
  最终结算是否需要权威用量，包含平台结算约束；不得仅从销售价格 mode 推断。
allOf 分支 1
类型: object
分支必填： currency, unit, price_version, mode, quote_required, requires_usage
- schema_versioninteger选填
  工具计价规则版本。
- ruleunknown选填
  由所选工具的 schema 或协议定义的 JSON 值；不假定固定字段。
- quote_requiredboolean必填
  新运行是否必须先确认报价。
- currencystring必填
  报价/账务币种。
- unitstring必填
  call 按次或按输入预计算；usage 按最终用量。具体语义看 mode。
- amountstring选填
  mode=flat 时为完整常量美元金额，含零价；input/usage 不提供可误读的常量金额。
- price_versioninteger必填
  销售价格修订版本。
- modestring必填
  销售价格的计价语义：flat 常量按次、input 按输入预计算、usage 按最终用量。与 schema_version 数据格式无关。
  
  枚举
  ["flat","input","usage"]
- requires_usageboolean必填
  最终结算是否需要权威用量，包含平台结算约束；不得仅从销售价格 mode 推断。
input_schemaunknown必填
由所选工具的 schema 或协议定义的 JSON 值；不假定固定字段。
output_schemaunknown必填
由所选工具的 schema 或协议定义的 JSON 值；不假定固定字段。
read_onlyboolean必填
工具公开契约声明的只读属性，不是免授权或免费保证。

HTTP 400

请求字段或参数无效。

application/json

类型: object
必填字段: error

errorobject必填
error 子字段（4）
- codestring选填
- messagestring选填
- typestring选填
- request_idstring选填

HTTP 401

Key 缺失、无效、过期或已撤销。

application/json

类型: object
必填字段: error

errorobject必填
error 子字段（4）
- codestring选填
- messagestring选填
- typestring选填
- request_idstring选填

HTTP 403

IP、账户、模型或工具权限不足。

application/json

类型: object
必填字段: error

errorobject必填
error 子字段（4）
- codestring选填
- messagestring选填
- typestring选填
- request_idstring选填

HTTP 404

对象/能力不可用，或功能开关关闭。

application/json

类型: object
必填字段: error

errorobject必填
error 子字段（4）
- codestring选填
- messagestring选填
- typestring选填
- request_idstring选填

HTTP 409

幂等/报价冲突、对象未准备或仍被引用。

application/json

类型: object
必填字段: error

errorobject必填
error 子字段（4）
- codestring选填
- messagestring选填
- typestring选填
- request_idstring选填

HTTP 429

请求/队列限流。

application/json

类型: object
必填字段: error

errorobject必填
error 子字段（4）
- codestring选填
- messagestring选填
- typestring选填
- request_idstring选填

HTTP 500

鉴权或数据存储内部失败。

application/json

类型: object
必填字段: error

errorobject必填
error 子字段（4）
- codestring选填
- messagestring选填
- typestring选填
- request_idstring选填

HTTP 503

服务、定价或存储不可用。

application/json

类型: object
必填字段: error

errorobject必填
error 子字段（4）
- codestring选填
- messagestring选填
- typestring选填
- request_idstring选填