This API lets you extract the content of a PDF file. The contents are returned as a string response.
Extracting text from a PDF file can make the text searchable, which can be particularly useful if you need to quickly find specific information within the file. This can make the content more accessible for people with disabilities, such as those with visual impairments. By extracting the text, you can convert it into a format that is easier to read using assistive technologies such as screen readers.
A successful request returns the string with the text from the PDF file. If the request fails, the response contains an error code and a message to help determine what went wrong.
upload file: extracted data
The method lets you submit a
|file||File||Yes||The source pdf file.|
|preserve_paragraphs||Boolean||No||This preserves the paragraphs in the response, if |
HTTP Response Codes
The method may return one of the following HTTP status codes:
|200||The request was successful.|
|400||Request is invalid or the file is not accessible.|
|401||Required authentication information is either missing or not valid for the resource.|
|500||There was an error in processing this request.|
All requests to ApyHub services need to be authenticated, currently we support
basic authenticationmechanisms. You can generate and view your existing credentials from workspace settings (on the left side of the navbar) and go to applications.
Points to note:
- Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
- Use the
apy-tokenas the header parameter to pass the token.
- Use the
Authorizationheader to send the basic authentication credentials.
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.