GET /ocr/{request_id}/layouts

Retrieves the layout of a document in ProtoBuf format (binary format) from OCR results after processing has been completed. The layout can be used with the Fields endpoints for training, as well as to build a document viewer.


Authorization (required) - Requires the standard authentication header used in the system.


There are no parameters needed for this endpoint.

  • request_id Path Required

    the OCR request to return the document text. This is the OCR identifier returned from a successful POST /ocr response (request_id)

Code Sample
curl -X GET -H "Accept: application/json"  
-H "Authorization: Bearer <token>" 
-H "Content-Type: application/json"  
-d "{}" 
layout = zdai.ocr.get_layouts(request_id=’request_id’)
Response Codes
  • 200 OK
    The response successfully returned
  • 403 Forbidden
    Invalid or missing authentication token.
  • 404 Not Found
    The OCR request does not exist, has been cleaned up, or not finished.
  • 500 Internal Server Error
    Something went wrong unrelated to the users request or the OCR failed and there is an error message.

Response Data

  • document layout in ProtoBuf format

    (binary format)

Need Help?

Couldn’t find the information you were looking for or need more assistance?

Contact Support