Documentation
API Documentation
Everything you need to integrate Ask, Search, Crawl, Sessions, and Workflow APIs into your application. Start building in minutes with our developer-first infrastructure.
Quick Start Guide
Get Your API Key
Sign up for a free account and generate your API token from the dashboard.
Authorization: Bearer wvr_abc123...Get Your API Key
Sign up for a free account and generate your API token from the dashboard.
Authorization: Bearer wvr_abc123...Make Your First Request
Start with a simple search query to test your integration.
curl -X POST https://www.zipf.ai/api/v1/search \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-d '{"query": "AI safety papers", "max_results": 10}'Make Your First Request
Start with a simple search query to test your integration.
curl -X POST https://www.zipf.ai/api/v1/search \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-d '{"query": "AI safety papers", "max_results": 10}'Process Results
Parse the JSON response and integrate results into your application.
{
"results": [...],
"session_id": "uuid",
"total_results": 1250,
"credits_used": 1
}Process Results
Parse the JSON response and integrate results into your application.
{
"results": [...],
"session_id": "uuid",
"total_results": 1250,
"credits_used": 1
}Ask API
/v1/askGet direct answers with source citations (AI-native)
/v1/ask/:idGet ask job status and answer
Ask API
/v1/askGet direct answers with source citations (AI-native)
/v1/ask/:idGet ask job status and answer
Search API
/v1/searchExecute a search (1 credit basic, 2 credits with AI features)
/v1/searchWith query_decomposition: comprehensive multi-query search
/v1/search/jobs/:idGet search job status and results
Search API
/v1/searchExecute a search (1 credit basic, 2 credits with AI features)
/v1/searchWith query_decomposition: comprehensive multi-query search
/v1/search/jobs/:idGet search job status and results
Crawl/Extract API
/v1/crawlsCreate crawl job (1 credit/page basic, 2/page with AI features)
/v1/crawlsList crawl jobs with filters
/v1/crawls/:idGet crawl job status and results
/v1/crawls/:idCancel running crawl job
Crawl/Extract API
/v1/crawlsCreate crawl job (1 credit/page basic, 2/page with AI features)
/v1/crawlsList crawl jobs with filters
/v1/crawls/:idGet crawl job status and results
/v1/crawls/:idCancel running crawl job
Workflow API
/v1/workflowsCreate workflow (1 credit/execution, 2 with NL condition)
/v1/workflowsList active workflows
/v1/workflows/:idGet workflow details and execution history
/v1/workflows/:idDelete workflow
Workflow API
/v1/workflowsCreate workflow (1 credit/execution, 2 with NL condition)
/v1/workflowsList active workflows
/v1/workflows/:idGet workflow details and execution history
/v1/workflows/:idDelete workflow
Sessions API
/v1/sessionsCreate a new research session with configuration
/v1/sessionsList all sessions with filters and pagination
/v1/sessions/:idGet session details, operations, and metrics
/v1/sessions/:id/archiveArchive completed session
/v1/sessions/:idDelete session and all associated operations
Sessions API
/v1/sessionsCreate a new research session with configuration
/v1/sessionsList all sessions with filters and pagination
/v1/sessions/:idGet session details, operations, and metrics
/v1/sessions/:id/archiveArchive completed session
/v1/sessions/:idDelete session and all associated operations
Code Examples
Create Session and Run Operations
curl# Step 1: Create a session
curl -X POST https://www.zipf.ai/api/v1/sessions \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "AI Safety Research",
"description": "Comprehensive research on AI safety papers",
"session_config": {
"max_operations": 100
}
}'
# Step 2: Run operations with optional session_id parameter
# Search
curl -X POST https://www.zipf.ai/api/v1/search \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "AI alignment techniques",
"max_results": 20,
"session_id": "your-session-id-here"
}'
# Crawl
curl -X POST https://www.zipf.ai/api/v1/crawls \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"urls": ["https://example.com"],
"max_pages": 5,
"session_id": "your-session-id-here"
}'
# Workflow (recurring operations)
curl -X POST https://www.zipf.ai/api/v1/workflows \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Monitor AI news",
"workflow_type": "search",
"operation_config": {"query": "AI breakthroughs"},
"stop_condition": {"type": "always"},
"interval_minutes": 60,
"session_id": "your-session-id-here"
}'Create Session and Run Operations
curl# Step 1: Create a session
curl -X POST https://www.zipf.ai/api/v1/sessions \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "AI Safety Research",
"description": "Comprehensive research on AI safety papers",
"session_config": {
"max_operations": 100
}
}'
# Step 2: Run operations with optional session_id parameter
# Search
curl -X POST https://www.zipf.ai/api/v1/search \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "AI alignment techniques",
"max_results": 20,
"session_id": "your-session-id-here"
}'
# Crawl
curl -X POST https://www.zipf.ai/api/v1/crawls \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"urls": ["https://example.com"],
"max_pages": 5,
"session_id": "your-session-id-here"
}'
# Workflow (recurring operations)
curl -X POST https://www.zipf.ai/api/v1/workflows \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Monitor AI news",
"workflow_type": "search",
"operation_config": {"query": "AI breakthroughs"},
"stop_condition": {"type": "always"},
"interval_minutes": 60,
"session_id": "your-session-id-here"
}'Search with Filters
curlcurl -X POST https://www.zipf.ai/api/v1/search \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "Papers from COLM 2025 Workshops",
"max_results": 20,
"interpret_query": true,
"rerank_results": true,
"session_id": "optional-session-id"
}'Search with Filters
curlcurl -X POST https://www.zipf.ai/api/v1/search \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "Papers from COLM 2025 Workshops",
"max_results": 20,
"interpret_query": true,
"rerank_results": true,
"session_id": "optional-session-id"
}'Ask a Question (AI-Native)
curlcurl -X POST https://www.zipf.ai/api/v1/ask \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"question": "Who is the CEO of NVIDIA?",
"depth": "quick"
}'
# Response includes direct answer with citations:
# { "answer": "Jensen Huang is the CEO of NVIDIA...",
# "sources": [...], "confidence": 0.95 }Ask a Question (AI-Native)
curlcurl -X POST https://www.zipf.ai/api/v1/ask \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"question": "Who is the CEO of NVIDIA?",
"depth": "quick"
}'
# Response includes direct answer with citations:
# { "answer": "Jensen Huang is the CEO of NVIDIA...",
# "sources": [...], "confidence": 0.95 }Crawl with Custom Extraction
curlcurl -X POST https://www.zipf.ai/api/v1/crawls \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"urls": ["https://example.com/blog"],
"max_pages": 10,
"extraction_schema": {
"title": "Extract the article title",
"author": "Extract the author name",
"publish_date": "Extract publish date in ISO format"
}
}'Crawl with Custom Extraction
curlcurl -X POST https://www.zipf.ai/api/v1/crawls \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"urls": ["https://example.com/blog"],
"max_pages": 10,
"extraction_schema": {
"title": "Extract the article title",
"author": "Extract the author name",
"publish_date": "Extract publish date in ISO format"
}
}'Create a Workflow
curlcurl -X POST https://www.zipf.ai/api/v1/workflows \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Monitor AI News",
"workflow_type": "search",
"operation_config": {"query": "AI breakthroughs"},
"stop_condition": {
"type": "natural_language",
"description": "Stop when GPT-5 is released"
},
"interval_minutes": 60
}'Create a Workflow
curlcurl -X POST https://www.zipf.ai/api/v1/workflows \
-H "Authorization: Bearer $ZIPF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Monitor AI News",
"workflow_type": "search",
"operation_config": {"query": "AI breakthroughs"},
"stop_condition": {
"type": "natural_language",
"description": "Stop when GPT-5 is released"
},
"interval_minutes": 60
}'Ready to Start Building?
Get 100 free credits per month. No credit card required. Full access to all APIs.