Developer‑First 信息架构

开发者文档结构

Docs IA

文档应围绕“路径”组织

不要把文档写成 API 列表;应围绕 Discovery → Handshake → Call → Settle 的路径组织示例与边界条件。

章节内容
Quickstart5 分钟跑通一次会话
Discovery端点与能力选择
Handshake预算/担保/规则承诺
Call调用、重试、降级
Settlement结算、发票、净额
Security签名、审计、KYC/AML
Sample

示例代码(Demo)

# 1) discover
curl -s "https://api.neutralnet.example/v1/discover?needs_sha=true&sovereignty=US"

# 2) handshake
curl -X POST https://api.neutralnet.example/v1/handshake -d '{"endpoint":"ep-gpt-01","budget":{"NC":20},"stake":{"NEUT":10}}'

# 3) call
curl -X POST https://api.neutralnet.example/v1/call -d '{"session":"sess-a1b2","messages":[{"role":"user","content":"hello"}]}'

# 4) settle
curl -X POST https://api.neutralnet.example/v1/settle -d '{"session":"sess-a1b2"}'