API Reference
查看由 OpenAPI 3.1 契约生成的参数、Schema 和响应。
打开 Scalar Reference →这份 Quickstart 使用仓库内置 Mock API,帮助你验证 Job、幂等键和结果查询。它不会连接真实供应商,也不会产生费用。
查看由 OpenAPI 3.1 契约生成的参数、Schema 和响应。
打开 Scalar Reference →机器可读的稳定契约,适合生成客户端和校验请求。
打开 openapi.json →在仓库中启动 Mock API,并运行契约测试。
阅读完整指南 →在 Community 仓库根目录运行:
pnpm install pnpm mock
每个请求都带上唯一的幂等键:
curl -X POST http://localhost:8787/v1/monitor-runs \
-H 'content-type: application/json' \
-H 'idempotency-key: quickstart-001' \
-d '{"capability_id":"observe.ai_answer","prompts":["mock quickstart"],"turnaround_class":"best_effort","interaction_mode":"search"}'把创建响应中的实际 id 填入 JOB_ID;下面的 job_mock_1 只是示意。第一次查询为 running,第二次为 succeeded,再读取 items。这是本地模拟规则,真实客户端必须根据 status 与 result_state 判断生命周期。
JOB_ID='job_mock_1' curl "http://localhost:8787/v1/jobs/$JOB_ID" curl "http://localhost:8787/v1/jobs/$JOB_ID" curl "http://localhost:8787/v1/jobs/$JOB_ID/items"
job_demo_* 是固定 Fixture,不会随查询推进。遇到部分结果、失败或超时,阅读 结果处理指南。Windows 用户可使用 PowerShell CLI 教程。