API Reference
Zipf AI API Reference
Complete API documentation with code examples, parameters, and response formats.
Base URL
https://www.zipf.ai/api/v1Authentication
Authorization: Bearer $ZIPF_API_KEYSearch API
4 endpointsExecute searches with optional query decomposition, interpret queries, rerank results, and generate suggestions
Query DecompositionQuery InterpretationRerankingQuery Suggestions
View Documentation
Crawl API
5 endpointsWeb crawling with extraction schemas, link following, and document classification
Custom ExtractionLink FollowingDocument ClassificationSitemap Generation
View Documentation
Sessions API
10 endpointsMulti-step research workflows with URL deduplication and context inheritance
Workflow OrganizationURL DeduplicationContext InheritancePublic Sharing
View Documentation
Workflow API
3 endpointsScheduled monitoring and recurring search/crawl operations
Scheduled ExecutionStop ConditionsInterval ControlChange Detection
View Documentation
Token Management
3 endpointsCreate, list, and revoke API authentication tokens
Token CreationUsage TrackingPermissionsSoft Delete
View Documentation
Credits System
Basic = 1 credit. Advanced (with AI features) = 2 credits.
1-2
Search
+1 for AI features
1 + N
Search + Decomposition
1 decomposition + 1/query
1-2
Crawl (per page)
+1 for extraction/classifiers
1-2
Workflow (per execution)
+1 for NL condition
Credits are reserved when operations start and consumed when they complete. Failed operations release credits automatically.