Convert Chinese (Hanzi) text to pinyin romanization. Choose tone marks (symbol, e.g. hàn yǔ), numbered tones (han4 yu3), or no tones. Auto-segments words and returns the full pinyin string plus a per-syllable array. Deterministic, keyless — useful for transliteration, pronunciation, search indexing, and TTS prep.
/api/chinese/pinyinPAYMENT-SIGNATURE.The pinyin API is a pay-per-call chinese endpoint built for AI agents and autonomous software. Convert Chinese (Hanzi) text to pinyin romanization.
There is no signup and no API key. An agent (or any HTTP client) hits the endpoint, receives an x402 "402 Payment Required" challenge, signs a sub-cent USDC payment on Base or Solana, and retries — the data comes back on the paid request. That makes it a drop-in pinyin data source for an agent tool-use loop, an MCP host, or a backend that needs chinese data on demand without onboarding to yet another vendor portal.
| Name | Type | Description |
|---|---|---|
textrequired | string | min 1 chars · max 2000 chars |
tone | string | one of: symbol | num | none |
segmented | boolean | Include the per-word segment array. |
# 1. Probe with no auth → 402 envelope with PaymentRequirements curl -sS 'https://2s.io/api/chinese/pinyin?text=example&tone=symbol&segmented=false' # 2. Sign + retry with PAYMENT-SIGNATURE: curl -sS 'https://2s.io/api/chinese/pinyin?text=example&tone=symbol&segmented=false' \ -H 'PAYMENT-SIGNATURE: <base64-json-payload>' # Or use the canonical runner (handles probe → sign → retry): # EVM_PRIVATE_KEY=0x... node --env-file=.env.local \ # --experimental-strip-types scripts/x402-pay.ts \ # 'https://2s.io/api/chinese/pinyin?text=example&tone=symbol&segmented=false'
import { TwoS } from '@2sio/sdk'
const client = new TwoS({
privateKey: process.env.EVM_PRIVATE_KEY as `0x${string}`,
})
const result = await client.chinese.pinyin({
"text": "example",
"tone": "symbol",
"segmented": false
})
console.log('endpoint:', result.endpoint)
console.log('cost:', result.costUsd, 'USDC')
console.log('tx:', result.settlement?.txHash)
console.log('data:', result.data)import os
from twosio import TwoS
client = TwoS(private_key=os.environ["EVM_PRIVATE_KEY"])
result = client.chinese.pinyin(text="example", tone="symbol", segmented=False)
print("endpoint:", result.endpoint)
print("cost:", result.cost_usd, "USDC")
print("tx:", (result.settlement or {}).get("tx_hash"))
print("data:", result.data)// 1. Add @2sio/mcp to your MCP host config (Claude Desktop example below).
// EVM_PRIVATE_KEY funds x402 payments per call.
// claude_desktop_config.json
{
"mcpServers": {
"2sio": {
"command": "npx",
"args": ["-y", "@2sio/mcp"],
"env": { "EVM_PRIVATE_KEY": "0x..." }
}
}
}
// 2. Once the server is running, agents call this tool via standard MCP:
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "chinese.pinyin",
"arguments": {
"text": "example",
"tone": "symbol",
"segmented": false
}
}
}| Field | Type | Description |
|---|---|---|
ok | boolean | one of: true |
items | array | |
total | integer | Total matching rows upstream; null when unknown. |
source | object |
{
"ok": true,
"items": [
{
"text": "example",
"toneType": "example",
"pinyin": "example",
"segments": [
"example"
],
"syllables": [
"example"
]
}
],
"total": 1,
"source": {
"provider": "example",
"url": "example",
"license": "example"
}
}