PUT https://api.copyleaks.com/v3/scans/submit/ocr/{scanId}

Scan images with textual content to find where the content has been used before and check its originality. Using submit-ocr you can scan various image file types for plagiarism and identify infringed content. Only the textual content in the picture will be scanned and not the graphics. See supported formats.

Authentication Required

You need to login with a user and api key in order to access this method. Add this HTTP header to your request:

Authorization: Bearer < Your-Login-Token >

Request

Path Parameters

scanId string Required

A unique scan id provided by you. We recommend you use the same id in your database to represent the scan in the Copyleaks database. This will help you to debug incidents. Using the same ID for the same file will help you to avoid network problems that may lead to multiple scans for the same file. learn more about the criteria for creating a Scan ID.

>= 3 characters <= 36 characters

Match pattern: [a-z0-9] !@$^&-+%=_(){}<>';:/.",~|

Headers

Content-Type: application/json
Authorization: Bearer YOUR_LOGIN_TOKEN

Request Body

The request body is a JSON object containing the image file to scan and a properties object to configure the scan.

base64 string Required

A base64 data string of a file. If you would like to scan plain text, encode it as base64 and submit it.

Example: aGVsbG8gd29ybGQ=

filename string Required

The name of the file as it will appear in the Copyleaks scan report. Make sure to include the right extension for your filetype.

<= 255 characters

Example: image.jpg

langCode string Required

The language of the text in the image. See supported languages.

Example: en

properties object Required

Configuration options for the scan.

action integer default: "0"

The type of submission action.

0: Scan

Start scan immediately.

1: Check-Credits

Check how many credits will be used for this scan.

2: Index Only

Only index the file in the Copyleaks internal database or Copyleaks Repository (depends on your submit request). No credits will be used.

includeHtml boolean

By default, Copyleaks will present the report in text format. If set to true, Copyleaks will also include html format.

• True : results will be generated as HTML format, if possible. Otherwise, it will be generated as text format.
• False : results will be generated as text format.

developerPayload string default: "null"

Add custom developer payload that will then be provided on the webhooks.

<= 512 characters

sandbox boolean default: "false"

You can test the integration with the Copyleaks API for free using the sandbox mode.

You will be able to submit content for a scan and get back mock results, simulating the way Copyleaks will work to make sure that you successfully integrated with the API.

Turn off this feature on production environment.

Rate Limiting: This method has a maximum call rate limit of 100 sandbox scans within 1 hour. See the 429 Response code section at the bottom of this page.

expiration integer default: "2880"

Specify the maximum life span of a scan in hours on the Copyleaks servers. When expired, the scan will be deleted and will no longer be accessible.

>= 1 <= 2880

scanMethodAlgorithm integer default: "0"

Choose the algorithm goal. You can set this value depending on your use-case.

Available Options:

• 0 - MaximumCoverage: prioritize higher similarity score.
• 1 - MaximumResults: prioritize finding more sources.

customMetadata array default: "[]"

Add custom properties that will be attached to your document in a Copyleaks repository.

If this document is found as a repository result, your custom properties will be added to the result.

Example:

[
  {
    "key":"Test1",
    "value":"Test1"
  },
  ...
]

displayLanguage string default: "en"

When specified, the PDF report will be generated in the selected language. Future updates may also apply this setting to the overview and other components.

Currently supported languages:

Code	Language
en	English
es	Spanish
de	German
fr	French
it	Italian
pt	Portuguese

scanTimeZone string default: "User's country timezone"

Specify the timezone for the scan time displayed on the final PDF report. The value must be a valid, case-sensitive IANA Time Zone name (e.g., America/New_York). If unspecified, the timezone defaults to the user’s country, or UTC if their country is unknown.

Available Options: See the full List of IANA Time Zones.

sensitivityLevel integer default: "3"

You can control the level of plagiarism sensitivity that will be identified according to the speed of the scan. If you prefer a faster scan with the results that contains the highest amount of plagiarism choose 1, and if a slower, more comprehensive scan, that will also detect the smallest instances choose 5.

Optional Values:

Range between 1 (faster) to 5 (slower but more comprehensive)

cheatDetection boolean default: "false"

When set to true the submitted document will be checked for cheating. If a cheating will be detected, a scan alert will be added to the completed webhook.

