Usage | TurnitPass Developers

開発者向けプラットフォーム

概要

利用状況を開く

ワークスペースの動きを確認

最近のリクエスト、語数、サブスク状態、キー利用を見ます。

API リファレンス

応答フィールドに合わせて設計

画面から残高を推測せず、文書化された利用フィールドを使います。

ワークスペース

POST/api/v1/humanize

アカウント単位

利用量を踏まえた呼び出し

POST /api/v1/humanize

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

説明

01

計量単位

変換リクエストは成功応答のあと語数を引きます。

02

ステータス経路

クライアントは送信前に残残高と上限を確認できます。

03

ワークスペース

ワークスペースはエンドポイント、サブスク、キー利用をまとめます。

計量の流れ

リクエストが利用量になるまで

1

入力を検証

本文欠落、非対応ペイロード、語数上限、無効キーは早期に失敗します。

2

ワークフローを実行

Humanizer、paraphrase、rewrite、detector、citation、bibliography は構造化 JSON を返します。

3

アクティビティを記録

成功した認証済み呼び出しはエンドポイント、語数、状態、アカウント所有者に紐づけられます。

4

残残高を返す

クライアントはリクエスト後の状態を出すか、次バッチの前に /api/v1/status を問い合わせます。

利用モデル

クライアントが設計すべき上限

変換入力

1,000 語/リクエストHumanize、paraphrase、rewrite がこの上限を共有します。

検出入力

5,000 語/リクエスト検出はより長い本文や文書抜粋を確認できます。

引用ルート

レート制限ありCitation と bibliography はエクスポートを返し、語数は使いません。

レート制限

キー単位既定上限はキー単位なので、本番とステージングを分けられます。

実装上の注意。 アカウント利用量の正はワークスペースです。API クライアントは残高確認にステータス応答を使ってください。

次のステップ