Scan Overview

Copyleaks’ Gen AI automatically reviews and summarizes each scan. It highlights the main data points, identifies key insights, and uses the author’s past work (if available) to add helpful context. This makes it easy to understand the writing quality, AI involvement, and any signs of plagiarism, all in one clear and simple overview.

Properties Fields

Property	Type	Default	Description
`enable`	`boolean`	`false`	Enable Gen-AI Overview feature to extract key insights from the scan data.
`ignoreAIDetection`	`boolean`	`false`	Ignore AI detection when generating the scan’s overview. Only applicable if AI detection was enabled.
`ignorePlagiarismDetection`	`boolean`	`false`	Ignore plagiarism detection when generating the scan’s overview. Only applicable if plagiarism detection was enabled.
`ignoreWritingFeedback`	`boolean`	`false`	Ignore Grammar Checker when generating the scan’s overview. Only applicable if the Grammar Checker was enabled.
`ignoreAuthorData`	`boolean`	`false`	Ignore the author’s historical data when generating the scan’s overview. Only applicable if author ID was added to the request.

Examples

Request - Submit Endpoint Example

{
    "base64": "...",
    "filename": "file.txt",
    "properties": {
        "action": 0,
        "overview": {
            "enable": true
        }
    }
}

Export Endpoint Example

This is the same description as other types of export, just the key is overview.

{
  "overview": {
    "verb": "POST",
    "headers": [
      [
        "header-key",
        "header-value"
      ]
    ],
    "endpoint": "https://yoursite.com/export/overview"
  },
  "completionWebhook": "https://yoursite.com/export/completed",
  "maxRetries": 3
}

Response

Example

{
    "overview": "### Historical Author Data:\n- Four scans analyzed with an average plagiarism similarity of 13.18%\n- 4 instances of AI-generated content detected\n\n### Current Plagiarism Detection:\n- 0% overall plagiarism\n- Main sources: \n  - yard.com (3.0%, 74 words)\n  - brainly.com (3.2%, 45 words)\n  - llcattorney.com (1.3%, 29 words)\n  - montrosedemocrats.org (3.0%, 12 words)\n\n### AI Content Detection:\n- 100% AI-written content detected\n\n### Grammar Checker:\n- 100% writing quality with no errors in grammar, sentence structure, word choice, and mechanics.",
    "modelVersion": "v1"
}

Response Fields

Field	Type	Description
`overview`	string	A markdown-formatted string containing the Gen-AI overview of the scan.
`modelVersion`	string	The version of the AI model used to generate the overview.

Next Steps

Check for Plagiarism

Detect plagiarism in text documents using the Copyleaks API. Search billions of sources to find unoriginal content.

Detect AI-Generated Content

Detect AI-generated text via sync or async API calls. This guide covers sync detection, see the Authenticity API Guide for async.

Assess Grammar and Writing Quality

Get writing and grammar suggestions via API. Authenticate, submit text, and access full details in the docs.

Moderate Text

Scan and moderate text content for unsafe or policy-relevant material across 10+ categories.

Get started

Guides

Using the APIs

Concepts

Resources

Properties Fields

Examples

Request - Submit Endpoint Example

Export Endpoint Example

Response

Example

Response Fields

Next Steps

Check for Plagiarism

Detect AI-Generated Content

Assess Grammar and Writing Quality

Moderate Text

​Properties Fields

​Examples

​Request - Submit Endpoint Example

​Export Endpoint Example

​Response

​Example

​Response Fields

​Next Steps

Check for Plagiarism

Detect AI-Generated Content

Assess Grammar and Writing Quality

Moderate Text

Properties Fields

Examples

Request - Submit Endpoint Example

Export Endpoint Example

Response

Example

Response Fields

Next Steps