连接器 API

列表、详情、调用与任务轮询的 HTTP 接口说明。

鉴权

连接器 API 复用站点现有的 API Key 体系。

  • Authorization: Bearer <api_key>
  • x-api-key: <api_key>

端点

  • GET /api/connectors
  • GET /api/connectors?format=markdown
  • GET /api/connectors/[connectorId]
  • GET /api/connectors/[connectorId]?format=markdown
  • POST /api/connectors/[connectorId]/invoke
  • GET /api/connectors/jobs/[jobId]
  • GET /api/connectors/status
  • GET /api/connectors/balance(兼容别名)

输出契约

连接器调用、任务轮询、账号状态和余额接口返回 JSON,content-typeapplication/json。成功调用和任务响应直接返回连接器数据 payload;其中的 raw 字段包含该次连接器调用返回的上游 API payload。

目录和详情接口默认返回 JSON。format=markdown 变体仅作为浏览器/文档兼容视图;CLI 消费 JSON,并且只在本地按 --pretty 渲染终端可读输出。

CLI 会在输出到 stdout 前把 HTTP payload 包装为 { "status": <http_status>, "data": <payload> }。业务错误在 invoke 和 job 响应中同样返回 JSON,并通过 x-error-code 提供机器可读错误码。