a13nDocs
API 参考连接

读取连接工具定义

读取最多五个准确匹配的定义。定义过大时返回带版本标识的片段引用。

GET/api/v1/connections/{connection_id}/tools/definitions

读取最多五个准确匹配的定义。定义过大时返回带版本标识的片段引用。

认证与授权

认证与授权Bearer <token>

工作空间 API 密钥（a13n_...）

传递位置: header

路径参数

connection_id*Connection Id

查询参数

name*array<string>

准确名称；重复传入 name 可选择最多五个定义。

元素1 <= items <= 5
offset?|null
limit?Limit

本片段最多包含的 Unicode 码点数。

范围1 <= value <= 4000
默认值4000
version?|

首次读取返回的内容版本；偏移量大于 0 时必填。

query?|

按原文搜索，区分大小写。

请求头参数

X-Workspace-ID?|

登录会话作用的工作空间 ID，登录会话必须提供。API 密钥作用于自身工作空间，无需提供；禁止指定其他工作空间。

响应体

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/connections/string/tools/definitions?name=string"
{  "items": [    {      "definition": {        "property1": null,        "property2": null      },      "name": "string"    }  ],  "missing": [    "string"  ],  "oversized": [    {      "instruction": "Read this endpoint with one name, offset=0 and limit=4000, then continue with version and next_offset.",      "name": "string",      "size_chars": 0,      "version": "string"    }  ]}