Extract Text from PDF
50 atoms
Base tier
About
This Utility API lets you extract the content of a PDF file.
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.
Endpoint Selector
Input
API Playground
Documentation
upload file: extracted data
POST
https://api.apyhub.com/extract/text/pdf-file
Request example
The method lets you submit a
pdf
file and returns the extracted text as string output. This is the most straight forward way to use this service - submit a pdf file and receive the extracted text as a response.Method:
POST
Content Type:
multipart/form-data
Request Body
Attribute | Type | Mandatory | Description |
---|---|---|---|
file | File | Yes | The source pdf file. |
preserve_paragraphs | Boolean | No | This preserves the paragraphs in the response, if true , defaults to false . |
Sample Response
HTTP Response Codes
The method may return one of the following HTTP status codes:
Status Code | Description |
---|---|
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. |
Authentication
All requests to ApyHub services need to be authenticated, currently we support
tokens
or basic authentication
mechanisms.
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-token
as the header parameter to pass the token. - Use the
Authorization
header to send the basic authentication credentials.
Error codes
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.