v1

latestOpenAPI 3.0.0Apache 2.02026-08-0610023171.4 KB
Individuals

List text checks

Return a paginated list of text checks owned by the authenticated user. Use page, size, and search to browse larger histories.

get/api/v1/texts/

Query parameters

searchstring

Optional text search filter. Matching fields depend on the endpoint, for example filename, member name, email, or transaction text.

pageinteger

Page number for paginated endpoints. Defaults to 1 when omitted.

sizeinteger

Number of records per page. Defaults to 30 when omitted.

Response

The request succeeded and returned a paginated list of text checks.

Example response

{
  "data": {
    "texts": [
      {
        "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
            }
          ]
        }
      }
    ]
  },
  "pagination": {
    "last": 3,
    "current": 1,
    "num_items_per_page": 30,
    "first": 1,
    "page_count": 3,
    "total_count": 67,
    "page_range": 3,
    "start_page": 1,
    "end_page": 3,
    "first_page_in_range": 1,
    "lastPage_in_range": 3,
    "current_item_count": 30,
    "first_item_number": 1,
    "last_item_number": 30
  }
}