# Chinese Text Toolkit (Pinyin, Traditional/Simplified, Names) (`awake_froghopper/chinese-text-toolkit`) Actor

Convert Chinese text: pinyin with tones, traditional ↔ simplified, character split, and personal-name romanization. Pure text, no proxy, millisecond runs. Built for AI agents and RAG.

- **URL**: https://apify.com/awake_froghopper/chinese-text-toolkit.md
- **Developed by:** [Wayne Blomfield](https://apify.com/awake_froghopper) (community)
- **Security:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 80.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-usage

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Chinese Text Toolkit

Convert Chinese text for AI agents, RAG pipelines, and localization workflows.

### Operations

| operation | What it does |
|---|---|
| `pinyin` | Romanize with tone marks (`zhōng`), numbered tones (`zhong1`), or plain |
| `toSimplified` | Traditional → Simplified |
| `toTraditional` | Simplified → Traditional (Taiwan-oriented mapping via zhconv) |
| `namePinyin` | Personal-name romanization (compound surnames like 欧阳, Western order Given + Surname) |
| `chars` | Split into non-whitespace characters |

### Example input

```json
{
  "operation": "pinyin",
  "texts": ["中文工具"],
  "toneStyle": "tone"
}
```

### Example output row

```json
{
  "operation": "pinyin",
  "input": "中文工具",
  "result": "zhōng wén gōng jù"
}
```

### Name romanization

```json
{ "operation": "namePinyin", "texts": ["欧阳娜娜"], "toneStyle": "none" }
```

→ `surname`: `ou yang` (or joined), `given`: given-name syllables, `result`: Given Surname (Western order).

### Limits

- Max 200 strings per run, 5000 characters each
- Pure CPU, no proxy, no network
- Memory: 256 MB is enough

### Pricing

Published free for now. Pay-per-event pricing may be enabled later.

### Compliance

Processes only the text you send. No scraping, no storage of personal data beyond the run dataset you control.

# Actor input Schema

## `operation` (type: `string`):

What to do with the text(s).

## `texts` (type: `array`):

One or more Chinese strings to process (max 200).

## `text` (type: `string`):

Optional single string. Merged into texts if provided.

## `toneStyle` (type: `string`):

Only for pinyin / namePinyin. tone = diacritics (zhōng), tone3 = numbers (zhong1), none = no tones.

## `separator` (type: `string`):

Join syllables with this string (default space). Use empty string for no spaces.

## `heteronym` (type: `boolean`):

For pinyin: if true, return all readings for polyphones (slower, larger output).

## Actor input object example

```json
{
  "operation": "pinyin",
  "texts": [
    "你好世界"
  ],
  "text": "",
  "toneStyle": "tone",
  "separator": " ",
  "heteronym": false
}
```

# Actor output Schema

## `dataset` (type: `string`):

One row per input text.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "texts": [
        "你好世界"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("awake_froghopper/chinese-text-toolkit").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "texts": ["你好世界"] }

# Run the Actor and wait for it to finish
run = client.actor("awake_froghopper/chinese-text-toolkit").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "texts": [
    "你好世界"
  ]
}' |
apify call awake_froghopper/chinese-text-toolkit --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,awake_froghopper/chinese-text-toolkit"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/Gj2BkE4YB6qeL7qMN/builds/Hq9hgbMED6ED4EK9q/openapi.json