Docs menuمرجع API

API ReferenceTyped request and response

مرجع API

TurnitPass REST API

مرجع نقاط النهاية المصادق عليها للأنسنة، وإعادة الصياغة، والكشف، والاستشهاد، والمراجع، وحالة مفاتيح 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/rewrite

POST/api/v1/detect

POST/api/v1/citation

AuthBearer API key

TransformPOST /humanize

ReviewPOST /detect

StatusGET /status

POST/api/v1/humanize

تحسين النص المرسل وتقليل الإشارات الشبيهة بكتابة الذكاء الاصطناعي. الأوضاع المتاحة: reduce-aigc، reduce-both، paraphrase، academic-polish.

POST/api/v1/paraphrase

إعادة كتابة النص وتحسينه باستخدام الأوضاع: القياسي، والطلاقة، والرسمي، والأكاديمي، والمبسط، والإبداعي، والتوسيع، أو الاختصار.

POST/api/v1/rewrite

مخصص للتحرير الأكاديمي لإنتاج هيكلية أوضح، وتناغم صوتي، وانسيابية سلسة للجمل.

POST/api/v1/detect

إرجاع تقديرات إشارات الكتابة الشبيهة بالذكاء الاصطناعي والبيانات الوصفية وملاحظات المراجعة للنص الملصق أو المستندات المستخرجة.

POST/api/v1/citation

تنسيق DOI أو URL أو الاستشهاد اليدوي بأنماط: APA أو MLA أو Chicago أو IEEE أو Harvard أو Nature أو Vancouver أو ACS أو AMA أو GB/T أو OSCOLA أو Bluebook. تحتوي الاستجابات على HTML ونص عادي وBibTeX وRIS.

POST/api/v1/bibliography

ترتيب وتنسيق قائمة المراجع بالنمط المطلوب، مع مخرجات بصيغ HTML/Text وتصدير بصيغ BibTeX وRIS.

GET/api/v1/status

التحقق من تسمية المفتاح ورصيد الكلمات المتبقي وحدود الطلبات.

Parameters and options

المصادقة

Authorization: Bearer tp_your_api_key

حفظ المصطلحات

تتيح مصفوفة personal_terms الاختيارية الاحتفاظ بالأسماء والمصطلحات الفنية وأسماء العلامات التجارية أثناء معالجة النص الإنجليزي.

الحدود

تقبل نهايات التحويل ما يصل إلى 1000 كلمة كحد أقصى. يقبل الكاشف ما يصل إلى 5000 كلمة. استدعاءات الاستشهاد والاستعلام محدودة المعدل ولكنها لا تستهلك رصيد الكلمات الخاص بك.

الأخطاء

تحتوي استجابات JSON على حقول الخطأ (error) والكود (code) والرسالة (message).

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": "الصق المسودة المدعومة بالذكاء الاصطناعي التي تريد تحسينها",
  "language": "en",
  "mode": "reduce-aigc",
  "personal_terms": ["اسم خاص"]
}

200 OK
{
  "output": "النص البشري المعدل...",
  "words_used": 142,
  "words_remaining": 2858
}

Multi-endpoint example

JSON

POST /api/v1/paraphrase
{
  "text": "الصق المسودة التي تريد إعادة صياغتها",
  "mode": "academic",
  "synonyms_level": 60
}

POST /api/v1/detect
{
  "text": "الصق المسودة التي تريد فحصها",
  "language": "en",
  "source_kind": "paste"
}

POST /api/v1/citation
{
  "input": "https://example.com/article",
  "style": "apa"
}

200 OK
{
  "text": "الاستشهاد المنسق...",
  "bibtex": "@article{...}",
  "ris": "TY  - JOUR..."
}

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' }) })

Parameters and options

المصادقة

Authorization: Bearer tp_your_api_key

حفظ المصطلحات

الحدود

الأخطاء

تحتوي استجابات JSON على حقول الخطأ (error) والكود (code) والرسالة (message).

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": "الصق المسودة المدعومة بالذكاء الاصطناعي التي تريد تحسينها",
  "language": "en",
  "mode": "reduce-aigc",
  "personal_terms": ["اسم خاص"]
}

200 OK
{
  "output": "النص البشري المعدل...",
  "words_used": 142,
  "words_remaining": 2858
}

Multi-endpoint example

JSON

POST /api/v1/paraphrase
{
  "text": "الصق المسودة التي تريد إعادة صياغتها",
  "mode": "academic",
  "synonyms_level": 60
}

POST /api/v1/detect
{
  "text": "الصق المسودة التي تريد فحصها",
  "language": "en",
  "source_kind": "paste"
}

POST /api/v1/citation
{
  "input": "https://example.com/article",
  "style": "apa"
}

200 OK
{
  "text": "الاستشهاد المنسق...",
  "bibtex": "@article{...}",
  "ris": "TY  - JOUR..."
}