AI Summarize Documents API
ApyHub
2600 atoms
AI tier
About
This API can summarize complex documents including PDFs, DOCs, and ODFs. The API can translate the summary into multiple languages and allows customization of the summary length.
This API can summarize long text inside ebooks into short important text for different kinds of readers, streamline research paper reviews for researchers, and extract critical details from technical manuals for engineers.
Try out the API in the API playground and see how this free online summarizer API can help you summarize documents, and save time through the use of artificial intelligence and a simple API call.
Select API Endpoints
Input
API Playground
API Documentation
Summarize Documents File
POST
https://api.apyhub.com/ai/summarize-documents/file
Request example
Method:
POST
Endpoint:
https://api.apyhub.com/ai/summarize-documents/file
Content Type:
multipart/form-data
Request Body
Parameter | Type | Mandatory | Description |
---|---|---|---|
file | file | yes | The file to summarize. The max content size is 16,385 tokens (~12,000 words). (can be either docx , doc , odf or pdf ) |
summary_length | string | no | The desired length of the summary. Can be short , medium , or long .- short equals to max 20 words- medium is max 60 words- "long" is max 100 words. Defaults to short if not specified. |
output_language | string | no | The desired language for the output summary. Refer to the list below for possible ISO codes and their corresponding country names. Defaults to en if not specified. |
Sample Response
This is a sample JSON response from the API:
Language ISO Code and Country Name List
Please refer to the following list to set the output_language parameter:
ISO Code | Language (Script) |
---|---|
sq | Albanian |
ar | Arabic (Arabic script) |
hy | Armenian (Armenian script) |
awa | Awadhi (Devanagari script) |
az | Azerbaijani (Latin script) |
ba | Bashkir (Cyrillic script) |
eu | Basque |
be | Belarusian (Cyrillic script) |
bn | Bengali (Bengali script) |
bho | Bhojpuri (Devanagari script) |
bs | Bosnian (Latin script) |
pt_BR | Brazilian Portuguese |
bg | Bulgarian (Cyrillic script) |
yue | Cantonese (Yue) (Traditional Chinese script) |
ca | Catalan |
hne | Chhattisgarhi (Devanagari script) |
zh | Chinese (Simplified Chinese script) |
hr | Croatian (Latin script) |
cs | Czech |
da | Danish |
doi | Dogri (Devanagari script) |
nl | Dutch |
en | English |
et | Estonian |
fo | Faroese |
fi | Finnish |
fr | French |
gl | Galician |
ka | Georgian (Georgian script) |
de | German |
el | Greek (Greek script) |
gu | Gujarati (Gujarati script) |
bgc | Haryanvi (Devanagari script) |
hi | Hindi (Devanagari script) |
hu | Hungarian |
id | Indonesian |
ga | Irish |
it | Italian |
ja | Japanese (Kanji, Hiragana, Katakana scripts) |
jv | Javanese (Latin script) |
kn | Kannada (Kannada script) |
ks | Kashmiri (Perso-Arabic script) |
kk | Kazakh (Cyrillic script) |
kok | Konkani (Devanagari script) |
ko | Korean (Hangul script) |
ky | Kyrgyz (Cyrillic script) |
lv | Latvian |
lt | Lithuanian |
mk | Macedonian (Cyrillic script) |
mai | Maithili (Devanagari script) |
ms | Malay (Latin script) |
mt | Maltese |
zh_CN | Mandarin (Simplified Chinese script) |
mr | Marathi (Devanagari script) |
mwr | Marwari (Devanagari script) |
nan | Min Nan (Traditional Chinese script) |
ro | Moldovan (Latin script) |
mn | Mongolian (Cyrillic script) |
cnr | Montenegrin (Latin script) |
ne | Nepali (Devanagari script) |
no | Norwegian |
or | Oriya (Odia script) |
ps | Pashto (Perso-Arabic script) |
fa | Persian (Farsi) (Perso-Arabic script) |
pl | Polish |
pt | Portuguese |
pa | Punjabi (Gurmukhi script) |
raj | Rajasthani (Devanagari script) |
ru | Russian (Cyrillic script) |
sa | Sanskrit (Devanagari script) |
sat | Santali (Ol Chiki script) |
sr | Serbian (Cyrillic and Latin scripts) |
es | Spanish; Español |
sd | Sindhi (Arabic script) |
si | Sinhala (Sinhala script) |
sk | Slovak |
sl | Slovene |
uk | Ukrainian (Cyrillic script) |
ur | Urdu (Perso-Arabic script) |
uz | Uzbek (Latin script) |
vi | Vietnamese |
cy | Welsh |
wuu | Wu (Simplified Chinese script) |
HTTP Response Codes
The method may return one of the following HTTP status codes:
Status Code | Description |
---|---|
200 | The request was successful. |
400 | The request was invalid or could not be understood by the server. |
401 | Required authentication information is either missing or not valid for the resource. |
500 | If any unexpected error occurs while processing the request. |
Authentication
All API 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 your workspace settings (on the left side of the navbar) and go to “API Keys".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.
Table of contents