Back
API Documentation
Access the PDF analysis functionality programmatically

Overview

The CED Smart PDF Analyzer API allows you to programmatically analyze PDF documents, extract structured information, and access the same functionality available in the web interface.

To use the API, you'll need an API key. Contact the administrator to obtain your API key.

Endpoints

POST /api/external/analyze

Analyze a PDF document and extract structured information. The analysis will be saved to history and a URL to access the results will be returned.

Headers
Content-Type: multipart/form-data
x-api-key: YOUR_API_KEY
Request Parameters
pdf
PDF file (required)
prompt
Custom analysis instructions (optional)
Response
{ "success": true, "message": "PDF analyzed successfully", "analysisId": "uuid-of-analysis", "historyUrl": "https://your-domain.com/history/uuid-of-analysis", "documentCount": 5, "processingTime": "3.45 seconds" }
Example (cURL)
curl -X POST \ https://your-domain.com/api/external/analyze \ -H "x-api-key: YOUR_API_KEY" \ -F "pdf=@/path/to/document.pdf"

Authentication

All API requests require an API key to be included in the request headers as x-api-key. Contact the administrator to obtain your API key.

Security Note: Keep your API key secure and do not expose it in client-side code. Always make API requests from your server.