← Back to Documentation

REST API Reference

The Zevis API provides programmatic access to all platform features via REST endpoints. Base URL: https://zevis.cloud/v1

Authentication: Include your API key in the Authorization header as Bearer <your-api-key>

Core Endpoints

MethodPathDescription
POST/extractionCreate a new web extraction job
GET/extractionList all extraction jobs
GET/extraction/:idGet job status and details
GET/extraction/:id/streamSSE stream for real-time job progress
GET/extraction/:id/artifactDownload the extraction result
DELETE/extraction/:idCancel a running job

Billing & Credits

MethodPathDescription
GET/credits/balanceCheck current credit balance
GET/credits/historyView transaction history
POST/billing/checkoutCreate a LemonSqueezy checkout session
GET/billing/packagesList available credit packages

Request Example

curl -X POST https://zevis.cloud/v1/extraction \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/products", "output": "json", "maxPages": 5}'

Response Format

All responses follow this structure:

{
  "success": true,
  "data": { ... },
  "meta": {
    "creditsUsed": 15,
    "processingTimeMs": 2340
  }
}

Rate Limits

  • Free tier: 10 requests/minute
  • Pro tier: 100 requests/minute
  • Enterprise: Custom limits
Need help? Contact [email protected] or visit the Support Dashboard