Delete a single result file

HTTP REQUEST

POST

URL

https://cloud.dynamsoft.com/rest/ocr/v1/file

Request Parameters

Parameters Type If Mandatory Description
method string Yes Fixed value: delete
x-api-key string Yes DDC API Key. When making any API request, pass your key as the value of an x-api-key parameter in the Header.
file_name string Yes The name of the result file to be deleted

Response Parameters

Parameters Type UrlEncode Description
file_name string No The name of the result file to be deleted
error_code int32 No Error code
error_msg string No Error message

Sample Code Request Body:

x-api-key: z81QwIA3kg0tUXkueP+QN4qXFCP0MIQIqDn94uxoVPdcnnGArr366w==
POST https://cloud.dynamsoft.com/rest/ocr/v1/file?method=delete&file_name=f1.docx

Response:

{
    'files': [
        {
            'error_code': 0,
            'error_msg': 'Success.',
            'file_name': 'f1.docx '
        }
    ],
    'error_code': 0,
    'error_msg': 'success.',
    'request_id': 'c1b8d21befc64d9598a3ca32d3f044c2'
}
Is this page helpful?

Leave a Reply

Your email address will not be published.