Docs menuクイックスタート

QuickstartFirst call in minutes

クイックスタート

最初の文章調整リクエストを送信する

ワークスペースからAPIキーを作成し、同じキーを使用して文章調整、AIチェック、引用機能を呼び出します。

Five-minute path

From empty workspace to first humanized draft.

Keep the same sequence as the public product: create access, confirm credits, issue a key, then call the writing endpoint from your server.

Integration path

What has to happen first

4 steps

Create workspace

Google sign-in opens a private API workspace.

Add words

Checkout and portal hooks are ready for final Stripe keys.

Generate key

Copy the key once and store it on your server.

Call /humanize

Send text in and receive metered output back.

Server request

Humanize endpoint

v1 ready

request

POST

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 the AI-assisted draft you want to revise",
    "language": "en",
    "mode": "reduce-aigc"
  }'

response

200 OK

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

Next call

Pair the result with detection or citation endpoints when your app needs review loops.

See examples

Under five minutes

Setup

Create an account

Choose a plan or word budget

Stripe checkout and the customer portal are wired. Live product keys and prices are intentionally left for final configuration.

Create an API key

Generate a key from the workspace, copy it immediately, and send it with your API key.

Make your first request

Use the examples below to call the humanizer endpoint and inspect the response shape.

Your first API call

Replace tp_live_your_api_key with a key generated from the workspace. Requests should be sent from server-side code, not the browser.

Humanize request

curl

curl -X POST https://turnitpass.com/api/v1/humanize \
  -H "Authorization: Bearer tp_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"text":"調整したいAI補助の下書きを貼り付けます","language":"en","mode":"reduce-aigc","personal_terms":["固有名詞"]}'

Paraphrase request

curl

curl -X POST https://turnitpass.com/api/v1/paraphrase \
  -H "Authorization: Bearer tp_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"text":"この段落をより自然な学術的な表現に書き換えてください。","mode":"academic"}'

Response

response

200 OK

{
  "output": "The humanized version of your text...",
  "words_used": 8,
  "words_remaining": 249992
}

Failed transform requests return structured JSON errors. If a production worker fails after reserving words, the API path is designed to leave room for refund logic and usage reconciliation.

Beyond the first call

Workflow examples

Most integrations combine more than one TurnitPass surface. Use detector calls before or after rewriting, then use citation and bibliography endpoints when the app needs structured source output.

Detector request

POST /api/v1/detect

curl -X POST https://turnitpass.com/api/v1/detect \
  -H "Authorization: Bearer tp_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Paste at least 50 words of writing to scan.",
    "language": "en",
    "source_kind": "paste"
  }'

Citation request

POST /api/v1/citation

curl -X POST https://turnitpass.com/api/v1/citation \
  -H "Authorization: Bearer tp_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "https://example.com/research-article",
    "style": "apa"
  }'

Citation and bibliography responses include formatted text plus export formats such as BibTeX and RIS where available.

Next steps

APIキーによる認証

開発者向けリクエストには、TurnitPassのワークスペースで生成されたAPIキーを使用します。

TurnitPass REST API

認証が必要な文章調整、言い換え、AIチェック、引用、参考文献、APIキー状態確認のリファレンス。

認証方法

API key security, storage, and error handling.

APIリファレンス

Parameters, rate limits, and endpoint examples.

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 the AI-assisted draft you want to revise", "language": "en", "mode": "reduce-aigc" }'

Setup

Create an account

Choose a plan or word budget

Stripe checkout and the customer portal are wired. Live product keys and prices are intentionally left for final configuration.

Create an API key

Generate a key from the workspace, copy it immediately, and send it with your API key.

Make your first request

Use the examples below to call the humanizer endpoint and inspect the response shape.

Your first API call

Replace tp_live_your_api_key with a key generated from the workspace. Requests should be sent from server-side code, not the browser.

Humanize request

curl

curl -X POST https://turnitpass.com/api/v1/humanize \
  -H "Authorization: Bearer tp_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"text":"調整したいAI補助の下書きを貼り付けます","language":"en","mode":"reduce-aigc","personal_terms":["固有名詞"]}'

Paraphrase request

curl

curl -X POST https://turnitpass.com/api/v1/paraphrase \
  -H "Authorization: Bearer tp_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"text":"この段落をより自然な学術的な表現に書き換えてください。","mode":"academic"}'

Response

response

200 OK

{
  "output": "The humanized version of your text...",
  "words_used": 8,
  "words_remaining": 249992
}

Failed transform requests return structured JSON errors. If a production worker fails after reserving words, the API path is designed to leave room for refund logic and usage reconciliation.

Workflow examples

Most integrations combine more than one TurnitPass surface. Use detector calls before or after rewriting, then use citation and bibliography endpoints when the app needs structured source output.

Detector request

POST /api/v1/detect

curl -X POST https://turnitpass.com/api/v1/detect \
  -H "Authorization: Bearer tp_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Paste at least 50 words of writing to scan.",
    "language": "en",
    "source_kind": "paste"
  }'

Citation request

POST /api/v1/citation

curl -X POST https://turnitpass.com/api/v1/citation \
  -H "Authorization: Bearer tp_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "https://example.com/research-article",
    "style": "apa"
  }'

Citation and bibliography responses include formatted text plus export formats such as BibTeX and RIS where available.

Next steps

APIキーによる認証

開発者向けリクエストには、TurnitPassのワークスペースで生成されたAPIキーを使用します。

TurnitPass REST API

認証が必要な文章調整、言い換え、AIチェック、引用、参考文献、APIキー状態確認のリファレンス。

認証方法

API key security, storage, and error handling.

APIリファレンス

Parameters, rate limits, and endpoint examples.