Quick Start

Welcome to the Quick Start guide for the PagePeek API. This section is designed to help you get up and running with the API in the shortest amount of time. Follow the steps below to start integrating PagePeek's document analysis capabilities into your application.

Step 1: Create an Account

Before you can use the PagePeek API, you'll need to create an account on the PagePeek platform. Go to our sign up page and follow the prompts to create your account.

Step 2: Generate Your API Key

1. Once your account is set up, log in and navigate to the API section in your account dashboard.

2. Click on "Generate API Key" and give your API key a descriptive name to help you identify its purpose.

3. Your new API key will be displayed. Copy and store it securely as this is the only time it will be shown.

Step 3: Make Your First API Call

Now you’re ready to make your first API call. Use the POST /documents/upload endpoint to upload a document to PagePeek for analysis. Here's an example using curl:

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

Replace your_api_key_here with your actual API key and document.pdf with the path to your document.

Step 4: Check the Document Analysis Status

After uploading a document, you can check the analysis status using the GET /documents/:document_id/status endpoint.

bashCopy codecurl -X GET \
     -H "Authorization: Bearer your_api_key_here" \
     https://api.pagepeek.com/v1/documents/abc123/status

Replace abc123 with your document's ID.

Step 5: Retrieve Document Summary

Once the analysis is complete, retrieve the document summary using the GET /documents/:document_id/summary endpoint.

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

This Quick Start guide is just the tip of the iceberg. As you delve deeper into this documentation, you'll discover a wealth of features and endpoints available for a wide range of document analysis and management tasks. Welcome to the PagePeek API, and happy coding!