v1

latestOpenAPI 3.0.0Apache 2.02026-08-0610023171.4 KB
Individuals

Submit text for plagiarism checking

Submit plain text or a supported file for plagiarism checking. The authenticated user is charged against either their own balance or the selected group balance.

The text must pass content and language validation, and duplicate submissions within a short interval are rejected. When the external checking queue cannot accept the text immediately, the check may be stored and submitted by background processing.

post/api/v1/text

Response

The plagiarism check was created successfully and billing information was returned.

successboolean

Example response

{
  "success": true,
  "data": {
    "text": {
      "id": 15,
      "user_id": 24,
      "filename": "example.pdf",
      "created_at": 1516279363000,
      "updated_at": 1516279364000,
      "submitted_at": 1516279364000,
      "state": 3,
      "language": "en",
      "pages": 30,
      "words": 127,
      "group_id": 100,
      "custom_author": "Student Name",
      "report_id": 13,
      "ai_report_id": 15,
      "creator": {
        "id": 3132945,
        "name": "John Doe",
        "email": "student@example.com",
        "created_at": 1512638171000,
        "updated_at": 1512638171000,
        "allowed_languages": [
          "en"
        ],
        "balance_type": 1,
        "avatar": "https://randomuser.me/api/portraits/lego/1.jpg",
        "is_email_verification_needed": true
      },
      "report": {
        "id": 13,
        "created_at": "1643727471000",
        "source_count": 5,
        "percent": "28.57"
      },
      "ai_report": {
        "enabled": true,
        "id": 15,
        "status": 3,
        "percent": 50.5,
        "processed_percent": 70.25,
        "strong_percent": 40.25,
        "likely_percent": 30,
        "mark": 1,
        "comment": "Lorem ipsum dolor",
        "comment_author": {
          "id": 24,
          "name": "John Doe"
        },
        "type": 3,
        "words": 550,
        "pages": 2,
        "group_id": 100,
        "creator": {
          "id": 3132945,
          "name": "John Doe",
          "email": "student@example.com",
          "created_at": 1512638171000,
          "updated_at": 1512638171000,
          "allowed_languages": [
            "en"
          ],
          "balance_type": 1,
          "avatar": "https://randomuser.me/api/portraits/lego/1.jpg",
          "is_email_verification_needed": true
        },
        "content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus molestie diam id lacus maximus, ac scelerisque neque suscipit. Pellentesque luctus elit cursus varius aliquam. Nam neque leo, cursus sit amet quam a, dignissim malesuada est. Sed efficitur finibus felis euismod mattis. Donec egestas nunc odio, vitae lacinia nunc pellentesque id. Etiam ornare nunc vel accumsan ullamcorper. Donec sed lacinia orci.\n",
        "chunks": [
          {
            "reliability": 1,
            "position": [
              100,
              200
            ]
          }
        ],
        "ignored_ranges": [
          {
            "id": 123,
            "start": 42,
            "end": 87,
            "filename": "assignment-template.docx",
            "ignore_assignment_template_id": 55
          }
        ]
      }
    },
    "charged": 1
  }
}