Documents

Upload Document

• Endpoint: POST /documents/upload

• Description: Upload a document for analysis and summarization.

• Request Body:

  • file: The document file (PDF, DOCX, XML, etc.).

• Response: Document object containing document details.

Request

curl -X POST \
     -H "Authorization: Bearer your_api_key_here" \
     -F "[email protected]" \
     https://api.pagepeek.com/v1/documents/upload

Response

{
    "documentId": "abc123",
    "title": "Sample Document",
    "size": 345678,
    "status": "uploaded",
    "createdAt": "2023-10-01T12:00:00Z",
    "updatedAt": "2023-10-01T12:00:00Z"
}

Get Document Analysis

• Endpoint: GET /documents/:document_id/analysis

• Description: Retrieve the analysis of a specific document.

• Response: Analysis object containing document analysis details.

Request

curl -X GET \
     -H "Authorization: Bearer your_api_key_here" \
     https://api.pagepeek.com/v1/documents/abc123/analysis

Response

{
    "documentId": "abc123",
    "keywords": ["keyword1", "keyword2"],
    "summary": "This document discusses..."
}

Get Document Summary

• Endpoint: GET /documents/:document_id/summary

• Description: Retrieve the summary of a specific document.

• Response: Summary object containing document summary.

Request

curl -X GET \
     -H "Authorization: Bearer your_api_key_here" \
     https://api.pagepeek.com/v1/documents/abc123/summary

Response

{
    "documentId": "abc123",
    "summary": "This document discusses...",
    "keywords": ["keyword1", "keyword2"]
}