list all pages

This API lists all your source and result files.

HTTP REQUEST
Get and Post

URL

https://cloud.dynamsoft.com/rest/ocr/v1.1/file?Method=list

Request Parameters

Parameters Type If Mandatory Description
method string Yes Fixed value: list
scope string No “source”, “result” (default value) or “both”

Sample Code
Request Body:

x-api-key: z81QwIA3kg0tUXkueP+QN4qXFCP0MIQIqDn94uxoVPdcnnGArr366w== 
POST https://cloud.dynamsoft.com/rest/ocr/v1/file?method=list&scope=both

Response:

{
"files": [
{
    "file_name": "export-to-cloud.PNG",
    "scope": "source"
},
{
    "file_name": "english.PNG",
    "scope": "source"
},
{
    "file_name": "multi page.docx",
    "scope": "result"
}
],
"error_code": 0,
"error_msg": "Success.",
"request_id": "2763158e2ba54682b0e2159bdabb0673"
}
Is this page helpful?