API Overview

The Eazip API is a RESTful API that allows you to convert remote file lists 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 X-API-Key header:

X-API-Key: YOUR_API_KEY

GET /download/:token is the main exception and does not require an 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 — Authentication required, invalid API key, or expired API key
403	Forbidden — Plan limit or quota exceeded
404	Not Found — Resource doesn’t exist
500	Internal Server Error

See individual endpoint documentation for details:

• Jobs API
• API Keys