Formatted Documents

Validate formatted text

Validate plain text or an uploaded file before submitting it for a formatted text check. The endpoint parses the content, counts words and pages, checks UTF-8 and text length constraints, and applies language/letter-percentage validation.

A text over the maximum length (1048576 symbols) is a blocking failure returned with code: 5, words and pages. It is not affected by skip_english_words_validation or skip_percentage_words_validation, which waive the language and letter-percentage rules only.

This endpoint does not charge the account or create a text check. If group_id is supplied and the group disables language validation, the language and letter-percentage validations are skipped.

post/api/v2/text/validate/

Request

  • Base URL
    https://plagiarismcheck.org
  • Auth
    API key in header X-API-TOKEN

Request body application/x-www-form-urlencoded

textstring required

Plain text content to parse and validate.

filenamestring

Optional filename to use while processing the submitted text.

group_idinteger

Optional group ID. If the group disables language validation, related validation checks are skipped.

custom_authorstring

Optional custom author display name used during validation.

skip_english_words_validationboolean

Skip the English-word percentage validation when allowed by the validation service.

skip_percentage_words_validationboolean

Skip the letter-percentage validation when allowed by the validation service.

Example request

{
  "text": "Some valid text with enough words and characters to pass the formatted text validation step before a user submits the final plagiarism check.\n",
  "filename": "draft.txt",
  "group_id": 100,
  "custom_author": "Student Name"
}

Response

The formatted text is valid enough to submit for checking.

successboolean required
warningstring nullable required

Optional validation warning. An empty string means no warning was produced.

wordsinteger required

Number of words parsed from the submitted text or file.

pagesinteger required

Estimated page count calculated from the parsed word count.

Example response

{
  "success": true,
  "words": 18,
  "pages": 1
}

Changes

No recorded changes to this operation across all 12 revisions of this API.