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 .
For the production environment, use the Export method .
Add this HTTP header to your request: You need to login with a user and api key in order to access this method.
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
401
401
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
Unsigned Integer
metadata.excluded
Unsigned Integer
text.value
String
text.exclude.starts
Unsigned Integer Array
text.exclude.lengths
Unsigned Integer Array
text.exclude.reasons
Unsigned Integer Array (enum)Possible values:
1
: Quotation 2
: Reference 3
: Header 4
: Footer 5
: HtmlTemplate 6
: TableOfContent text.pages.startPosition
Integer Array
html.value
String
html.exclude.starts
Unsigned Integer Array
html.exclude.lengths
Unsigned Integer Array
html.exclude.reasons
Integer Array (enum)Possible values:
1
: Quotation 2
: Reference 3
: Header 4
: Footer 5
: HtmlTemplate 6
: TableOfContent html.exclude.groupIds
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.

Do you have a technical question?
Use stackoverflow.com to get help from our development team and other Copyleaks users.