PLplagiarismcheck
Individuals

Validate text before checking

Changed on

Validate plain text or an uploaded file before creating a plagiarism check. The endpoint uses the same authentication and validation rules as text creation but does not create a final check.

post/api/v1/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

Text content to check.

languagestring
validation_hashstring
callbackstring uri
filenamestring
excludestring

JSON array of text IDs to exclude.

exclude_groupsstring

JSON array of group IDs to exclude.

group_idinteger

Optional group ID to charge and associate with the check. The authenticated user must belong to the group.

custom_authorstring

Custom author display name. Required for group teachers and owners when the group has custom-author enforcement enabled.

skip_english_words_validationboolean

Skip English-word validation. Groups with language validation disabled can force this behavior.

skip_percentage_words_validationboolean

Skip letter-percentage validation. Groups with language validation disabled can force this behavior.

integration_coursestring
integration_course_workstring
integration_submissionstring
integration_attachmentstring
course_namestring

Optional name of the course the check belongs to. Stored with the check and shown in group reports. On a Moodle submission (lms=moodle) it names the Moodle course; on an LMS submission sent with integration_course_work it names that coursework's course, saving the server a lookup it would otherwise make against the LMS; otherwise it names the course as your own system knows it. Blank values are treated as absent, names are deduplicated server-side, and names longer than 255 characters are truncated.

assignment_namestring

Optional name of the assignment the check belongs to. Stored with the check and shown in group reports. On a Moodle submission (lms=moodle) it names the Moodle assignment, alongside assignment_id; on an LMS submission sent with integration_course_work it names that coursework, saving the server a lookup it would otherwise make against the LMS. Blank values are treated as absent, names are deduplicated server-side, and names longer than 255 characters are truncated.

Example request

{
  "language": "en",
  "exclude": "[1,2]",
  "exclude_groups": "[3,4]",
  "course_name": "Introduction to Biology",
  "assignment_name": "Term paper"
}

Response

The request succeeded and returned endpoint-specific data.

successboolean
messagestring nullable

Optional informational message returned by some endpoints.

Example response

{
  "success": true
}

Changes

  • 9e9734ffd918Revision changes
    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)