BOOK A DEMO
LOGIN
Homekeyboard_arrow_rightDocumentationkeyboard_arrow_rightVersion 3keyboard_arrow_rightPlagiarism Checkkeyboard_arrow_rightDownloadskeyboard_arrow_rightSource
GET

/v3/downloads/my-custom-id

Get the text you submitted for a scan, as it was crawled by the Copyleaks servers.

The crawled version is available in textual format, and if properties.includeHtml field (in submit method) is set to true also in html format.

Testing purposes only!
This endpoint is for integration testing and verification only. Don't use this endpoint in the production environment.

For the production environment, use the Export method .
lock 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>
Not sure how to generate your login token? Read here .

Request

Request Example

RAW
cURL
Python
C#
Node.js
PHP
GET
https://api.copyleaks.com/v3/downloads/my-custom-id
Headers
Body

Response

Codes

Status Code
Description
Example
200
The command was executed. See the JSON body response. Description in the table below.
401
Bad request.
401
Authorization has been denied for this request

Example

{
  "metadata": {
    "words": 30,
    "excluded": 2
  },
  "html": {
    "value": "<html><body><h1>Example Domain</h1><p>This domain is established to be used for illustrative examples in documents.</body></html>",
    "exclude": {
      "starts": [
        16
      ],
      "lengths": [
        14
      ],
      "reasons": [
        3
      ],
      "groupIds": [
        1
      ]
    }
  },
  "text": {
    "value": "Example Domain This domain is established to be used for illustrative examples in documents.",
    "exclude": {
      "starts": [
        0
      ],
      "lengths": [
        14
      ],
      "reasons": [
        3
      ]
    },
    "pages": {
      "startPosition": [
        0
      ]
    }
  }
}

Description

Name
Description
metadata.words
Number of words in the text.
Unsigned Integer
metadata.excluded
Number of excluded words in the text.
Unsigned Integer
text.value
The crawled version of the submitted text.
String
text.exclude.starts
The start position of the section to exclude.
Unsigned Integer Array
text.exclude.lengths
The length, in characters, of the section to exclude.
Unsigned Integer Array
text.exclude.reasons
The reason why this section was excluded.
Unsigned Integer Array (enum)
Possible values:
1 : Quotation
2 : Reference
3 : Header
4 : Footer
5 : HtmlTemplate
6 : TableOfContent
text.pages.startPosition
A list of pages start positions of the text, the first startPostion is the start position of the first page.
Integer Array
html.value
The HTML version of the submitted file.
String
html.exclude.starts
The start position of the section to exclude.
Unsigned Integer Array
html.exclude.lengths
The length, in characters, of the section to exclude.
Unsigned Integer Array
html.exclude.reasons
The reason why this section was excluded.
Integer Array (enum)
Possible values:
1 : Quotation
2 : Reference
3 : Header
4 : Footer
5 : HtmlTemplate
6 : TableOfContent
html.exclude.groupIds
HTML contains design and visual elements, on top of the actual text. These elements may be placed in the middle of an excluded section (for example html tags).

Since in this case only the text should be excluded, and the the html tags should remain in place, we will split the excluded sections to sub sections, that will be under the same group Id.

Unsigned Integer Array

Other resources:

  • Exponential Backoff - Algorithm that helps applications define a retry strategy for consuming a network service.
stack-overflow_icon.png

Do you have a technical question?

Use stackoverflow.com to get help from our development team and other Copyleaks users.

Ask a Question

PRODUCTS

Scans
Pricing
Copyleaks.com

RESOURCES

Documentation
Plagiarism Report
Help Center
System Status
Security

ABOUT

About us
Careers
Terms of Use
Privacy Policy
Sitemap

Copyleaks, Inc.

700 Canal St.
Stamford, CT 06902 USA

[email protected]

Copyleaks, Inc. All rights reserved. Use of this website signifies your agreement to the Terms of Use.

Copy