Fetching PDF recognition result

When a PDF file is submitted for recognition, it is queued to ensure a stable response even under high load. To obtain the result, send a GET request to the https://api.aspose.cloud/v5.0/ocr/RecognizePdf Aspose.OCR Cloud REST API endpoint. To authorize the request, pass the access token in Authorization header (Bearer authentication).

Provide the unique identifier of the PDF recognition task in id parameter:

curl --request GET --location 'https://api.aspose.cloud/v5.0/ocr/RecognizePdf?id=db03b9ea-3eed-4954-a1d4-b2712773bbe' \
--header 'Accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...HaRYOxBcCRCPLnrFCVXpw7UA' \

Recognition results

The recognition result is returned in JSON format in the response body.

{
	"id": "db03b9ea-3eed-4954-a1d4-b2712773bbe",
	"taskStatus": "Completed",
	"responseStatusCode": "Ok",
	"results": [
		{
			"type": "Pdf",
			"data": "JVBERi0xLjQKJfbk...HJlZgo0NTU2NQolJUVPRgo="
		}
	],
	"error": null
}

Recognition results are stored in the Aspose cloud and can be obtained by the task ID within 24 hours after the PDF was set for OCR.

Property	Type	Description
`id`	string	Unique identifier of the recognition task. Equals to the value of the `id` request property.
`taskStatus`	string	Current state of the recognition task in the queue.
`responseStatusCode`	string	Recognition response status.
`results`	array	Recognition results (depend on the `resultType` property of the recognition task). All results (including plain text) are returned as Base64 encoded strings. You must decode them to display on the screen or save to a file.
`error/messages`	string[]	Recognition error messages, if any. Even if the PDF is recognized, you can still get notifications and warnings about non-fatal recognition errors.

Task statuses

Recognition may take up to several seconds depending on the Aspose.OCR cloud load and the size of the PDF document. The status of the recognition task is indicated in the taskStatus property of the recognition result.

Status code	Description	To do
Pending	The PDF is queued for recognition, but not yet processed.	Try fetching the result in a couple of seconds using the same ID.
Processing	The PDF is currently recognized.	Fetch the result again using the same ID.
Completed	The PDF is recognized.	Read the recognition result from `results` property.
Error	An error occurred during recognition.	Check messages in the `error` property for more information.
NotExist	The request with the specified ID does not exist, or the result has already been deleted from the cloud storage.	Check the ID or send the PDF file for recognition again with the same parameters.

Sending PDF for recognition