Docs menuAPI 參考

API ReferenceTyped request and response

API 參考

TurnitPass REST API

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

Reference console

Start with the route, payload, and response shape.

The full reference covers every endpoint below. The console shows the contract developers need first: Bearer auth, JSON input, metered output, and status checks.

request

POST

fetch('/api/v1/humanize', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer tp_live_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    text: 'Paste the draft here',
    language: 'en',
    mode: 'reduce-aigc'
  })
})

response

200 OK

{
  "output": "The revised text...",
  "words_used": 142,
  "words_remaining": 2858,
  "status": "succeeded"
}

meteredloggedJSON

POST/api/v1/humanize

POST/api/v1/paraphrase

POST/api/v1/detect

POST/api/v1/citation

GET/api/v1/status

AuthBearer API key

TransformPOST /humanize

ReviewPOST /detect

StatusGET /status

POST/api/v1/humanize

降低提交文字中的 AI 痕跡。支援 reduce-aigc、reduce-both、paraphrase、academic-polish 等模式。

POST/api/v1/paraphrase

按標準、流暢、正式、學術、簡潔、創意、擴寫或縮寫模式改寫文字。

POST/api/v1/detect

為貼上文字或解析後的檔案回傳分數、風險等級、元資料和 AI 寫作訊號。

POST/api/v1/citation

將 DOI、URL 或手動來源格式化為 APA、MLA、Chicago、IEEE、Harvard、GB/T 等格式。

GET/api/v1/status

查看金鑰名稱、剩餘字數和請求限制。

Parameters and options

認證

Authorization: Bearer tp_live_...

保留術語

可選 personal_terms 用於在英文自然化改寫中保留專有名詞、技術術語和品牌寫法。

Rate limits and request limits

Transform input

Up to 1,000 wordsApplies to humanize, paraphrase, and rewrite endpoints.

Detection input

Up to 5,000 wordsLonger detector scans should be chunked before submission.

API keys

Up to 5 active keysKeys can be revoked independently from the workspace.

Citation tools

Rate-limited separatelyCitation and bibliography calls do not spend word credits.

Error handling

Error responses use JSON with error,code, and human-readable message fields where possible.

error response

JSON

{
  "error": "Text exceeds word limit. Maximum 1,000 words allowed.",
  "code": "word_limit_exceeded",
  "max_words": 1000,
  "current_words": 1234
}

The Stripe and Google credentials are configuration points. The API surfaces, auth flow, and persistence are implemented so live credentials can be added without redesigning the product.

Examples

Humanize example

JSON

POST /api/v1/humanize
{
  "text": "請把這段 AI 草稿改得更自然。",
  "language": "zh_TW",
  "mode": "reduce-aigc"
}

Multi-endpoint example

JSON

POST /api/v1/detect
{
  "text": "需要檢查的文字",
  "language": "zh_TW",
  "source_kind": "paste"
}

Next steps

快速開始

Set up the first request.

認證

Review API key handling.

更新日誌

See recent platform changes.

fetch('/api/v1/humanize', { method: 'POST', headers: { Authorization: 'Bearer tp_live_your_api_key', 'Content-Type': 'application/json' }, body: JSON.stringify({ text: 'Paste the draft here', language: 'en', mode: 'reduce-aigc' }) })

Rate limits and request limits

Transform input

Up to 1,000 wordsApplies to humanize, paraphrase, and rewrite endpoints.

Detection input

Up to 5,000 wordsLonger detector scans should be chunked before submission.

API keys

Up to 5 active keysKeys can be revoked independently from the workspace.

Citation tools

Rate-limited separatelyCitation and bibliography calls do not spend word credits.

Error handling

Error responses use JSON with error,code, and human-readable message fields where possible.

error response

JSON

{
  "error": "Text exceeds word limit. Maximum 1,000 words allowed.",
  "code": "word_limit_exceeded",
  "max_words": 1000,
  "current_words": 1234
}

The Stripe and Google credentials are configuration points. The API surfaces, auth flow, and persistence are implemented so live credentials can be added without redesigning the product.