Welcome to the Polyvia API documentation. Our API enables you to build applications that extract, index, and reason over visual data at scale.
Two Simple Endpoints
Polyvia’s API is built around two core operations:
Ingest
Upload documents to extract visual logic and index facts into your knowledge base
Query
Search and reason over your visual knowledge base with audit-ready citations
Authentication
All API requests require authentication using an API key. Include your key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
Keep your API key secure. Never expose it in client-side code or public repositories.
Getting Your API Key
- Log in to Polyvia Studio
- Navigate to Settings > API Keys
- Click Create New Key
- Copy and securely store your key
Base URL
https://api.polyvia.ai
Quick Start
Here’s a complete example: ingest documents and query for insights.
import requests
api_key = "YOUR_API_KEY"
headers = {"Authorization": f"Bearer {api_key}"}
# 1. Ingest a document
with open("financial_report.pdf", "rb") as f:
response = requests.post(
"https://api.polyvia.ai/ingest",
headers=headers,
files={"file": f},
data={"name": "Q4 Financial Report"}
)
document_id = response.json()["document_id"]
# 2. Query your knowledge base
response = requests.post(
"https://api.polyvia.ai/query",
headers={**headers, "Content-Type": "application/json"},
json={
"query": "What was the Q4 revenue?",
"include_citations": True
}
)
result = response.json()
print(result["answer"])
# "Q4 2024 revenue was $119.58B [page 24, revenue chart]"
Rate Limits
Rate limits vary by plan:
- Free: 100 requests/day
- Pro: 1,000 requests/day
- Enterprise: Custom limits
Monitor your usage in Polyvia Studio to avoid hitting rate limits.
Support
Need help? Reach out to our team:
