From 68133241f2fe8ff83ec2a1e0457a88fbdf0a587d Mon Sep 17 00:00:00 2001 From: cc-mac-mini Date: Sat, 2 May 2026 23:50:16 +0800 Subject: [PATCH] sync docs links and SDK examples --- README.md | 48 ++++++++++++++---------- README.zh-CN.md | 48 ++++++++++++++---------- docs/concepts.md | 4 ++ docs/contracts.md | 4 ++ docs/credentials.md | 4 ++ docs/github-growth.md | 18 +++++---- docs/sdk.md | 12 ++++-- examples/dashboard-agent-key.md | 8 +++- examples/python-first-call.md | 20 ++++++---- examples/typescript-first-call.md | 22 ++++++----- llm-instructions.md | 62 ++++++++++++++++++++++--------- llms.txt | 23 ++++++++---- 12 files changed, 182 insertions(+), 91 deletions(-) diff --git a/README.md b/README.md index 41a5d35..28fe470 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,9 @@ AI-native API commerce, payment, and settlement infrastructure for agents. -[Read the Full Documentation](https://staging.synapse-network.ai/docs) · -[Python SDK](https://staging.synapse-network.ai/docs/sdk/python) · -[TypeScript SDK](https://staging.synapse-network.ai/docs/sdk/typescript) · +[Read the Full Documentation](https://synapse-network.ai/docs) · +[Python SDK](https://synapse-network.ai/docs/sdk/python) · +[TypeScript SDK](https://synapse-network.ai/docs/sdk/typescript) · [SDK Repository](https://github.com/SynapseNetworkAI/Synapse-Network-Sdk) SynapseNetwork lets agents discover services, call APIs through the platform, pay small USDC-priced amounts through blockchain-backed settlement, and verify every invocation with receipts. @@ -26,18 +26,20 @@ Open the **[Synapse Gateway Dashboard (Testnet Sandbox)](https://staging.synapse Step 2: Let your agent discover and work. ```python +import os + from synapse_client import SynapseClient # Use "staging" for testnet (free), "prod" for mainnet (real USDC). -client = SynapseClient(api_key="agt_xxx", environment="staging") +client = SynapseClient(api_key=os.environ["SYNAPSE_AGENT_KEY"], environment="staging") -services = client.search("free", limit=10) +services = client.search("svc_synapse_echo", limit=10) service = services[0] result = client.invoke( service.service_id, - {"prompt": "hello"}, - cost_usdc=float(service.price_usdc), + {"message": "hello from SynapseNetwork"}, + cost_usdc=str(service.price_usdc), idempotency_key="agent-job-001", ) @@ -46,22 +48,22 @@ print(receipt.invocation_id, receipt.status, receipt.charged_usdc) ``` ```ts -import { SynapseClient } from "@synapse-network/sdk"; +import { SynapseClient } from "@synapse-network-ai/sdk"; const client = new SynapseClient({ - credential: "agt_xxx", + credential: process.env.SYNAPSE_AGENT_KEY!, // Use "staging" for testnet (free), "prod" for mainnet (real USDC). environment: "staging", }); -const services = await client.search("free", { limit: 10 }); +const services = await client.search("svc_synapse_echo", { limit: 10 }); const service = services[0]; const result = await client.invoke( service.serviceId ?? service.id!, - { prompt: "hello" }, + { message: "hello from SynapseNetwork" }, { - costUsdc: Number(service.pricing?.amount ?? 0), + costUsdc: String(service.pricing?.amount ?? "0"), idempotencyKey: "agent-job-001", } ); @@ -86,7 +88,7 @@ The Quickstart uses `staging`. Switch to `prod` only after production is un-gate - Small API payments: agents can pay per invocation instead of relying on large prepaid integrations. - Blockchain-backed settlement: USDC custody and settlement evidence are anchored through the chain-backed payment layer. - Receipts: every invocation can be checked after settlement. -- Staging-first preview: production docs and domains remain reserved until GA. +- Production docs-first discovery with staging as the testnet sandbox. ## For AI Coding Agents @@ -96,13 +98,21 @@ The most important rule: agent runtime code should use `SynapseClient`, not owne ## Full Docs -This repository is the GitHub funnel and agent-readable index. The polished product documentation lives on the Gateway docs site: +This repository is the GitHub funnel and agent-readable index. The polished product documentation lives on the production docs site: + +- SDK hub: +- Python SDK: +- TypeScript SDK: +- Concepts: +- Contracts: + +Staging remains the public testnet sandbox for first calls and integration tests: . + +Preview SDK guides for Go, Java/JVM, and .NET live in the official SDK repository until product docs pages are generated: -- SDK hub: -- Python SDK: -- TypeScript SDK: -- Concepts: -- Contracts: +- Go SDK: +- Java/JVM SDK: +- .NET SDK: V1 intentionally does not expose "Edit this page" links from the docs site because this repository is not yet the source of truth for every rendered docs page. Please use GitHub Issues for docs feedback until docs-source sync lands. diff --git a/README.zh-CN.md b/README.zh-CN.md index dd24b6d..01a1674 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -10,9 +10,9 @@ 面向 AI Agent 的 API 调用、支付与结算基础设施。 -[阅读完整文档](https://staging.synapse-network.ai/docs) · -[Python SDK](https://staging.synapse-network.ai/docs/sdk/python) · -[TypeScript SDK](https://staging.synapse-network.ai/docs/sdk/typescript) · +[阅读完整文档](https://synapse-network.ai/docs) · +[Python SDK](https://synapse-network.ai/docs/sdk/python) · +[TypeScript SDK](https://synapse-network.ai/docs/sdk/typescript) · [SDK 仓库](https://github.com/SynapseNetworkAI/Synapse-Network-Sdk) SynapseNetwork 让 Agent 可以发现服务、通过平台调用接口、用区块链支持的 USDC 完成小额付款，并通过 receipt 验证每次调用与结算结果。 @@ -26,18 +26,20 @@ SynapseNetwork 让 Agent 可以发现服务、通过平台调用接口、用区 步骤 2：让 Agent 自动发现服务并开始工作。 ```python +import os + from synapse_client import SynapseClient # 使用 "staging" 连接测试网免费环境，使用 "prod" 连接主网真实 USDC 环境。 -client = SynapseClient(api_key="agt_xxx", environment="staging") +client = SynapseClient(api_key=os.environ["SYNAPSE_AGENT_KEY"], environment="staging") -services = client.search("free", limit=10) +services = client.search("svc_synapse_echo", limit=10) service = services[0] result = client.invoke( service.service_id, - {"prompt": "hello"}, - cost_usdc=float(service.price_usdc), + {"message": "hello from SynapseNetwork"}, + cost_usdc=str(service.price_usdc), idempotency_key="agent-job-001", ) @@ -46,22 +48,22 @@ print(receipt.invocation_id, receipt.status, receipt.charged_usdc) ``` ```ts -import { SynapseClient } from "@synapse-network/sdk"; +import { SynapseClient } from "@synapse-network-ai/sdk"; const client = new SynapseClient({ - credential: "agt_xxx", + credential: process.env.SYNAPSE_AGENT_KEY!, // 使用 "staging" 连接测试网免费环境，使用 "prod" 连接主网真实 USDC 环境。 environment: "staging", }); -const services = await client.search("free", { limit: 10 }); +const services = await client.search("svc_synapse_echo", { limit: 10 }); const service = services[0]; const result = await client.invoke( service.serviceId ?? service.id!, - { prompt: "hello" }, + { message: "hello from SynapseNetwork" }, { - costUsdc: Number(service.pricing?.amount ?? 0), + costUsdc: String(service.pricing?.amount ?? "0"), idempotencyKey: "agent-job-001", } ); @@ -86,7 +88,7 @@ SynapseNetwork 采用严格的环境隔离来保护资金安全。 - 小额 API 付款：Agent 可以按调用粒度付款，而不是依赖大额预付集成。 - 区块链支持结算：USDC 托管与结算证据由链上支付层承载。 - 可验证 receipt：每次调用都可以在结算后查询结果。 -- Staging-first 公测：生产文档和域名将在 GA 前保持预留。 +- 以生产文档作为主要发现入口，同时保留 staging 作为测试网沙盒。 ## 面向 AI 编码 Agent @@ -96,13 +98,21 @@ SynapseNetwork 采用严格的环境隔离来保护资金安全。 ## 完整文档 -这个仓库是 GitHub 流量入口和 Agent 可读索引；完整产品化文档在 Gateway docs 站点： +这个仓库是 GitHub 流量入口和 Agent 可读索引；完整产品化文档在生产文档站点： + +- SDK hub: +- Python SDK: +- TypeScript SDK: +- Concepts: +- Contracts: + +Staging 仍是公开测试网沙盒，用于首次调用和集成测试：。 + +Go、Java/JVM 和 .NET 的预览版 SDK 指南在产品文档页面生成前，先链接到官方 SDK 仓库： -- SDK hub: -- Python SDK: -- TypeScript SDK: -- Concepts: -- Contracts: +- Go SDK: +- Java/JVM SDK: +- .NET SDK: V1 暂不在 docs 站点展示 “Edit this page”，因为当前仓库还不是渲染文档页面的唯一源码。文档源码同源完成前，请先通过 GitHub Issues 反馈。 diff --git a/docs/concepts.md b/docs/concepts.md index 0ee2a17..f9c227d 100644 --- a/docs/concepts.md +++ b/docs/concepts.md @@ -2,6 +2,10 @@ Canonical concepts docs: +https://synapse-network.ai/docs/concepts + +Staging sandbox concepts: + https://staging.synapse-network.ai/docs/concepts Important sections: diff --git a/docs/contracts.md b/docs/contracts.md index e7e286b..19c1874 100644 --- a/docs/contracts.md +++ b/docs/contracts.md @@ -2,6 +2,10 @@ Canonical contracts docs: +https://synapse-network.ai/docs/contracts + +Staging sandbox contracts: + https://staging.synapse-network.ai/docs/contracts This repository should link to contracts docs rather than duplicating contract reference content until docs-source sync is implemented. diff --git a/docs/credentials.md b/docs/credentials.md index d3178e6..e739820 100644 --- a/docs/credentials.md +++ b/docs/credentials.md @@ -2,6 +2,10 @@ Canonical credentials docs: +https://synapse-network.ai/docs/concepts#credentials + +Staging sandbox credentials: + https://staging.synapse-network.ai/docs/concepts#credentials Agent runtime rule: diff --git a/docs/github-growth.md b/docs/github-growth.md index c9715be..677ab8c 100644 --- a/docs/github-growth.md +++ b/docs/github-growth.md @@ -1,8 +1,8 @@ # GitHub Growth Checklist -Use GitHub as the top-of-funnel surface and the staging docs site as the conversion surface. +Use GitHub as the top-of-funnel surface and the production docs site as the conversion surface. -把 GitHub 作为漏斗顶层入口，把 staging docs 站点作为最终转化阵地。 +把 GitHub 作为漏斗顶层入口，把 production docs 站点作为最终转化阵地。 English appears first. Chinese follows each major section. @@ -22,10 +22,14 @@ SynapseNetwork：AI Agent 通过平台调用 API，并通过区块链支持的 U Recommended website: -https://staging.synapse-network.ai/docs +https://synapse-network.ai/docs Primary dashboard CTA: +https://synapse-network.ai + +Staging sandbox CTA: + https://staging.synapse-network.ai Recommended topics: @@ -57,14 +61,14 @@ Recommended topics: Keep the README clear that: - `staging` is live now, testnet-backed, and uses MockUSDC. -- `prod` is reserved for mainnet GA and uses real USDC. -- Production should not be presented as generally available until DNS, health, funds, and human gates are ready. +- `prod` uses the production docs and app domain and real USDC when production access is enabled. +- If live production docs health checks fail, report it as a release blocker instead of switching the GitHub funnel back to staging. 环境信息必须明确： - `staging` 当前可用，基于测试网，使用 MockUSDC。 -- `prod` 为主网 GA 预留，使用真实 USDC。 -- 在 DNS、health、资金和人工门控准备好之前，不要把 production 描述为已公开可用。 +- `prod` 使用 production docs/app 域名，并在 production access 开放时使用真实 USDC。 +- 如果线上 production docs health check 失败，应作为 release blocker 记录，不要把 GitHub funnel 切回 staging。 ## Brand Message diff --git a/docs/sdk.md b/docs/sdk.md index d46124f..70290a3 100644 --- a/docs/sdk.md +++ b/docs/sdk.md @@ -1,9 +1,13 @@ # SDK Docs Index -Use the staging docs site as the product runbook: +Use the production docs site as the product runbook. Staging remains the sandbox/testnet runbook for first calls. -- SDK hub: https://staging.synapse-network.ai/docs/sdk -- Python SDK: https://staging.synapse-network.ai/docs/sdk/python -- TypeScript SDK: https://staging.synapse-network.ai/docs/sdk/typescript +- SDK hub: https://synapse-network.ai/docs/sdk +- Python SDK: https://synapse-network.ai/docs/sdk/python +- TypeScript SDK: https://synapse-network.ai/docs/sdk/typescript +- Staging sandbox SDK hub: https://staging.synapse-network.ai/docs/sdk +- Go SDK guide: https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/go_integration.md +- Java/JVM SDK guide: https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/java_integration.md +- .NET SDK guide: https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/dotnet_integration.md This repository keeps the GitHub billboard, agent prompt rules, and short copyable examples. It is not yet the source of truth for every rendered docs page. diff --git a/examples/dashboard-agent-key.md b/examples/dashboard-agent-key.md index 306f6f4..02e276e 100644 --- a/examples/dashboard-agent-key.md +++ b/examples/dashboard-agent-key.md @@ -20,6 +20,10 @@ The agent runtime should not receive owner private keys, wallet mnemonics, or ow Agent 运行时不应该接收 owner 私钥、钱包助记词或 owner JWT。 -Full docs: https://staging.synapse-network.ai/docs/concepts#credentials +Full docs: https://synapse-network.ai/docs/concepts#credentials -完整文档：https://staging.synapse-network.ai/docs/concepts#credentials +Staging sandbox docs: https://staging.synapse-network.ai/docs/concepts#credentials + +完整文档：https://synapse-network.ai/docs/concepts#credentials + +Staging 沙盒文档：https://staging.synapse-network.ai/docs/concepts#credentials diff --git a/examples/python-first-call.md b/examples/python-first-call.md index 4e8b80a..e291125 100644 --- a/examples/python-first-call.md +++ b/examples/python-first-call.md @@ -7,23 +7,25 @@ Use this when the developer or AI agent already has an Agent Key from the Synaps ```bash pip install synapse-client export SYNAPSE_ENV=staging -export SYNAPSE_API_KEY=agt_xxx +export SYNAPSE_AGENT_KEY=agt_xxx ``` ```python +import os + from synapse_client import SynapseClient # Use "staging" for testnet (free), "prod" for mainnet (real USDC). # 使用 "staging" 连接测试网免费环境，使用 "prod" 连接主网真实 USDC 环境。 -client = SynapseClient() +client = SynapseClient(api_key=os.environ["SYNAPSE_AGENT_KEY"]) -services = client.search("free", limit=10) +services = client.search("svc_synapse_echo", limit=10) service = services[0] result = client.invoke( service.service_id, - {"prompt": "hello"}, - cost_usdc=float(service.price_usdc), + {"message": "hello from SynapseNetwork"}, + cost_usdc=str(service.price_usdc), idempotency_key="agent-job-001", ) @@ -31,6 +33,10 @@ receipt = client.get_invocation(result.invocation_id) print(receipt.invocation_id, receipt.status, receipt.charged_usdc) ``` -Full runbook: https://staging.synapse-network.ai/docs/sdk/python +Full runbook: https://synapse-network.ai/docs/sdk/python + +Staging sandbox runbook: https://staging.synapse-network.ai/docs/sdk/python + +完整接入手册：https://synapse-network.ai/docs/sdk/python -完整接入手册：https://staging.synapse-network.ai/docs/sdk/python +Staging 沙盒接入手册：https://staging.synapse-network.ai/docs/sdk/python diff --git a/examples/typescript-first-call.md b/examples/typescript-first-call.md index 166de65..905fbb1 100644 --- a/examples/typescript-first-call.md +++ b/examples/typescript-first-call.md @@ -5,29 +5,29 @@ Use this when the developer or AI agent already has an Agent Key from the Synaps 当开发者或 AI Agent 已经从 Synapse Gateway Dashboard 获取 Agent Key 时，使用这个示例。 ```bash -npm install @synapse-network/sdk +npm install @synapse-network-ai/sdk export SYNAPSE_ENV=staging -export SYNAPSE_API_KEY=agt_xxx +export SYNAPSE_AGENT_KEY=agt_xxx ``` ```ts -import { SynapseClient } from "@synapse-network/sdk"; +import { SynapseClient } from "@synapse-network-ai/sdk"; const client = new SynapseClient({ - credential: process.env.SYNAPSE_API_KEY!, + credential: process.env.SYNAPSE_AGENT_KEY!, // Use "staging" for testnet (free), "prod" for mainnet (real USDC). // 使用 "staging" 连接测试网免费环境，使用 "prod" 连接主网真实 USDC 环境。 environment: "staging", }); -const services = await client.search("free", { limit: 10 }); +const services = await client.search("svc_synapse_echo", { limit: 10 }); const service = services[0]; const result = await client.invoke( service.serviceId ?? service.id!, - { prompt: "hello" }, + { message: "hello from SynapseNetwork" }, { - costUsdc: Number(service.pricing?.amount ?? 0), + costUsdc: String(service.pricing?.amount ?? "0"), idempotencyKey: "agent-job-001", } ); @@ -36,6 +36,10 @@ const receipt = await client.getInvocation(result.invocationId); console.log(receipt.invocationId, receipt.status, receipt.chargedUsdc); ``` -Full runbook: https://staging.synapse-network.ai/docs/sdk/typescript +Full runbook: https://synapse-network.ai/docs/sdk/typescript -完整接入手册：https://staging.synapse-network.ai/docs/sdk/typescript +Staging sandbox runbook: https://staging.synapse-network.ai/docs/sdk/typescript + +完整接入手册：https://synapse-network.ai/docs/sdk/typescript + +Staging 沙盒接入手册：https://staging.synapse-network.ai/docs/sdk/typescript diff --git a/llm-instructions.md b/llm-instructions.md index 3eba755..3e840c6 100644 --- a/llm-instructions.md +++ b/llm-instructions.md @@ -10,10 +10,11 @@ CRITICAL RULES FOR AI AGENTS: 2. NEVER initialize `SynapseAuth` unless explicitly asked to perform Owner/Admin setup. 3. NEVER ask the user for their wallet private keys. 4. You MUST use an Agent Key (format: `agt_xxx`). -5. ALWAYS call `.search()` to discover the service before invoking. -6. ALWAYS extract `price_usdc` from the search result and pass it to the invoke method. -7. ALWAYS provide an `idempotency_key`. -8. ALWAYS fetch and read the receipt after invocation to verify settlement. +5. Public examples MUST read it from `SYNAPSE_AGENT_KEY`. +6. For fixed-price API services, ALWAYS call `.search()` first, extract `price_usdc`, and pass it exactly to `invoke()`. +7. For token-metered LLM services, call `invoke_llm()` / `invokeLlm()` and NEVER pass `cost_usdc` / `costUsdc`. +8. ALWAYS provide an `idempotency_key`. +9. ALWAYS fetch and read the receipt after invocation to verify settlement. @@ -22,10 +23,11 @@ AI Agent 中文规则： 2. 除非用户明确要求 Owner/Admin 设置，否则不要初始化 `SynapseAuth`。 3. 不要向用户索要钱包私钥。 4. 必须使用 Agent Key，格式为 `agt_xxx`。 -5. 调用前必须先 `.search()` 发现服务。 -6. 必须从搜索结果读取 `price_usdc`，并把价格传给 invoke 方法。 -7. 必须提供 `idempotency_key`。 -8. 调用后必须读取 receipt，确认结算状态。 +5. 公开示例必须从 `SYNAPSE_AGENT_KEY` 读取。 +6. 普通 fixed-price API 调用前必须先 `.search()`，读取 `price_usdc`，并原样传给 `invoke()`。 +7. 按 token 计费的 LLM 服务必须使用 `invoke_llm()` / `invokeLlm()`，不要传 `cost_usdc` / `costUsdc`。 +8. 必须提供 `idempotency_key`。 +9. 调用后必须读取 receipt，确认结算状态。 ## Python Pattern @@ -33,16 +35,18 @@ AI Agent 中文规则： Python 模式。 ```python +import os + from synapse_client import SynapseClient -client = SynapseClient(api_key="agt_xxx", environment="staging") -services = client.search("free", limit=10) +client = SynapseClient(api_key=os.environ["SYNAPSE_AGENT_KEY"], environment="staging") +services = client.search("svc_synapse_echo", limit=10) service = services[0] result = client.invoke( service.service_id, - {"prompt": "hello"}, - cost_usdc=float(service.price_usdc), + {"message": "hello from SynapseNetwork"}, + cost_usdc=str(service.price_usdc), idempotency_key="agent-job-001", ) @@ -54,17 +58,20 @@ receipt = client.get_invocation(result.invocation_id) TypeScript 模式。 ```ts -import { SynapseClient } from "@synapse-network/sdk"; +import { SynapseClient } from "@synapse-network-ai/sdk"; -const client = new SynapseClient({ credential: "agt_xxx", environment: "staging" }); -const services = await client.search("free", { limit: 10 }); +const client = new SynapseClient({ + credential: process.env.SYNAPSE_AGENT_KEY!, + environment: "staging", +}); +const services = await client.search("svc_synapse_echo", { limit: 10 }); const service = services[0]; const result = await client.invoke( service.serviceId ?? service.id!, - { prompt: "hello" }, + { message: "hello from SynapseNetwork" }, { - costUsdc: Number(service.pricing?.amount ?? 0), + costUsdc: String(service.pricing?.amount ?? "0"), idempotencyKey: "agent-job-001", } ); @@ -72,6 +79,27 @@ const result = await client.invoke( const receipt = await client.getInvocation(result.invocationId); ``` +## Token-Metered LLM Pattern + +Token-metered LLM 模式。 + +```python +result = client.invoke_llm( + "svc_deepseek_chat", + {"messages": [{"role": "user", "content": "hello"}]}, + max_cost_usdc="0.010000", + idempotency_key="llm-job-001", +) +``` + +```ts +const result = await client.invokeLlm( + "svc_deepseek_chat", + { messages: [{ role: "user", content: "hello" }] }, + { maxCostUsdc: "0.010000", idempotencyKey: "llm-job-001" } +); +``` + ## When Owner/Admin Setup Is Explicitly Requested Only then use `SynapseAuth` to connect a wallet, issue credentials, or manage provider services. Keep owner JWTs and wallet private keys out of agent runtime code. diff --git a/llms.txt b/llms.txt index f0b9aa9..4a80a15 100644 --- a/llms.txt +++ b/llms.txt @@ -24,23 +24,28 @@ README 语言结构： 2. `README.zh-CN.md` - Simplified Chinese GitHub billboard and fast agent quickstart. 3. `llm-instructions.md` - compact prompt rules for coding agents. 4. `examples/` - copyable first-call examples. -5. `docs/` - lightweight links into the staging docs site. +5. `docs/` - lightweight links into the production docs site, with staging kept as the sandbox. 1. `README.md` - 英文 GitHub 广告牌和快速接入。 2. `README.zh-CN.md` - 简体中文 GitHub 广告牌和快速接入。 3. `llm-instructions.md` - 给编码 Agent 使用的精简提示规则。 4. `examples/` - 可复制的首次调用示例。 -5. `docs/` - 指向 staging 文档站的轻量索引。 +5. `docs/` - 指向 production 文档站的轻量索引，并保留 staging 作为沙盒。 ## Canonical Product Docs 权威产品文档。 -- SDK hub: https://staging.synapse-network.ai/docs/sdk -- Python SDK: https://staging.synapse-network.ai/docs/sdk/python -- TypeScript SDK: https://staging.synapse-network.ai/docs/sdk/typescript -- Concepts: https://staging.synapse-network.ai/docs/concepts -- Contracts: https://staging.synapse-network.ai/docs/contracts +- Docs home: https://synapse-network.ai/docs +- SDK hub: https://synapse-network.ai/docs/sdk +- Python SDK: https://synapse-network.ai/docs/sdk/python +- TypeScript SDK: https://synapse-network.ai/docs/sdk/typescript +- Concepts: https://synapse-network.ai/docs/concepts +- Contracts: https://synapse-network.ai/docs/contracts +- Staging sandbox docs: https://staging.synapse-network.ai/docs +- Go SDK guide: https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/go_integration.md +- Java/JVM SDK guide: https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/java_integration.md +- .NET SDK guide: https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/dotnet_integration.md ## V1 Docs Contribution Rule @@ -65,3 +70,7 @@ SynapseNetwork 是面向 AI Agent 的 API 调用、支付与结算平台。Agent Agent integrations should prefer `SynapseClient` with an `agt_xxx` Agent Key. Do not use owner wallet or `SynapseAuth` flows unless the user explicitly asks for owner/admin setup. Agent 接入应优先使用 `SynapseClient` 和 `agt_xxx` Agent Key。除非用户明确要求 Owner/Admin 设置，否则不要使用 owner 钱包或 `SynapseAuth` 流程。 + +Public examples should read Agent Keys from `SYNAPSE_AGENT_KEY`, preserve USDC amounts as strings, and target `staging` for sandbox calls. + +公开示例应从 `SYNAPSE_AGENT_KEY` 读取 Agent Key，保持 USDC 金额为字符串，并使用 `staging` 进行沙盒调用。