Docs menuReferência de API

API ReferenceTyped request and response

Referência de API

API REST do TurnitPass

Referência para endpoints autenticados de humanização, paráfrase, detecção, citação, bibliografia e status de chaves de 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

Deixa o texto enviado mais natural e reduz sinais de escrita por IA. Modos: reduce-aigc, reduce-both, paraphrase, academic-polish.

POST/api/v1/paraphrase

Reescreve e refina o texto com os modos padrão, fluência, formal, acadêmico, simples, criativo, expandir ou encurtar.

POST/api/v1/rewrite

Endpoint de polimento acadêmico para uma estrutura, tom e fluxo de frases mais limpos.

POST/api/v1/detect

Retorna pontuação estimada, nível de risco, metadados e sinais de escrita para textos colados ou documentos extraídos.

POST/api/v1/citation

Formata um DOI, URL ou citação manual em APA, MLA, Chicago, IEEE, Harvard, Nature, Vancouver, ACS, AMA, GB/T, OSCOLA ou Bluebook. As respostas incluem HTML, texto, BibTeX e RIS.

POST/api/v1/bibliography

Ordena e formata uma lista de citações no estilo solicitado, com saída HTML/texto e exportações em BibTeX e RIS.

GET/api/v1/status

Verifica o nome da chave, saldo de palavras restante, limites de solicitação e último uso.

Parameters and options

Autenticação

Authorization: Bearer tp_your_api_key

Termos protegidos

O campo opcional personal_terms preserva nomes próprios, termos técnicos e marcas durante a revisão.

Limits

Os endpoints de transformação aceitam até 1.000 palavras de entrada. A detecção aceita até 5.000 palavras. Os endpoints de citação possuem limite de taxa, mas não consomem créditos de palavras.

Errors

As respostas JSON incluem os campos error, code e 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": "Cole aqui o rascunho que deseja revisar",
  "language": "en",
  "mode": "reduce-aigc",
  "personal_terms": ["TurnitPass"]
}

200 OK
{
  "output": "O texto humanizado...",
  "words_used": 142,
  "words_remaining": 2858
}

Multi-endpoint example

JSON

POST /api/v1/paraphrase
{
  "text": "Cole o rascunho que deseja reescrever",
  "mode": "academic",
  "synonyms_level": 60
}

POST /api/v1/detect
{
  "text": "Cole o texto que deseja verificar",
  "language": "en",
  "source_kind": "paste"
}

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

200 OK
{
  "text": "Citação formatada...",
  "bibtex": "@article{...}",
  "ris": "TY  - JOUR..."
}

Next steps

Início rápido

Set up the first request.

Autenticação

Review API key handling.

Histórico

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

Autenticação

Authorization: Bearer tp_your_api_key

Termos protegidos

O campo opcional personal_terms preserva nomes próprios, termos técnicos e marcas durante a revisão.

Limits

Errors

As respostas JSON incluem os campos error, code e 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": "Cole aqui o rascunho que deseja revisar",
  "language": "en",
  "mode": "reduce-aigc",
  "personal_terms": ["TurnitPass"]
}

200 OK
{
  "output": "O texto humanizado...",
  "words_used": 142,
  "words_remaining": 2858
}

Multi-endpoint example

JSON

POST /api/v1/paraphrase
{
  "text": "Cole o rascunho que deseja reescrever",
  "mode": "academic",
  "synonyms_level": 60
}

POST /api/v1/detect
{
  "text": "Cole o texto que deseja verificar",
  "language": "en",
  "source_kind": "paste"
}

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

200 OK
{
  "text": "Citação formatada...",
  "bibtex": "@article{...}",
  "ris": "TY  - JOUR..."
}