Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 29 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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",
)

Expand All @@ -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",
}
);
Expand All @@ -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

Expand All @@ -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: <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 remains the public testnet sandbox for first calls and integration tests: <https://staging.synapse-network.ai/docs>.

Preview SDK guides for Go, Java/JVM, and .NET live in the official SDK repository until product docs pages are generated:

- 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>
- Go SDK: <https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/go_integration.md>
- Java/JVM SDK: <https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/java_integration.md>
- .NET SDK: <https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/dotnet_integration.md>

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.

Expand Down
48 changes: 29 additions & 19 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 验证每次调用与结算结果。
Expand All @@ -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",
)

Expand All @@ -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",
}
);
Expand All @@ -86,7 +88,7 @@ SynapseNetwork 采用严格的环境隔离来保护资金安全。
- 小额 API 付款:Agent 可以按调用粒度付款,而不是依赖大额预付集成。
- 区块链支持结算:USDC 托管与结算证据由链上支付层承载。
- 可验证 receipt:每次调用都可以在结算后查询结果。
- Staging-first 公测:生产文档和域名将在 GA 前保持预留
- 以生产文档作为主要发现入口,同时保留 staging 作为测试网沙盒

## 面向 AI 编码 Agent

Expand All @@ -96,13 +98,21 @@ SynapseNetwork 采用严格的环境隔离来保护资金安全。

## 完整文档

这个仓库是 GitHub 流量入口和 Agent 可读索引;完整产品化文档在 Gateway docs 站点:
这个仓库是 GitHub 流量入口和 Agent 可读索引;完整产品化文档在生产文档站点:

- 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 仍是公开测试网沙盒,用于首次调用和集成测试:<https://staging.synapse-network.ai/docs>。

Go、Java/JVM 和 .NET 的预览版 SDK 指南在产品文档页面生成前,先链接到官方 SDK 仓库:

- 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>
- Go SDK: <https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/go_integration.md>
- Java/JVM SDK: <https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/java_integration.md>
- .NET SDK: <https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/dotnet_integration.md>

V1 暂不在 docs 站点展示 “Edit this page”,因为当前仓库还不是渲染文档页面的唯一源码。文档源码同源完成前,请先通过 GitHub Issues 反馈。

Expand Down
4 changes: 4 additions & 0 deletions docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions docs/contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 4 additions & 0 deletions docs/credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
18 changes: 11 additions & 7 deletions docs/github-growth.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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:
Expand Down Expand Up @@ -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

Expand Down
12 changes: 8 additions & 4 deletions docs/sdk.md
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 6 additions & 2 deletions examples/dashboard-agent-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
20 changes: 13 additions & 7 deletions examples/python-first-call.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,36 @@ 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",
)

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
Loading
Loading