Qodex.ai

10.4 Get document info

GET http://{{rip_ip}}:5438/preflight/{{session_id}}/info

Objects with basic information about the document. When the option /full is added additional information about the document is provided like the contentRect. Processing will take longer in that case. When the /start/end option is used then the information is returned for the given page range (0-based).

Response

Success

Object containing the basic information and the information per page in the requested range.

  • Name (string) : Name of the document or internal title.
  • Type (string) : The type of document.
  • Creator (string, optional) : Name of the author.
  • Producer (string, optional) : Name of the creating application.
  • Password (bool) : True when the content is password protected.
  • Pages (array) : List of pages, containing objects with:
    • Width (real) : Width of the page in unit
    • Height (real) : Height of the page in units
    • ContentRect (array, optional) : Left, Top, Right, Bottom of the rectangle around the content on the page. Only supplied with the “Full” or page range option. The rectangle might extend outside of the page.
  • Meta (object, optional) : Metadata inside the PDF.
Error
  • 404 Not Found : {"Message":"Session not found"}
  • 500 Internal Error : {"Message":"An error has occurred"}

RESPONSES

status: OK

{"Name":"Aerial.png","Pages":[{"ContentRect":[0,0,1280,720],"Height":720,"Width":1280}],"Password":false,"Type":"png"}