Skip to content

README_EN.md

Latest commit

 

History

History
346 lines (224 loc) · 13.6 KB

README_EN.md

File metadata and controls

346 lines (224 loc) · 13.6 KB
Raw

Aitoearn: The Best Open-Source AI Agent for Content Marketing

yikart%2FAiToEarn | Trendshift

GitHub stars GitHub license Required Node.JS 20.18.x

English | 简体中文 | 日本語

Monetize · Publish · Engage · Create — all in one platform.

AiToEarn helps OPCs (One-Person Companies), creators, brands, and businesses build, distribute, and monetize content with AI-powered automation across the world's most popular platforms.

Supported Channels: Douyin, Xiaohongshu (Rednote), Kuaishou, Bilibili, WeChat Channels, WeChat Official Accounts, TikTok, YouTube, Facebook, Instagram, Threads, Twitter (X), Pinterest, LinkedIn

🚀 Quick Start with AiToEarn (5 Ways)

Option Best for Deployment needed?
① Use the Website Everyone ❌ No
② Use in OpenClaw OpenClaw users ❌ No
③ Use in Claude / Cursor / Other AI Assistants AI tool users ❌ No
④ Docker One-Click Deploy Teams wanting self-hosted ✅ Server needed
⑤ Build from Source Developers ✅ Dev environment needed

💡 Options ②③④ require an API Key first. See How to Get an API Key.

What's New

  • 2026-06-23: 2.5 version — Relay configuration now happens in the Configuration UI and is split into Server Relay and AI Relay: Server Relay handles publishing platform authorization, while AI Relay lets users use AI models provided by the platform.
  • 2026-05-21: 2.4 version — Draft generation now supports HappyHorse 1.0 and Seedance 2.0, with improved batch video/image-text draft generation, multi-model selection, reference images/videos, target-platform limits, and caption prompts; refreshed interface style and enhanced Twitter/X exploration and engagement.
  • 2026-04-20: OpenClaw now supports AiToEarn earning workflows, so you can receive and execute monetization tasks directly inside OpenClaw.
  • 2026-03-26: 2.1 version — Content marketplace launched; added OpenClaw support for using AiToEarn directly within OpenClaw; added MCP protocol support for using AiToEarn in Claude, Cursor, and any MCP-compatible Agent or LLM.
  • 2026-02-07: 1.8.0 version — Added offline business promotion solutions for restaurants, retail stores, hotels, beauty salons, gyms, and more.
  • 2025-12-15: "All In Agent" arrives! We've introduced a super AI agent that can automatically generate and publish content. v1.4.3
  • 2025-11-28: Support automatic updates within the application. Added AI functions: abbreviation, expansion, image creation, video creation, tag generation, etc. v1.4.0
  • 2025-11-12: The first open-source, fully usable version. v1.3.2
  • 2025-09-16: First international version, added support for Facebook, Instagram, Threads, Twitter, YouTube, TikTok, Pinterest. v1.0.18
  • 2025-02-26: First open-source release, initial support for one-click publishing to Xiaohongshu, Douyin, Kuaishou, and WeChat Channels. v0.1.1

Table of Contents
  1. Quick Start with AiToEarn (5 Ways)
  2. What's New
  3. Key Features
  4. How to Get an API Key
  5. Contributing
  6. Contact
  7. Recommended

Key Features

AiToEarn provides four core Agent capabilities around the creator's full monetization pipeline:

Monetize · Publish · Engage · Create

💰 Monetize — Earn from Your Content

The core mission of AiToEarn: help every creator earn money.

Creators can sell content on the platform to complete brand promotion tasks. All settlements are results-driven, with three models:

Model Full Name Meaning
CPS Cost Per Sale Settle by transaction amount
CPE Cost Per Engagement Settle by engagement count
CPM Cost Per Mille Settle by view count

📢 Publish — Content Publishing Agent

Distribute content to 10+ major platforms worldwide with one click — no more manual posting on each platform.

  • Multi-Platform Distribution: Douyin, Kwai, Bilibili, Rednote, WeChat Channels, WeChat Official Accounts, TikTok, YouTube, Facebook, Instagram, Threads, X (Twitter), Pinterest, LinkedIn
  • Calendar Scheduler: Plan and coordinate content publishing across all platforms like a calendar

▶ Watch Demo Video

Publish Demo Video

💬 Engage — Content Engagement Agent

Automate engagement operations across all supported platforms via the AiToEarn browser extension.

  • Automated Actions: Auto-like, bookmark, and follow — batch operations at scale
  • AI Smart Replies: Use LLMs to generate targeted replies for each comment
  • Comment Mining: Detect high-conversion signals like "link please" or "how to buy" and respond instantly
  • Brand Monitoring: Track brand mentions in real-time and proactively join trending conversations

▶ Watch Demo Video

Engage Demo Video

🎨 Create — Content Creation Agent

We've rebuilt the content creation workflow with Agents. Just tell the Agent what you need — it handles everything from idea to finished product.

