AskPDF
⚠️ Important Notes: 👉 The API has been built with safety and security in mind. 👉 Requires a paid OpenAI API key (for better/faster responses). 👉 Before start using the API for chatting with documents, the OpenAPI key should be registered first via the endpoint: "/api/v1/ai-model-settings/update".
308 subscribers
0.1/10 popularity
51350 ms avg latency
7 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
AskPDF endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST |
Register/Update OpenAI Model settings (only once, and will be used by all the chat rooms). /api/v1/ai-model-settings/update |
Register your OpenAI API key to be used with chat room in the back-end. **Important Note:** You can change AI model settings. |
| POST |
Upload document (e.g PDF) /api/v1/upload |
Upload your document like a PDF, a chat room will be create / returned identified by a UUID |
| POST |
Chat room /api/v1/chat/{uuid} |
Send your / client question and you'll get an AI reply as a response |
| GET |
Chat Room details /api/v1/chat/{uuid}/detail |
Get details about a chat room |
| DELETE |
Delete chat room /api/v1/chat/{uuid}/delete |
You need to delete the chat room after you don't need it any more. |
| POST |
Clear chat room conversation history /api/v1/chat/{uuid}/clear-history |
Clear the chat room conversation history. |
| POST |
Stop Chat Room Agent (cancel the prompt) /api/v1/chat/{uuid}/stop |
Stop Chat Room Agent (cancel the prompt) |
AskPDF pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
