← Back to home

Developer API & MCP

Use Beaut1fy from your editor or scripts. Same credits as the iOS/Android app — no Beaut1fy desktop install.

Get started

  1. Sign in to the Beaut1fy app and open Usage → MCP.
  2. Create an API key (shown once — copy it before closing).
  3. Paste the config below into your MCP client and restart.

MCP endpoint: https://beaut1fy.web.app/v1/mcp

AI Agent Skill (optional)

A portable SKILL.md bundle that teaches your coding agent when to call text_beautify, text_improve, text_emojis, and text_remove_emojis — works with Cursor, Claude Code, Codex, and other MCP-capable agents.

Download skill (.zip)

Install — unzip so the folder contains SKILL.md:

ClientProjectGlobal
Cursor.cursor/skills/beaut1fy-mcp-and-api/~/.cursor/skills/beaut1fy-mcp-and-api/
Claude Code.claude/skills/beaut1fy-mcp-and-api/~/.claude/skills/beaut1fy-mcp-and-api/
Codex.agents/skills/beaut1fy-mcp-and-api/see Codex docs for agent skills

Restart the client or reopen the project. MCP setup (API key + config below) is still required. Claude Desktop has no agent skills — MCP alone is enough there. Cloning the Beaut1fy repo includes this skill under .cursor/skills/.

Cursor

Add to .cursor/mcp.json in your project.

{
  "mcpServers": {
    "beaut1fy": {
      "url": "https://beaut1fy.web.app/v1/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

Claude Desktop (macOS)

~/Library/Application Support/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "beaut1fy": {
      "url": "https://beaut1fy.web.app/v1/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

Direct API

POST /v1/beautify with your API key for scripts.

curl -sS -X POST "https://beaut1fy.web.app/v1/beautify" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"hey can u send the deck tmrw thx","mode":"beautify"}'

API reference

Base URL: https://beaut1fy.web.app

Endpoint

POST /v1/beautify — refine text (same pipeline as the app and MCP).

  • Auth: Authorization: Bearer bf_live_<keyId>_<secret>
  • Content-Type: application/json
  • Rate limit: 30 requests/min per account (MCP and REST share the beautify bucket family)

Request body

FieldTypeDefaultNotes
textstring—Required. Max ~40k characters.
modestringbeautifybeautify, improve, emojis, remove_emojis
probooleanfalsePro model — more credits per token
emojisbooleanfalseAdd emojis on beautify / improve (does not remove existing emojis)
intensitystringnormallow … max — improve mode only
writingVariantstringAuto (omit)BCP-47 tag, e.g. en-GB, en-US — improve mode only
writingTonestringnormale.g. professional, friendly, police — improve mode only
emojiIntensitystringnormallow … max — emojis mode or emojis: true

Modes

modeWhat it does
beautifyLight polish — clarity and naturalness, meaning preserved
improveStronger rewrite — clearer structure, more professional tone
emojisKeep wording, add fitting emojis
remove_emojisStrip all emojis, keep wording intact

Response

{
  "text": "...",
  "creditsUsed": 1.22,
  "remainingCredits": 133.88,
  "usage": { "inputTokens": 46, "outputTokens": 15, "totalTokens": 61 },
  "unchanged": true
}

unchanged is present when no credits were charged (output matched input).

Examples

Beautify

curl -sS -X POST "https://beaut1fy.web.app/v1/beautify" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"hey can u send the deck tmrw thx","mode":"beautify"}'

Beautify + emojis

curl -sS -X POST "https://beaut1fy.web.app/v1/beautify" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"gute nacht","mode":"beautify","emojis":true,"emojiIntensity":"normal"}'

Improve + intensity

curl -sS -X POST "https://beaut1fy.web.app/v1/beautify" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"hallo wie gehts","mode":"improve","intensity":"high"}'

Improve + British English

curl -sS -X POST "https://beaut1fy.web.app/v1/beautify" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"hello how are you","mode":"improve","writingVariant":"en-GB"}'

Emojis (max intensity)

curl -sS -X POST "https://beaut1fy.web.app/v1/beautify" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"gute nacht","mode":"emojis","emojiIntensity":"max"}'

Remove emojis

curl -sS -X POST "https://beaut1fy.web.app/v1/beautify" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"Hallo 👋 wie gehts 😊","mode":"remove_emojis"}'

Improve + Pro + emojis

curl -sS -X POST "https://beaut1fy.web.app/v1/beautify" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"gute nacht","mode":"improve","pro":true,"emojis":true,"intensity":"normal","emojiIntensity":"normal"}'

MCP tools

MCP clients call tools/call with these tool names (mode is set automatically):

ToolUse whenOptional args
text_beautifyLight polish / fix grammaremojis, emojiIntensity, pro
text_improveStronger rewrite / formalizeintensity, emojis, emojiIntensity, pro, writingVariant, writingTone
text_emojisAdd emojis, keep wordingemojiIntensity
text_remove_emojisStrip emojis from text—
beautify_textLegacy — pass mode yourselfall REST fields

Security

  • API keys are stored hashed on our servers; only a prefix is shown after creation.
  • Anyone with your key can spend your credits — revoke compromised keys in Usage → MCP.
  • MCP and API requests use the same processing and privacy rules as the app.