Documentation

Build with Zipf

Web search, crawling, extraction, and monitoring for your applications and AI agents.

Using an AI assistant?

Connect Claude, Cursor, or Windsurf to Zipf via MCP. One command.

MCP setup

Search or ask questions?

Search the web or get direct answers with the Ask API. 1-5 credits.

Getting started

Extract structured data?

Crawl websites and extract custom fields with AI. Define a schema, get JSON.

Crawl API docs

Ongoing monitoring?

Schedule recurring searches and crawls. Get alerts in Slack, email, or webhooks.

Workflow API docs

Full API Reference Get API Key

Quick Start Guide

Get Your API Key

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}'

Process Results

Parse the JSON response and integrate results into your application.

{
  "results": [...],
  "session_id": "uuid",
  "total_results": 1250,
  "credits_used": 1
}

Get Your API Key

API Endpoints

Full API Reference

Ask API

POST/v1/ask

Get direct answers with source citations (AI-native)

2-5 credits

GET/v1/ask/:id

Get ask job status and answer

Free

Search API

POST/v1/search

Execute a search (1 credit basic, 2 credits with AI features)

1-2 credits

POST/v1/search

With query_decomposition: comprehensive multi-query search

1 + N credits

GET/v1/search/jobs/:id

Get search job status and results

Free

Crawl/Extract API

POST/v1/crawls

Create crawl job (1 credit/page basic, 2/page with AI features)

1-2/page credits

GET/v1/crawls

List crawl jobs with filters

Free

GET/v1/crawls/:id

Get crawl job status and results

Free

DELETE/v1/crawls/:id

Cancel running crawl job

Free

Workflow API

POST/v1/workflows

Create workflow (1 credit/execution, 2 with NL condition)

1-2 credits

GET/v1/workflows

List active workflows

Free

GET/v1/workflows/:id

Get workflow details and execution history

Free

DELETE/v1/workflows/:id

Delete workflow

Free

Sessions API

POST/v1/sessions

Create a new research session with configuration

Free

GET/v1/sessions

List all sessions with filters and pagination

Free

GET/v1/sessions/:id

Get session details, operations, and metrics

Free

POST/v1/sessions/:id/archive

Archive completed session

Free

DELETE/v1/sessions/:id

Delete session and all associated operations

Free

Code Examples

Ask a Question (AI-Native)

curl

curl -X POST https://www.zipf.ai/api/v1/ask \
  -H "Authorization: Bearer $ZIPF_API_KEY" \
  -d '{"question": "Who is the CEO of NVIDIA?", "depth": "quick"}'

# Returns: { "answer": "Jensen Huang...", "sources": [...] }

Crawl with Extraction

curl

curl -X POST https://www.zipf.ai/api/v1/crawls \
  -H "Authorization: Bearer $ZIPF_API_KEY" \
  -d '{
    "urls": ["https://example.com/blog"],
    "max_pages": 5,
    "processing_mode": "sync",
    "extraction_schema": {
      "title": "Extract the article title",
      "author": "Extract the author name"
    }
  }'

Create a Monitoring Workflow

curl

curl -X POST https://www.zipf.ai/api/v1/workflows \
  -H "Authorization: Bearer $ZIPF_API_KEY" \
  -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": "1 hour"
  }'

View Full API Reference

Ready to Start Building?

Get 100 free credits per month. No credit card required. Full access to all APIs.

Get Your API Key View Examples