> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zipkit.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Welcome

> A simple API for zipping files from URLs

## What is ZipKit?

ZipKit is a powerful API that fetches files from the URLs you provide, bundles them into a single ZIP archive, and stores the result in your cloud storage bucket (S3 or R2). When the ZIP is ready, ZipKit sends a webhook notification so your system knows as soon as it's ready.

**Key Features:**

* 🚀 **Simple REST API** - Create zips with a single API call
* ☁️ **Your cloud storage** - Zips are stored in your own S3 or R2 buckets
* 🔔 **Webhook notifications** - Get instant alerts when zips are ready
* 🔒 **Secure** - All requests use HTTPS and bearer token authentication
* ⚡ **Fast & scalable** - Handles large files and multiple concurrent jobs

## Common Use Cases

* **Document Processing** - Bundle multiple documents (PDFs, Word files, spreadsheets) into a single downloadable archive for users
* **Image Galleries** - Create ZIP archives of photo collections for easy download
* **Backup & Export** - Generate ZIP exports of user data for compliance or data portability
* **Report Distribution** - Combine multiple report files into a single archive for distribution
* **Asset Delivery** - Package design assets, code files, or resources for delivery to clients

## How It Works

1. **Configure** your cloud storage bucket (S3 or R2) in the ZipKit dashboard
2. **Create** an access token for API authentication
3. **Send** a POST request with URLs of files to bundle
4. **Receive** a webhook when the zip is ready in your bucket
5. **Download** or share the zip from your cloud storage

## Quick Start

Get up and running in minutes:

<Card title="Quickstart Guide" icon="rocket" href="/quickstart">
  Follow our step-by-step guide to create your first zip in under 15 minutes
</Card>

## Core Concepts

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/guides/authentication">
    Secure your API requests with access tokens
  </Card>

  <Card title="Buckets" icon="bucket" href="/guides/buckets">
    Configure S3 or R2 storage for your zips
  </Card>

  <Card title="Zips" icon="file-zipper" href="/guides/zips">
    Bundle remote files into ZIP archives
  </Card>

  <Card title="Webhooks" icon="webhook" href="/guides/webhooks">
    Receive real-time notifications
  </Card>
</CardGroup>

## API Reference

Complete documentation for all API endpoints:

<CardGroup cols={2}>
  <Card title="Create Zip" icon="plus" href="/api-reference/create-zip">
    `POST /api/v1/zips` - Create a new zip archive
  </Card>

  <Card title="Get Zip" icon="magnifying-glass" href="/api-reference/get-zip">
    `GET /api/v1/zips/:id` - Retrieve zip status
  </Card>
</CardGroup>