author object

id string

A unique identifier for the author of the content.

course object

id string

A unique course identifier for tracking analytics.

assignment object

id string

A unique assignment identifier for tracking analytics.

institution object

id string

A unique institution identifier for tracking analytics.

webhooks object

The webhooks object is where you define the callback URLs for Copyleaks to send notifications to. This object is required.

status string Required

A URL that will be called when the scan status changes. Use the {STATUS} placeholder, which will be replaced with completed, error, creditsChecked, or indexed. Example: https://yoursite.com/webhook/{STATUS}

newResult string

A URL that will be called when a new result is found during the scan.

newResultHeaders array

Custom headers to add to the newResult webhook. Example: [["key", "value"]]

statusHeaders array

Custom headers to add to the status webhook. Example: [["key", "value"]]

filters object

Fine-tune what kind of results are included in the scan report.

identicalEnabled boolean default: "true"

Enable matching of exact words.

minorChangesEnabled boolean default: "true"

Enable matching of nearly identical words (e.g., slow/slowly).

relatedMeaningEnabled boolean default: "true"

Enable matching of paraphrased content.

minCopiedWords integer

Only show results with at least this many copied words.

safeSearch boolean default: "false"

Block explicit adult content from scan results.

domains array default: "[]"

A list of domains to include or exclude from the scan.

domainsMode integer default: "1"

0 to include domains, 1 to exclude them.

allowSameDomain boolean default: "false"

Allow results from the same domain as the submitted URL.

scanning object

Define the sources to compare your document against.

internet boolean default: "true"

Compare your content with online sources.

exclude object

idPattern string default: "null"

Exclude submissions from results if their ID matches the supplied pattern. Matched submissions will be excluded from both internal database and repository results.

Supported pattern wildcards:

• * — Matches any number of characters (including zero)
• . — Matches exactly one non-whitespace character

Examples:

• abc* — Excludes submissions with IDs starting with “abc”
• ab.. — Excludes submissions with exactly 4-character IDs starting with “ab”
• *test — Excludes submissions with IDs ending with “test”
• user.* — Excludes submissions with IDs starting with “user.” followed by any characters

Tip

Use patterns carefully to avoid excluding legitimate comparisons. Test your patterns with a small dataset first.

include object

idPattern string default: "null"

Includes results only if their scan id matches the supplied pattern. Matched submissions will be the only submissions Included from internal database and repositories results.

Supported pattern wildcards:

• * — Matches any number of characters (including zero)
• . — Matches exactly one non-whitespace character

Examples:

• abc* — Includes submissions with IDs starting with “abc”
• ab.. — Includes submissions with exactly 4-character IDs starting with “ab”
• *test — Includes submissions with IDs ending with “test”
• user.* — Includes submissions with IDs starting with “user.” followed by any characters

Tip

Use patterns carefully to avoid excluding legitimate comparisons. Test your patterns with a small dataset first.

repositories array[object] default: "[]"

Specify which repositories to scan the document against.

id string default: "null"

Id of a repository to scan the submitted document against.

includeMySubmissions boolean default: "false"

Compare the scanned document against MY submissions in the repository.

includeOthersSubmissions boolean default: "false"

Compare the scanned document against OTHER users submissions in the repository.

copyleaksDb object default: "null"

Configure scanning against the Copyleaks Shared Data Hub.

includeMySubmissions boolean default: "true"

When set to true: Copyleaks will also compare against content which was uploaded by YOU to the Copyleaks internal database. If true, it will also index the scan in the Copyleaks internal database.

includeOthersSubmissions boolean default: "true"

When set to true: Copyleaks will also compare against content which was uploaded by OTHERS to the Copyleaks internal database. If true, it will also index the scan in the Copyleaks internal database.

crossLanguages object

Configure cross-language plagiarism detection.

languages array[object] default: "[]"

Cross language plagiarism detection. Choose which languages to scan your content against. For each additional language chosen, your pages will be deducted per page submitted. The language of the original document submitted is always scanned, therefore should not be included in the additional languages chosen. Supported languages list.

code string default: "null"

Language code for cross language plagiarism detection.

indexing object

Configure where to index the submitted content.

repositories array default: "[]"

