QuillBot Python SDK
A lightweight, purely HTTP-based Python SDK for interacting with the QuillBot API.
This SDK allows you to easily integrate QuillBot's paraphrasing, translation, and summarizing capabilities into your applications, LLM agents, or command-line tools. It automatically handles token refreshing, payload formatting, and concurrent chunking of very large texts, fully mimicking the live web application.
Features
- Paraphrasing: Rewrite text using QuillBot's sophisticated paraphrasing engine. Supports all premium modes including the new AI Humanizer.
- Large Text Support: Send texts of any size (even thousands of words)! The SDK will automatically chunk the text by sentences and process them concurrently, merging the results back together seamlessly.
- Synonym Levels: Adjust the
synonyms_level(0-3) to control the vocabulary replacement strength, identical to the website's Synonyms slider. - Translation: Translate text into over 30 languages using the integrated translation engine.
- Bulk Thesaurus: Automatically fetch synonym suggestions for every word/phrase in the paraphrased text in a single request.
- Summarization: Condense long texts into brief, readable summaries.
- Frozen Words: Prevent specific words or phrases from being altered during paraphrasing.
- Pure HTTP: No browser automation (Selenium/Playwright) required. Extremely fast and lightweight.
Installation
This SDK requires Python 3.10+.
The package is available on PyPI. You can view the project at https://pypi.org/project/quillbot/.
To install the latest version, simply run:
pip install quillbot
Authentication
We highly recommend using email and password authentication. The SDK will automatically fetch, manage, and refresh the necessary JWT tokens in the background, keeping your session alive.
import os
from quillbot import QuillBot
email = os.getenv("QUILLBOT_EMAIL")
password = os.getenv("QUILLBOT_PASSWORD")
# Initialize the client (auto-authenticates and manages tokens)
bot = QuillBot(email=email, password=password)
print(f"Logged in successfully! Premium active: {bot.is_premium}")
You can optionally pass a static token directly if you prefer:
bot = QuillBot(useridtoken="your_static_jwt_token")
Quick Start
Paraphrasing and AI Humanizer
You can paraphrase text across multiple modes, such as ParaphraseMode.STANDARD, ParaphraseMode.FLUENCY, ParaphraseMode.FORMAL, or the new ParaphraseMode.HUMANIZER.
from quillbot.endpoints import ParaphraseMode
text = "The quick brown fox jumps over the lazy dog."
# Standard Paraphrasing with Synonyms Level 2
result = bot.paraphrase(text, mode=ParaphraseMode.STANDARD, synonyms_level=2)
print(f"Paraphrased: {result.paraphrased_text}")
# AI Humanizer
humanized_result = bot.paraphrase(text, mode=ParaphraseMode.HUMANIZER)
print(f"Humanized: {humanized_result.paraphrased_text}")
# Custom Modes
custom_result = bot.paraphrase(text, mode=ParaphraseMode.CUSTOM, custom_mode_name="Shakespearean")
print(f"Custom Output: {custom_result.paraphrased_text}")
# View the individual phrases that were rewritten
print(f"Phrases found: {result.phrases}")
Translation
You can supply the input_lang parameter to translate your output into one of the many supported languages.
from quillbot.endpoints import Language, ParaphraseMode
english_text = "Hello world! This SDK is amazing."
# Translate to French
result = bot.paraphrase(
english_text,
mode=ParaphraseMode.STANDARD,
input_lang=Language.FRENCH
)
print(f"French Translation: {result.paraphrased_text}")
Interactive Editing (Synonym Suggestions)
By default, the SDK automatically fetches thesaurus data for the rewritten text. You can retrieve alternative synonyms for specific words or phrases.
if result.synonyms:
first_word = result.phrases[0]
suggestions = result.available_replacements(first_word)
print(f"Suggestions for '{first_word}': {suggestions}")
Frozen Words
You can protect certain words or phrases from being altered.
frozen_result = bot.paraphrase(
"Python is a great programming language.",
frozen_words=["Python", "programming"]
)
Summarization
long_text = (
"Artificial intelligence (AI) is intelligence demonstrated by machines, "
"as opposed to the natural intelligence displayed by animals including humans. "
"Leading AI textbooks define the field as the study of intelligent agents: "
"any system that perceives its environment and takes actions that maximize "
"its chance of achieving its goals."
)
summary = bot.summarize(long_text)
print("Summary:", summary.summary)
Model Context Protocol (MCP) Server
This SDK includes a fully featured MCP Server that allows AI assistants (like Claude Desktop, Cursor, and Google Antigravity) to directly use QuillBot's paraphrasing and synonym engines.
The server operates entirely over stdio and requires no manual installation of files.
How it works
You do not need to clone this repository or pip install anything. Every client below is configured with the command uvx quillbot. When the client starts, it runs that command; uvx downloads the quillbot package from PyPI into a private cache (first run only), starts the MCP server, and the client talks to it over stdin/stdout. uvx keeps using its cached copy; to pick up a newer release, run uv cache clean quillbot and restart your client, or use "args": ["quillbot@latest"] in your client config to check PyPI on every start.
So setup is always the same three steps:
- Install
uvonce (pip install uvor see the uv docs). - Log in once with
uvx quillbot auth(see below). - Add
uvx quillbotto your client using the instructions for that client.
Run uvx quillbot --help for the complete reference: every MCP tool with all its arguments, types, defaults, allowed values, limits and response formats, plus workflows, SDK usage and file locations.
Troubleshooting uvx
If your client reports spawn uvx ENOENT, the client cannot see your shell PATH (common for desktop apps on macOS). Replace "uvx" in the configs below with the full path printed by which uvx.
Authentication for AI Clients
Because MCP servers run in the background, they need your QuillBot credentials. Run the one-time CLI login in your terminal so you never have to paste your password into an AI chat:
uvx quillbot auth
It prompts for your email and password, verifies them against QuillBot, and saves them to a local credentials.json in your user data directory, readable only by your user (permissions 600). The file is not encrypted.
Alternatively, set QUILLBOT_EMAIL and QUILLBOT_PASSWORD in the env block of your client config:
"env": { "QUILLBOT_EMAIL": "you@example.com", "QUILLBOT_PASSWORD": "..." }
1. Claude Desktop
Add the following to your claude_desktop_config.json (Settings > Developer > Edit Config), then restart Claude Desktop:
{
"mcpServers": {
"quillbot": {
"command": "uvx",
"args": ["quillbot"]
}
}
}
2. Claude Code
claude mcp add quillbot -- uvx quillbot
3. Cursor, Windsurf, Google Antigravity, Gemini CLI
These clients all use the same mcpServers block shown above. Paste it into the client's config file and restart or reload the client:
| Client | Config file | Where to find it in the UI |
|---|---|---|
| Cursor | ~/.cursor/mcp.json (all projects) or .cursor/mcp.json (one project) |
Settings > MCP |
| Windsurf | ~/.codeium/windsurf/mcp_config.json |
Settings > Cascade > MCP Servers > View raw config |
| Google Antigravity | ~/.gemini/config/mcp_config.json |
Agent panel > ... > MCP Servers > Manage MCP Servers > View raw config |
| Gemini CLI | ~/.gemini/settings.json (all projects) or .gemini/settings.json (one project) |
- |
If the file already has other servers, add the "quillbot": {...} entry inside the existing mcpServers object.
4. VS Code (GitHub Copilot)
VS Code uses servers instead of mcpServers. Either run:
code --add-mcp '{"name":"quillbot","command":"uvx","args":["quillbot"]}'
or add this to .vscode/mcp.json in your project:
{
"servers": {
"quillbot": {
"type": "stdio",
"command": "uvx",
"args": ["quillbot"]
}
}
}
5. OpenAI Codex CLI
codex mcp add quillbot -- uvx quillbot
or add to ~/.codex/config.toml:
[mcp_servers.quillbot]
command = "uvx"
args = ["quillbot"]
6. Agent Instructions & Workflows (Prompts)
This server natively exposes a quillbot_workflow MCP Prompt. You do not need to download or configure any JSON files manually!
- In Claude Desktop, simply click the "Prompts" (paperclip/menu) icon and select the "Quillbot Workflow" prompt. Claude will automatically read the official agent instructions.
- In Cursor or Antigravity, you can ask the agent to "Fetch the
quillbot_workflowprompt" to understand how to chain the macro tools together.
Logs
The server writes a log to your user log directory (Linux: ~/.local/state/quillbot_mcp/log/quillbot_mcp.log, macOS: ~/Library/Logs/quillbot_mcp/quillbot_mcp.log). Check it if a client shows the server as failed.
Running Tests
The test suite runs live integration tests against the actual QuillBot servers (as configured). Mocks are not used to ensure we accurately reflect the live API.
- Ensure your
.envcontains a validQUILLBOT_EMAILandQUILLBOT_PASSWORD. - Run the tests:
pytest tests/test_unit.py -v -s
License
This project is licensed under the GNU General Public License v3.0 (GPLv3). See the LICENSE file for details.
Disclaimer
This is an unofficial SDK. Use responsibly and ensure you comply with QuillBot's Terms of Service.
Metadata
Release files for quillbot 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| quillbot-1.0.1.tar.gz | 57.6 kB | With provenance | Details for quillbot-1.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| quillbot-1.0.1-py3-none-any.whl | Python 3 | none | any | Details for quillbot-1.0.1-py3-none-any.whl |
Total release size: 113.9 kB
Release files / quillbot-1.0.1.tar.gz
| Download URL | quillbot-1.0.1.tar.gz |
|---|---|
| Size | 57.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a755cb2ad33ac8b0f3f6bbcfc4756041149c9e7254a8696530759700b1f3d606
|
|
BLAKE2b-256 checksum How to use checksums |
4ece7da1a6100fdb19471e2af604f725398b8dbce55a844db56a44b01b8831dd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency logRelease files / quillbot-1.0.1-py3-none-any.whl
| Download URL | quillbot-1.0.1-py3-none-any.whl |
|---|---|
| Size | 56.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
26a08f4459375a752801bcd4da93516819ef6d238faba1b8d18cc7365fbd8880
|
|
BLAKE2b-256 checksum How to use checksums |
37706407af512b83a56044e844990c3362661be33a4cbfbeafbdf6106798223d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency logSecurity for quillbot 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for quillbot-1.0.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.