Video Content: The Agent automatically invokes video generation models (Grok, Veo, Seedance, etc.), video translation modules, and video editing modules to produce a complete video.

Image & Text Content: Supports top-tier image models like Nano Banana to create high-quality visual content automatically.

Batch Generation: Submit creation tasks in bulk — the Agent generates multiple pieces of content in parallel, perfect for matrix account operations and large-scale content distribution.

▶ Watch Demo Video

Create Demo Video

① Use the Website

The simplest way — just open your browser:

🔑 How to Get an API Key (Required for Steps Below)

Options ②③④ all need an API Key. You only need to get it once.

3 steps:

  1. Open aitoearn.cn (China) or aitoearn.ai (international), sign up and log in
  2. Click Settings in the left menu
  3. Go to API Key, click Create, and copy the generated key

Get API Key

⚠️ Keep your API Key safe. Do not share it with others.

② Use in OpenClaw

Prerequisite: Get an API Key first

Install the plugin

npx -y @aitoearn/openclaw-plugin-cli

On first run, select the environment and enter your API Key. Make sure they match: China uses an API Key from aitoearn.cn, and international uses one from aitoearn.ai. A mismatch returns 401.

After setup, you can receive and execute AiToEarn earning tasks directly inside OpenClaw:

Run AiToEarn earning tasks in OpenClaw

③ Use in Claude / Cursor / Other AI Assistants

Prerequisite: Get an API Key first

AiToEarn works with any MCP-compatible AI assistant. Here's how to configure the most popular ones:

Choose the URL that matches your API Key. A mismatched environment and key returns 401:

Environment MCP URL SSE URL
China https://aitoearn.cn/api/unified/mcp https://aitoearn.cn/api/unified/sse
International https://aitoearn.ai/api/unified/mcp https://aitoearn.ai/api/unified/sse
Claude Desktop

Find and edit claude_desktop_config.json, add:

{
  "mcpServers": {
    "aitoearn": {
      "type": "http",
      "url": "https://aitoearn.ai/api/unified/mcp",
      "headers": {
        "x-api-key": "your-api-key"
      }
    }
  }
}
Cursor

In Cursor's MCP settings, add:

MCP URL: https://aitoearn.ai/api/unified/mcp
Auth Header: x-api-key: your-api-key
Other AI Assistants (Generic Config)

Any MCP-compatible tool just needs two pieces of info:

Setting Value
MCP URL https://aitoearn.ai/api/unified/mcp
Auth Header x-api-key: your-api-key

SSE transport is also available: https://aitoearn.ai/api/unified/sse

💡 For self-hosted instances, replace aitoearn.ai with your own address (e.g., localhost:8080).

④ Docker One-Click Deploy

Prerequisite: Docker installed

For teams wanting to run AiToEarn on their own server. 3 commands, no manual database setup:

git clone https://github.com/yikart/AiToEarn.git
cd AiToEarn
docker compose up -d

Open http://localhost:8080 and you're ready to go.

Configure Relay (Strongly Recommended)

Why Relay? Publishing content requires logging into social media accounts (TikTok, Instagram, YouTube, etc.), which need OAuth developer credentials. With Relay, you can use the official aitoearn.ai credentials — no need to register as a developer on each platform.

Open the deployed UI in your browser, go to Configuration, and configure these sections as needed:

  • Server → Relay: for content publishing and social platform OAuth authorization.
  • AI → Relay: for using AI models provided by the platform.

For OpenAI, Gemini, Anthropic, and other model providers, you can also fill in the platform-provided API key and API URL under AI → Model providers.

See How to Get an API Key. China keys must use https://aitoearn.cn/api, and international keys must use https://aitoearn.ai/api; mismatched environments return 401.

After saving, click Save and restart so the corresponding service reloads the configuration.

📖 Full deployment guide (production config, AI services, OAuth, storage, etc.): DOCKER_DEPLOYMENT_EN.md.

⑤ Build from Source

🧪 Run backend & frontend manually (dev mode)

For local development and debugging. You can use Docker for MongoDB/Redis, or point to your own services.

1. Start the backend services

cd project/aitoearn-backend
pnpm install
# Copy config files for local development
cp apps/aitoearn-ai/config/config.yaml apps/aitoearn-ai/config/local.config.yaml
cp apps/aitoearn-server/config/config.yaml apps/aitoearn-server/config/local.config.yaml
pnpm nx serve aitoearn-ai
# in another terminal
pnpm nx serve aitoearn-server

2. Start the frontend aitoearn-web

pnpm install
pnpm run dev
🖥️ Start Electron desktop project 
# Clone the repo
git clone https://github.com/yikart/AttAiToEarn.git

# Enter directory
cd AttAiToEarn

# Install dependencies
npm install

# Compile sqlite (better-sqlite3 requires node-gyp and local Python)
npm run rebuild

# Start development
npm run dev

The Electron project provides a desktop client for AiToEarn.

Contributing

Please see Contributing Guide to get started.

Contact

If you run into usage difficulties, questions, or unexpected behavior, please open a GitHub Issue first so we can track and respond in one place.

WeChat QR Code

Recommended