Specify which repositories to index the scanned document to.

copyleaksDb boolean default: "false"

Add the submitted document to the Copyleaks Shared Data Hub.

exclude object

Configure what content to exclude from the scan.

quotes boolean default: "false"

Exclude quoted text from the scan.

citations boolean default: "false"

Exclude citations from the scan.

references boolean default: "false"

Exclude referenced text from the scan.

tableOfContents boolean default: "false"

Exclude table of contents from the scan.

titles boolean default: "false"

When the scanned document is an HTML document, exclude titles from the scan.

htmlTemplate boolean default: "false"

When the scanned document is an HTML document, exclude irrelevant text that appears across the site like the website footer or header.

documentTemplateIds array default: "[]"

Exclude template text found in other documents. Provide an array of scan IDs (max 3).

pdf object

Configure and request a PDF report of the scan results.

create boolean default: "false"

Set to true to generate a PDF report for this scan.

title string

Customize the title for the PDF report (max 256 chars).

largeLogo string

A base64 encoded PNG image (max 100kb) to use as a logo in the report.

rtl boolean default: "false"

When set to true the text in the report will be aligned from right to left.

version integer default: "1" Deprecated

Use reportVersion. PDF version to generate (1, 2, or 3).

reportVersion string default: "latest"

Specifies which version of the PDF report to generate (v1, v2, v3, latest). Overrides version.

colors object

Customize the highlight colors used in the PDF report.

titles string default: "#040F21"

Change the color of titles in the PDF.

