Zum Inhalt springen
TurnitPass
EntwicklerAPI v1
API-Schlüssel erstellen
Dokumentation durchsuchen

EntwicklerAPI-Referenz

TurnitPass REST API

Referenz für authentifizierte Endpunkte zum Überarbeiten, Paraphrasieren, Prüfen, Zitieren, Erstellen von Bibliografien und für den API-Schlüsselstatus.

REST API v1

Referenzkonsole

Mit Route, Payload und Antwortform beginnen.

Die vollständige Referenz deckt alle Endpunkte unten ab. Die Konsole zeigt den Vertrag zuerst: Bearer-Auth, JSON-Eingabe, gemessene Ausgabe, Statusprüfung.

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"
}
gemessenprotokolliertJSON
POST/api/v1/humanize
POST/api/v1/paraphrase
POST/api/v1/rewrite
POST/api/v1/detect
POST/api/v1/citation
AuthBearer-API-Schlüssel
TransformPOST /humanize
PrüfungPOST /detect
StatusGET /status
POST/api/v1/humanize
v1

Überarbeitet übermittelten Text und reduziert KI-Schreibsignale. Modi: reduce-aigc, reduce-both, paraphrase, academic-polish.

POST/api/v1/paraphrase
v1

Umschreiben und Verfeinern von Texten mit Modi wie Standard, Fluency, Formal, Academic, Simple, Creative, Expand oder Shorten.

POST/api/v1/rewrite
v1

Akademischer Polishing-Endpunkt für sauberere Struktur, Tonalität und Satzfluss.

POST/api/v1/detect
v1

Gibt Score, Risikostufe, Metadaten und Schreibsignale für kopierten Text oder extrahierte Dokumente zurück.

POST/api/v1/citation
v1

Formatiert DOI, URL oder manuelle Zitate in APA, MLA, Chicago, IEEE, Harvard, Nature, Vancouver, ACS, AMA, GB/T, OSCOLA oder Bluebook. Antworten enthalten HTML, Text, BibTeX und RIS.

POST/api/v1/bibliography
v1

Sortiert und formatiert eine Liste von Zitaten im gewünschten Stil mit HTML/Text-Ausgabe sowie BibTeX- und RIS-Exporten.

GET/api/v1/status
v1

Prüft Schlüsselname, verbleibendes Wortguthaben und Anfrage-Limits.

Parameter und Optionen

Authentifizierung
Authorization: Bearer tp_your_api_key
Geschützte Begriffe
Das optionale Feld personal_terms bewahrt Eigennamen, Fachbegriffe und Markenschreibweisen.
Limits
Überarbeitungs-Endpunkte akzeptieren bis zu 1.000 Wörter, die Erkennung bis zu 5.000 Wörter. Zitat-Endpunkte sind ratenbegrenzt, verbrauchen aber kein Wortguthaben.
Fehler
JSON-Antworten enthalten error, code und message.

Raten- und Anfragelimits

Transform-Eingabe
Bis 1.000 WörterGilt für Humanize, Paraphrase und Rewrite.
Detektor-Eingabe
Bis 5.000 WörterLängere Scans vor dem Senden aufteilen.
API-Schlüssel
Bis 5 aktive SchlüsselSchlüssel lassen sich unabhängig im Arbeitsbereich widerrufen.
Zitationstools
Separat ratenbegrenztCitation und Bibliography verbrauchen keine Wörter.

Fehlerbehandlung

Fehlerantworten nutzen JSON mit error, code und einer lesbaren message, soweit möglich.

error response
JSON
{
  "error": "Text exceeds word limit. Maximum 1,000 words allowed.",
  "code": "word_limit_exceeded",
  "max_words": 1000,
  "current_words": 1234
}
Stripe- und Google-Zugangsdaten bleiben Konfiguration. API, Auth und Persistenz sind so gebaut, dass Live-Zugangsdaten ohne Redesign ergänzt werden können.

Beispiele

Humanize-Beispiel
JSON
POST /api/v1/humanize
{
  "text": "Fügen Sie den Text ein, den Sie überarbeiten möchten",
  "language": "en",
  "mode": "reduce-aigc",
  "personal_terms": ["TurnitPass"]
}

200 OK
{
  "output": "Der humanisierte Text...",
  "words_used": 142,
  "words_remaining": 2858
}
Beispiel mit mehreren Endpunkten
JSON
POST /api/v1/paraphrase
{
  "text": "Fügen Sie den Entwurf ein, den Sie umschreiben möchten",
  "mode": "academic",
  "synonyms_level": 60
}

POST /api/v1/detect
{
  "text": "Fügen Sie den Text ein, den Sie prüfen möchten",
  "language": "en",
  "source_kind": "paste"
}

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

200 OK
{
  "text": "Formatierte Zitation...",
  "bibtex": "@article{...}",
  "ris": "TY  - JOUR..."
}

Nächste Schritte

Schnellstart

Die erste Anfrage einrichten.

Authentifizierung

Den Umgang mit API-Schlüsseln prüfen.

Changelog

Aktuelle Plattformänderungen ansehen.

Als Nächstes in Ihren Workflow einbinden.Weiterlesen