Quick start

Get your API keys

Your API requests are authenticated using the API key. Any request that doesn't include an API key will return an error.

You can generate an API key from your Developer page at any time.

Your API key is shown only once when it is generated. Make sure to note it down securely. If you lost it you can regenerate it again from the same page.

Make your first request

To make your first request, send an authenticated request to the upload endpoint with your PDF URL. This will create a document ID docId for your PDF using which you can chat or get the summary of the PDF.

Upload the PDF

Upload the PDF using URL

POST https://pdf.ai/api/v1/upload/url

To get a document ID for your PDF

Headers

Name	Type	Description
X-API-Key*	string	<API-Key>

Request Body

Name	Type	Description
url*	string	URL of your PDF file
isPrivate	boolean	If your PDF file is private(true or false)

200 PDF is successfully uploaded

{
    "docId": "abcdxxxxxxx"
}

401 Invalid API key

{
    "error": "Invalid API key"
}

400: Bad Request No API key or URL is present

{
    "error": "No API key present"
}

Get a summary of the PDF

Summary of the PDF

POST https://pdf.ai/api/v1/summary

To summarize your PDF using docId

Headers

Name	Type	Description
X-API-Key*	string	<API-Key>

Request Body

Name	Type	Description
docId*	string	Document ID obtained after uploading PDF

200 Summary of the PDF

{
    "content": "This is the summary of the PDF"
}

401 Invalid API key

{
    "error": "Invalid API key"
}

400: Bad Request No API key or docId is present

{
    "error": "No API key present"
}