🚀 Quickstart of the PageIndex API

Get your API key here.

Fill out this form to get your first 1,000 pages for free!

The PageIndex API consists of two main endpoints:

• Submit Endpoint (https://api.vectify.ai/pageindex): Submit a PDF document for processing.
• Status Endpoint (https://api.vectify.ai/pageindex/status): Check processing status and retrieve results when completed.

📘 Python Usage Example

import requests

# Submit PDF for processing
with open('./2023-annual-report.pdf', 'rb') as file:
    submit_response = requests.post(
        "https://api.vectify.ai/pageindex",
        headers={'api_key': 'YOUR_API_KEY_HERE'},
        files={'file': file}
    )
task_id = submit_response.json()["task_id"]

# Check processing status
status_response = requests.post(
    "https://api.vectify.ai/pageindex/status",
    headers={'api_key': 'YOUR_API_KEY_HERE'},
    json={"task_id": task_id}
)
status_data = status_response.json()

# Retrieve results when processing is complete
if status_data["status"] == "completed":
    print("Tree Structure Result:", status_data["result"])

⚙️ Advanced Usage

👉 See the full API Endpoints reference for optional parameters and advanced usage.

---

📝 Notes

• Currently supports PDF files only.
• Future updates will include additional document formats, improved parsing, and enhanced database integration.

For support or feedback, please join our Discord community or leave us a message.