本文へ移動
TurnitPass
開発者API v1API キーを発行
ドキュメントを見る

開発者開発者向けドキュメント

TurnitPass APIドキュメント

APIキーの作成方法から始め、文章調整、言い換え、AIチェック、引用、参考文献機能を呼び出し、自社の執筆システムにTurnitPassを組み込みます。

REST API v1

One request

Quick example

Bearer API キーで改稿エンドポイントにテキストを送ります。応答には改稿結果、使用語数、キー所有者の残語数が含まれます。

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
}
同じ API キーの流れで paraphrase、rewrite、detector、citation、bibliography、status も利用できます。

Route map

Explore the docs

01

クイックスタート

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

02

認証方法

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

03

APIリファレンス

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

04

更新履歴

文章調整、AIチェック、執筆ツール、請求、APIにおける最近の変更点。

次のステップ

Request lifecycle

TurnitPass の API 呼び出しは同じ経路です。キー認証、ペイロード検証、執筆または引用ワークフローの実行、使用量の計量、保存可能な応答の返却。

1

API キーを認証する

ワークスペースで発行したキーを送ります。失効、不正、欠落したキーは本文処理の前に失敗します。

2

テキスト、言語、上限を検証する

改稿は語数範囲、検出はより長い上限、引用はスタイルと出典を検証します。

3

ワークフローを実行する

humanize、paraphrase、rewrite、detect、citation、bibliography は公開ツールと同じサーバー処理を使います。

4

使用量を記録して結果を返す

成功時は結果に加え、使用語数、残量、状態、または整形済み引用エクスポートを返します。

API一覧

主要機能

文章調整

POST/api/v1/humanize

原文のニュアンスを維持しながら、AIらしい表現を見直しやすくします。

言い換え

POST/api/v1/paraphrase

複数のモードで、文章の言い換えや推敲を行います。

AIチェック

POST/api/v1/detect

AI生成の可能性の目安と見直しポイントを返します。

引用

POST/api/v1/citation

DOI、URL、または手動入力された情報源を引用形式に整えます。

Production checklist

サーバー側呼び出し
クライアントバンドルにキーを出さないバックエンド、worker、キュー、保護されたサーバーアクションから呼び出します。
再試行
ネットワーク障害のみ再試行4xx は入力の問題として扱い、一時的な 5xx とネットワークエラーだけ再試行します。
語数予算
大量処理の前に残量を表示status で、キュー投入、アップグレード案内、文書分割を判断します。
請求設定
Stripe シークレットは最終設定checkout、portal、webhook は接続済みです。本番キーと price ID はデプロイ時に入れます。
環境ごとにキーを分けます。本番、ステージング、ローカルは独立して失効できるようにします。
次に、ワークフローへ接続します。続きを読む