API Overview

The Eazip API is a RESTful API that allows you to convert multiple URLs into a single ZIP file.

Base URL

All API requests should be made to:

https://api.eazip.io

Authentication

All protected endpoints require authentication via API key. Include your key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

See Authentication for details.

Request Format

• Use Content-Type: application/json for POST requests
• All parameter names use snake_case

Response Format

Responses are JSON objects with a success boolean. The shape of the response body varies by endpoint — there is no universal data wrapper.

Success Response

{
  "success": true,
  // Endpoint-specific fields (e.g. "job", "jobs", "api_key", "api_keys" ...)
}

Error Response

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message",
    "issues": []
  }
}

issues is present only for validation errors (HTTP 400).

HTTP Status Codes

Code	Description
200	Success
201	Created
400	Bad Request — Invalid or missing parameters
401	Unauthorized — Invalid or missing API key
403	Forbidden — Plan limit or quota exceeded
404	Not Found — Resource doesn’t exist
500	Internal Server Error

Endpoints

Method	Endpoint	Auth	Description
POST	/jobs	✓	Create a new ZIP job
GET	/jobs	✓	List jobs (cursor-based pagination)
GET	/jobs/stats	✓	Get job count statistics
GET	/jobs/:id	✓	Get job details
POST	/jobs/:id/retry	✓	Retry a failed job
GET	/download/:token	—	Download ZIP (signed URL, no API key needed)
GET	/api-keys	✓	List API keys
POST	/api-keys	✓	Create an API key
DELETE	/api-keys/:id	✓	Revoke an API key
GET	/webhooks	✓	List webhook endpoints
POST	/webhooks	✓	Create a webhook endpoint
GET	/webhooks/:id	✓	Get webhook details
DELETE	/webhooks/:id	✓	Delete a webhook endpoint
POST	/webhooks/:id/rotate	✓	Rotate webhook signing secret
GET	/webhooks/:id/deliveries	✓	List delivery history for a webhook

See individual endpoint documentation for details:

• Jobs API
• API Keys