Docs menuOverview

DocumentationQuickstart to reference

開發者文件

TurnitPass API 文件

從 API 金鑰開始，呼叫自然化改寫、改寫潤飾、AI 檢測、文獻引用和參考文獻端點，把 TurnitPass 接入你的寫作產品。

One request

Quick example

Send text to the humanizer endpoint with a Bearer API key. The response returns the transformed output, words used, and the remaining word balance for the key owner.

curl

POST /api/v1/humanize

curl -X POST https://turnitpass.com/api/v1/humanize \
  -H "Authorization: Bearer tp_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"text":"Paste your draft here","language":"en","mode":"revise"}'

response

200 OK

{
  "output": "Your humanized text...",
  "words_used": 6,
  "words_remaining": 249994
}

TurnitPass also exposes paraphrase, rewrite, detector, citation, bibliography, and status endpoints from the same API-key flow.

Route map

Explore the docs

快速開始

在工作台建立 API 金鑰，然後用同一個 Bearer 權杖呼叫改寫、AI 檢測和引用介面。

認證

開發者請求使用 TurnitPass 工作台產生的 API 金鑰。

API 參考

自然化改寫、改寫潤飾、AI 檢測、文獻引用、參考文獻和 API 金鑰狀態端點參考。

更新日誌

自然化改寫、AI 檢測、寫作工具、帳單和 API 的近期變化。

發起第一次自然化改寫請求

Create a key and make the first request.

TurnitPass REST API

Review endpoints, parameters, limits, and response shapes.

Production flow

Request lifecycle

Every TurnitPass API call follows the same product path: authenticate the key, validate the payload, run the writing or citation workflow, meter usage, and return a response shape that can be stored by your product.

Authenticate the API key

Send an API key generated from the workspace. Revoked, malformed, or missing keys fail before text processing starts.

Validate text, language, and limits

Transform requests enforce word ranges, detector requests enforce longer scan limits, and citation requests validate style and source input.

Run the workflow

Humanize, paraphrase, rewrite, detect, citation, and bibliography routes reuse the same server-side behavior as the public tools.

Record usage and return output

Successful calls return output plus usage metadata such as words used, remaining balance, status details, or formatted citation exports.

API Surface

Core endpoints

Revise

POST/api/v1/humanize

Revise AI-assisted text while preserving meaning.

Paraphrase

POST/api/v1/paraphrase

Rewrite and polish text in multiple modes.

Detect

POST/api/v1/detect

Return AI-writing signal estimates and revision notes.

Citations

POST/api/v1/citation

Format DOI, URL, or manual source metadata.

Production checklist

Server-side calls

Never expose API keys in client bundlesCall TurnitPass from your backend, worker, queue, or protected server action.

Retry behavior

Retry network failures, not validation failuresHandle 4xx responses as user or payload issues and reserve retries for transient 5xx/network errors.

Word budgets

Show remaining balance before heavy flowsUse the status endpoint to decide whether to queue a job, ask for upgrade, or split a document.

Billing setup

Stripe secrets are final configurationThe checkout, portal, and webhook surfaces are wired; live keys and price IDs are intentionally left for deployment.

For product integrations, keep one TurnitPass key per environment. Production, staging, and local development should be revocable independently.