Supercharge Ask Your PDF with Relevance AI

AskYourPDF integration enables dynamic, interactive conversations with PDF documents through an AI-powered API. This integration allows you to upload documents, extract information, and engage in intelligent conversations with document content. Key benefits include seamless document processing and analysis, interactive Q&A capabilities with PDF content, support for both URL and file-based document uploads, and real-time chat functionality with document context.

To get started, ensure you have an AskYourPDF account with OAuth credentials and a valid API access token. The integration supports PDF file formats and requires HTTPS for API calls. You will need read/write access for document uploads and authentication permissions for API calls.

For authentication setup, use the following code snippet:

const headers = { 'Authorization': 'Bearer YOUR_OAUTH_TOKEN', 'Content-Type': 'application/json' };

Base configuration can be set up as follows:

const baseConfig = { base_url: 'https://api.askyourpdf.com', oauth_account_id: 'YOUR_ACCOUNT_ID' };

To upload a document via URL, use this example request:

const uploadDocumentUrl = { method: 'POST', path: '/v1/document/upload', oauth_account_id: 'YOUR_ACCOUNT_ID', body: { url: 'https://example.com/document.pdf' } };

The expected response will include a document ID and status:

{ response_body: { docId: "doc_123xyz", status: "success" }, status: 200 }

For file uploads, the request looks like this:

const uploadDocumentFile = { oauth_account_id: 'YOUR_ACCOUNT_ID', file: '/tmp/document.pdf' };

And the expected response is similar:

{ response_body: { docId: "doc_123xyz", status: "success" }, status: 200 }

To chat with the document, use the following request format:

const chatRequest = { oauth_account_id: 'YOUR_ACCOUNT_ID', docId: 'doc_123xyz', sender: 'user', message: 'What is the main topic of this document?', stream: false };

The expected response will provide an answer and context:

{ response_body: { answer: "The main topic is...", context: "Based on the document content..." }, status: 200 }

Common issues include authentication errors, document upload failures, API rate limiting, and document processing issues. Solutions involve verifying OAuth token validity, ensuring the document is in PDF format, implementing request throttling, and checking file size limits.

For best practices, implement error handling, manage document IDs for frequent access, and optimize performance through streaming and request queuing.

For more information, refer to the API documentation at https://api.askyourpdf.com/docs and contact support for assistance.

Remember to replace placeholder values (YOUR_ACCOUNT_ID, YOUR_OAUTH_TOKEN) with actual credentials when implementing the integration.