Conversion

The conversion API allows files to be uploaded to the device for conversion into text.

Convert uploaded file

URL/api/<auth_token>/convert
MethodPOST
Version1.0

Description

Calling this method starts the conversion process for the uploaded files.

Path arguments

Name Type Description Required
auth_token string The authentication token used to authenticate the request. Required

Response

Returns an object with either a success or error property. If successful, an array of identifiers are returned for each file that has begun conversion Call the GET method below to retrieve the converted content after a few moments.

Response example

{
  "success" : true,
  "identifiers" : [
    "3BCC12BB-ABAB-47C9-9DF1-F5F4F6B792AB"
  ]
}

Retrieve converted file

URL/api/<auth_token>/convert/<conversion_identifier>
MethodGET
Version1.0

Description

Retrieves the converted text content from an uploaded file using an identifier.

Path arguments

Name Type Description Required
auth_token string The authentication token used to authenticate the request. Required
conversion_identifier string The identifier returned by the conversion upload process. Required

Query arguments

Name Type Description Required
keep boolean Determines if the converted file should be kept for future access. Default is false. Optional

Response

Returns the content of the converted file. If the keep query parameter is not set or set to true, the file is immediately deleted after accessed. If there is an error, it is returned as an error property on an object containing a description of the error.