Format: Color in HEX format (#000000-#FFFFFF)

identical string default: "#FE5758"

Change the color of identical match highlights in the PDF.

Format: Color in HEX format (#000000-#FFFFFF)

minorChanges string default: "#FE8888"

Change the color of minor changes highlights in the PDF.

Format: Color in HEX format (#000000-#FFFFFF)

relatedMeaning string default: "#FDD0A3"

Change the color of related meaning (paraphrased) highlights in the PDF.

Format: Color in HEX format (#000000-#FFFFFF)

aiDetection string default: "#FE5758"

Change the color of AI content detection highlights in the PDF.

Format: Color in HEX format (#000000-#FFFFFF)

writingFeedback string default: "#FF9A02"

Change the color of writing feedback highlights in the PDF.

Format: Color in HEX format (#000000-#FFFFFF)

aiGeneratedText object

Configure AI-generated text detection.

detect boolean default: "false"

Detects whether the text was written by an AI.

sensitivity integer default: "2"

Control the behavior of the AI detection (1-3).

explain object

enable boolean default: "false"

Enable AI Logic feature for AI detection.

sensitiveDataProtection object

driversLicense boolean default: "false"

Mask driver’s license numbers from the scanned document with # characters. Available for users on a plan for 2500 pages or more.

Supported Types:

Type
Australia driver’s license number
Canada driver’s license number
United Kingdom driver’s license number
USA drivers license number
Japan driver’s license number
Spain driver’s license number
Germany driver’s license number

credentials boolean default: "false"

Mask credentials from the scanned document with # characters. Available for users on a plan for 2500 pages or more.

Supported Types:

Type
Authentication token
Amazon Web Services credentials
Azure JSON Web Token
HTTP basic authentication header
Google Cloud Platform service account credentials
Google Cloud Platform API key
JSON Web Token
Encryption key
Password

passport boolean default: "false"

Mask passports from the scanned document with # characters. Available for users on a plan for 2500 pages or more.

Supported Types:

Type
Canada passport number
China passport number
France passport number
Germany passport number
Ireland passport number
Japan passport number
Korea passport number
Mexico passport number
Spain passport number
United Kingdom passport number
USA passport number
Netherlands passport number
Poland passport
Sweden passport number
Australia passport number
Singapore passport number
Taiwan passport number

network boolean default: "false"

Mask network identifiers from the scanned document with # characters. Available for users on a plan for 2500 pages or more.

Supported Types:

Type
IP address
Local MAC address
MAC address

url boolean default: "false"

Mask url from the scanned document with # characters. Available for users on a plan for 2500 pages or more.

emailAddress boolean default: "false"

Mask email addresses from the scanned document with # characters. Available for users on a plan for 2500 pages or more.

creditCard boolean default: "false"

Mask credit card numbers and credit card track numbers from the scanned document with # characters. Available for users on a plan for 2500 pages or more.

phoneNumber boolean default: "false"

Mask phone numbers from the scanned document with # characters. Available for users on a plan for 2500 pages or more.

writingFeedback object

Configure the automated Writing Assistant.

enable boolean default: "false"

Enable automated Writing Assistant for grammar, spelling, etc.

score object

Configure the weighting of different categories in the overall writing score.

grammarScoreWeight number default: "1.0"

Grammar correction category weight. Range: 0.0 to 1.0.

mechanicsScoreWeight number default: "1.0"

Mechanics correction category weight. Range: 0.0 to 1.0.

sentenceStructureScoreWeight number default: "1.0"

Sentence structure correction category weight. Range: 0.0 to 1.0.

wordChoiceScoreWeight number default: "1.0"

Word choice correction category weight. Range: 0.0 to 1.0.

overview object

Enable Gen-AI Overview feature to extract key insights from the scan data.

enable boolean default: "false"

Enable Gen-AI Overview feature to extract key insights from the scan data.

ignoreAIDetection boolean default: "false"

Ignore AI detection when generating the scan’s overview. Only applicable if AI detection was enabled.

ignorePlagiarismDetection boolean default: "false"

Ignore plagiarism detection when generating the scan’s overview. Only applicable if plagiarism detection was enabled.

ignoreWritingFeedback boolean default: "false"

Ignore writing assistant when generating the scan’s overview. Only applicable if the writing assistant was enabled.

ignoreAuthorData boolean default: "false"

Ignore the author’s historical data when generating the scan’s overview. Only applicable if author ID added to the request.

aiSourceMatch object

The AI Source Match feature enhances plagiarism detection by identifying online sources that are suspected of containing AI-generated text. This allows you to find instances of potential plagiarism and understand if the matched source content itself might have been created by an AI.

enable boolean default: "false"

Activates or deactivates the AI Source Match functionality.

Note

This feature requires both scanning.internet and aiGenerateText.detect to be enabled.

Integration Testing

For testing purposes, use sandbox mode - it’s free!

Responses

201

201 Created

The scan was successfully created and is now processing.

Response Schema

The response contains the following fields:

scannedDocument object

Metadata about the submitted scan.

scanId string

The unique identifier for this scan.

totalWords integer

Total number of words in the scanned document.

totalExcluded integer

Number of words excluded from the scan.

credits integer

Credits consumed for this scan.

expectedCredits integer

Expected credits to be consumed.

creationTime string

ISO 8601 timestamp when the scan was created.

metadata object

Additional metadata about the document.

enabled object

Features enabled for this scan.

plagiarismDetection boolean

Whether plagiarism detection is enabled.

aiDetection boolean

Whether AI detection is enabled.

explainableAi boolean

Whether explainable AI is enabled.

writingFeedback boolean

Whether writing feedback is enabled.

pdfReport boolean

Whether PDF report generation is enabled.

cheatDetection boolean

Whether cheat detection is enabled.

aiSourceMatch boolean

Whether AI source matching is enabled.

detectedLanguage string

The detected language of the document (ISO 639-1 code).

results object

Plagiarism and AI detection results.

score object

Overall plagiarism score breakdown.

identicalWords integer

Number of identical words found.

minorChangedWords integer

Number of words with minor changes.

relatedMeaningWords integer

Number of words with related meaning.

aggregatedScore number

Overall aggregated plagiarism score.

internet array

Results from internet sources.

database array

Results from internal database.

batch array

Results from batch comparisons.

repositories array

Results from private repositories.

notifications object

Alerts and notifications about the scan.

alerts array

Array of alert objects with details about potential issues.

writingFeedback object

Writing feedback and suggestions.

textStatistics object

Statistical analysis of the text.

sentenceCount integer

Number of sentences in the text.

averageWordLength number

Average length of words in characters.

averageSentenceLength number

Average number of words per sentence.

readingTimeSeconds number

Estimated reading time in seconds.

speakingTimeSeconds number

Estimated speaking time in seconds.

score object

Writing quality scores and corrections.

grammarCorrectionsCount integer

Number of grammar corrections needed.

grammarCorrectionsScore integer

Grammar quality score (0-100).

grammarScoreWeight number

Weight applied to grammar score.

mechanicsCorrectionsCount integer

Number of mechanics corrections needed.

mechanicsCorrectionsScore integer

Mechanics quality score (0-100).

mechanicsScoreWeight number

Weight applied to mechanics score.

sentenceStructureCorrectionsCount integer

Number of sentence structure corrections needed.

sentenceStructureCorrectionsScore integer

Sentence structure quality score (0-100).

sentenceStructureScoreWeight number

Weight applied to sentence structure score.

wordChoiceCorrectionsCount integer

Number of word choice corrections needed.

wordChoiceCorrectionsScore integer

Word choice quality score (0-100).

wordChoiceScoreWeight number

Weight applied to word choice score.

overallScore integer

Overall writing quality score (0-100).

readability object

Readability analysis and metrics.

score integer

Readability score (0-100).

readabilityLevel integer

Reading grade level.

readabilityLevelText string

Human-readable description of reading level.

readabilityLevelDescription string

Detailed description of reading difficulty.

status integer

The status of the scan. A value of `0` indicates the scan is still in progress.

developerPayload string

A developer-provided string that is attached to the scan. This can be used to store your own internal identifiers. `256 characters`

Example Response

A typical response from this endpoint:

Show full example (95 lines)

{
"scannedDocument": {
  "scanId": "scan-id32",
  "totalWords": 2,
  "totalExcluded": 0,
  "credits": 0,
  "expectedCredits": 1,
  "creationTime": "2025-08-05T07:19:08.181236Z",
  "metadata": {
    "filename": "file.jpg"
  },
  "enabled": {
    "plagiarismDetection": true,
    "aiDetection": false,
    "explainableAi": false,
    "writingFeedback": false,
    "pdfReport": true,
    "cheatDetection": false,
    "aiSourceMatch": false
  },
  "detectedLanguage": "en"
},
"results": {
  "score": {
    "identicalWords": 1,
    "minorChangedWords": 0,
    "relatedMeaningWords": 0,
    "aggregatedScore": 50.0
  },
  "internet": [
    {
      "url": "http://example.com/",
      "id": "2a1b402420",
      "title": "Example Domain",
      "introduction": "Example Domain This domain is for use in illustrative examples in documents. You may use this domain in literature without...",
      "matchedWords": 1,
      "identicalWords": 1,
      "similarWords": 0,
      "paraphrasedWords": 0,
      "totalWords": 28,
      "metadata": {
        "authors": []
      },
      "tags": []
    }
  ],
  "database": [],
  "batch": [],
  "repositories": []
},
"notifications": {
  "alerts": [
    {
      "code": "suspected-ai-text",
      "title": "Potential AI-Generated Text Detected",
      "message": "We are unable to verify that the text was written by a human.",
      "severity": 4,
      "additionalData": "{"results": [{"classification": 2, "probability": 0.7307997032499992, "matches": [ {"text": {"chars": {"starts": [0], "lengths": [1453]}, "words": {"starts": [0], "lengths": [230]}}}]}], "summary": {"human": 0.0, "ai": 1.0}, "modelVersion": "v8.0", "translationProvider": 0, "explain": {"patterns": {"statistics": {"aiCount": [18.38596534729004, 1.4073526859283447, 2.917997121810913, 3.4344568252563477, 2.4015376567840576, 1.58811354637146, 2.324068546295166, 8.947664260864258, 1.6268479824066162, 3.9767396450042725, 1.3944411277770996, 4.648137092590332, 15.093534469604492, 4.389907360076904, 18.734575271606445, 1.4073526859283447, 3.3957223892211914, 4.196235179901123, 1.6397595405578613, 1.9367238283157349, 3.938005208969116, 9.980583190917969, 7.566134452819824, 85.03508758544922, 5.706879615783691, 428.94140625, 58.77622985839844, 35.015625, 47.52120590209961, 227.6015625], "humanCount": [1.1367287635803223, 0.3948078751564026, 0.5908869504928589, 0.0794915184378624, 0.0397457592189312, 0.20932766795158386, 0.2808700203895569, 1.5845309495925903, 0.041070617735385895, 0.041070617735385895, 0.45442652702331543, 0.076841801404953, 0.5604152083396912, 0.06226835772395134, 0.6399067044258118, 0.3948078751564026, 0.5352429151535034, 0.3020677864551544, 0.18283049762248993, 0.2676214575767517, 0.049019768834114075, 0.06094349920749664, 0.014573445543646812, 2.1263980865478516, 0.7286722660064697, 8.128008842468262, 5.878292083740234, 3.120574712753296, 7.039435863494873, 40.785186767578125], "proportion": [16.17445182800293, 3.5646519660949707, 4.938333988189697, 43.205326080322266, 60.4224853515625, 7.586734771728516, 8.274534225463867, 5.646884918212891, 39.610992431640625, 96.82687377929688, 3.068573474884033, 60.48969650268555, 26.932769775390625, 70.49980926513672, 29.277040481567383, 3.5646519660949707, 6.344264507293701, 13.89169979095459, 8.968741416931152, 7.2368035316467285, 80.335037231... [truncated]
      "category": 2
    }
  ]
},
"writingFeedback": {
  "textStatistics": {
    "sentenceCount": 5,
    "averageWordLength": 4.7,
    "averageSentenceLength": 12.8,
    "readingTimeSeconds": 21.0,
    "speakingTimeSeconds": 29.5
  },
  "score": {
    "grammarCorrectionsCount": 1,
    "grammarCorrectionsScore": 93,
    "grammarScoreWeight": 1.0,
    "mechanicsCorrectionsCount": 1,
    "mechanicsCorrectionsScore": 93,
    "mechanicsScoreWeight": 1.0,
    "sentenceStructureCorrectionsCount": 1,
    "sentenceStructureCorrectionsScore": 93,
    "sentenceStructureScoreWeight": 1.0,
    "wordChoiceCorrectionsCount": 0,
    "wordChoiceCorrectionsScore": 100,
    "wordChoiceScoreWeight": 1.0,
    "overallScore": 94
  },
  "readability": {
    "score": 95,
    "readabilityLevel": 1,
    "readabilityLevelText": "5th Grader",
    "readabilityLevelDescription": "Very easy to read"
  }
},
"status": 0,
"developerPayload": ""
}

{
"scannedDocument": {
  "scanId": "scan-id32",
  "totalWords": 2,
  "totalExcluded": 0,
  "credits": 0,
  "expectedCredits": 1,
  "creationTime": "2025-08-05T07:19:08.181236Z",
  "metadata": {
    "filename": "file.jpg"
  },
  "enabled": {
    "plagiarismDetection": true,
    "aiDetection": false,
    "explainableAi": false,
// ... truncated

400

400 Bad Request

The filename field is required.

401

401 Unauthorized

Authentication failed or API key is invalid.

409

409 Conflict

Conflict. An export task with the same Id already exists in the system.

429

429 Too Many Requests

Rate limit exceeded. Please retry after the specified time.

Examples

HTTP

PUT https://api.copyleaks.com/v3/scans/submit/ocr/my-scan-123
Content-Type: application/json
Authorization: Bearer YOUR_LOGIN_TOKEN

{
  "base64": "YOUR_BASE64_HERE",
  "filename": "image.jpg",
  "langCode": "en",
  "properties": {
    "webhooks": {
      "status": "https://my-server.com/webhook/{STATUS}"
    },
    "sandbox": true
  }
}

cURL

curl --request PUT \
  --url https://api.copyleaks.com/v3/scans/submit/ocr/my-scan-123 \
  --header 'Authorization: Bearer YOUR_LOGIN_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "base64": "YOUR_BASE64_HERE",
    "filename": "image.jpg",
    "langCode": "en",
    "properties": {
      "webhooks": {
        "status": "https://my-server.com/webhook/{STATUS}"
      },
      "sandbox": true
    }
  }'

Python

import requests
import base64

# Read and encode image file to base64
with open("image.jpg", "rb") as image_file:
    image_content = image_file.read()
    base64_content = base64.b64encode(image_content).decode('utf-8')

url = "https://api.copyleaks.com/v3/scans/submit/ocr/my-scan-123"
payload = {
    "base64": base64_content,
    "filename": "image.jpg",
    "langCode": "en",
    "properties": {
        "webhooks": {
            "status": "https://my-server.com/webhook/{STATUS}"
        },
        "sandbox": True,
        "aiGeneratedText": {
            "detect": True
        }
    }
}
headers = {
    "Authorization": "Bearer YOUR_LOGIN_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json"
}

response = requests.put(url, json=payload, headers=headers)
result = response.json()

print("OCR scan submitted successfully!")
if 'scannedDocument' in result:
    print(f"Scan ID: {result['scannedDocument'].get('scanId', 'N/A')}")
    print(f"Total words extracted: {result['scannedDocument'].get('totalWords', 'N/A')}")
    print(f"Detected language: {result['scannedDocument'].get('detectedLanguage', 'N/A')}")

print("Full response:", result)

JavaScript

const { Copyleaks, CopyleaksFileOcrSubmissionModel } = require('plagiarism-checker');
const fs = require('fs');

async function submitOcrScan() {
    try {
        // Initialize Copyleaks
        const copyleaks = new Copyleaks();

        // Login to get the authentication token object.
        // Replace with your email and API key.
        const loginResult = await copyleaks.loginAsync('[email protected]', 'YOUR_API_KEY');

        const scanId = "my-scan-123";
        const WEBHOOK_URL = "https://my-server.com/webhook";

        // Read an image file and convert it to base64
        const filePath = 'image.jpg';
        const fileContent = fs.readFileSync(filePath);
        const base64Content = fileContent.toString('base64');

        // Create a submission model
        const submission = new CopyleaksFileOcrSubmissionModel(
            'en', // Language of the text in the image
            base64Content,
            'image.jpg',
            {
                sandbox: true,
                webhooks: {
                    status: `${WEBHOOK_URL}/{STATUS}`
                }
            }
        );

        // Submit the OCR file for scanning
        await copyleaks.submitFileOcrAsync(loginResult, scanId, submission);
        console.log(`Submission successful. Scan ID: ${scanId}`);

    } catch (error) {
        console.error("An error occurred:", error);
    }
}

submitOcrScan();

Java

import classes.Copyleaks;
import models.submissions.CopyleaksOcrSubmissionModel;
import models.submissions.properties.*;
import java.util.Base64;
import java.nio.file.Files;
import java.nio.file.Paths;

public class OCRSubmissionExample {
    private static final String EMAIL_ADDRESS = "[email protected]";
    private static final String API_KEY = "00000000-0000-0000-0000-000000000000";

    public static void main(String[] args) {
        try {
            // Login to Copyleaks
            String authToken = Copyleaks.login(EMAIL_ADDRESS, API_KEY);
            System.out.println("Logged successfully!\nToken: " + authToken);

            // Read and encode image file
            byte[] imageContent = Files.readAllBytes(Paths.get("image.jpg"));
            String base64Content = Base64.getEncoder().encodeToString(imageContent);

            // Configure webhooks
            SubmissionWebhooks webhooks = new SubmissionWebhooks("https://my-server.com/webhook/{STATUS}");

            // Create submission properties
            SubmissionProperties properties = new SubmissionProperties(webhooks);
            properties.setSandbox(true);

            // Configure AI detection
            SubmissionAIGeneratedText aiGeneratedText = new SubmissionAIGeneratedText();
            aiGeneratedText.setDetect(true);
            properties.setAiGeneratedText(aiGeneratedText);

            // Configure scanning
            SubmissionScanning scanning = new SubmissionScanning();
            scanning.setInternet(true);
            properties.setScanning(scanning);

            // Create OCR submission
            String scanId = "my-scan-123";
            CopyleaksOcrSubmissionModel ocrSubmission = new CopyleaksOcrSubmissionModel(
                base64Content,
                "image.jpg",
                "en", // language code
                properties
            );

            // Submit OCR file for scanning
            var result = Copyleaks.submitOCR(authToken, scanId, ocrSubmission);

            System.out.println("OCR scan submitted successfully!");
            System.out.println("Scan ID: " + scanId);
            System.out.println("Language: en");
            System.out.println("Status: Processing - watch for webhooks");
            System.out.println("Text will be extracted from image and scanned for plagiarism");

        } catch (Exception e) {
            System.out.println("Failed to submit OCR scan: " + e.getMessage());
            e.printStackTrace();
        }
    }
}