Docs

Quickstart for humans and agents

文档只保留最短接入链路:发现、鉴权、执行、验证。匿名访客可以读取公开入口,真实执行需要访问 Key。

QuickstartAuthenticationGET /api/catalogPOST /v1/runPOST /v1/verifyErrorsLimits

Authentication

公共文档可匿名读取,执行能力必须携带 `x-api-key`。

访问 Key 当前通过 `/apply` 申请并人工审核发放。第一版不开放匿名试调用,目的是控制成本并筛选真实需求。

GET /api/catalog

读取公开能力目录

curl -X GET "$SITE/api/catalog"

POST /v1/run

运行一个已公开的私有能力

curl -X POST "$SITE/v1/run" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $YOUR_KEY" \
  -d '{
    "capabilityId": "signal.map",
    "input": {
      "brief": "Need an agent-friendly website for a private workflow runtime.",
      "channel": "website",
      "urgency": "medium"
    }
  }'

POST /v1/verify

验证返回结果是否来自官方执行

curl -X POST "$SITE/v1/verify" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $YOUR_KEY" \
  -d '{
    "executionId": "exec_xxx",
    "verificationToken": "token_xxx"
  }'

Errors

  • `401` missing or invalid API key
  • `404` unknown capability or execution id
  • `422` invalid input payload

Limits

  • Public pages and discovery files are optimized for static reads.
  • Execution endpoints are rate-limited by key and intended for seed usage.
  • Do not treat v1 as a bulk processing API.