50 atoms
Base tier

About

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.
Endpoint Selector
Input

API Playground

Documentation

upload file: extracted data
POST
https://api.apyhub.com/extract/text/pdf-file

Request example

1
curl --location --request POST 'https://api.apyhub.com/extract/text/pdf-file' \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: multipart/form-data' \
4
--form 'file=@"test.pdf"'
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
AttributeTypeMandatoryDescription
fileFileYesThe source pdf file.
preserve_paragraphsBooleanNoThis preserves the paragraphs in the response, if true, defaults to false.
Sample Response
1
{
2
"data": "A consequuntur voluptatem ut mollitia voluptatem. Lorem ipsum dolor sit amet. Aut aspernatur quibusdam hic amet quas nam internos consequatur et ipsam repellendus ut galisum obcaecati. In repudiandae ipsa aut dolor asperiores et sint voluptatem aut voluptates quia. Nam numquam enim ut dolorum sunt Et doloremque cum temporibus debitis aut labore delectus et odit tempore in autem odio. Aut impedit fugit ut voluptate rerum sit culpa voluptatem ab galisum perferendis qui dignissimos minima est galisum perferendis et consequatur dolorem. Eum velit Quis ut nobis consequuntur Quo aperiam est fugiat quas ut fugiat dolorem ut voluptatum exercitationem aut quia temporibus. Rem rerum voluptas et quis voluptatum et veniam temporibus et tempore galisum et odit error est animi consequuntur. Et magni deleniti et molestiae corporis eos possimus itaque ut placeat quis hic fuga ratione qui fugiat porro aut praesentium repellat."
3
4
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
400Request is invalid or the file is not accessible.
401Required authentication information is either missing or not valid for the resource.
500There 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

1
{
2
"error": {
3
"code": 105,
4
"message": "Invalid URL"
5
}
6
}
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.