Getting Started

Quick Start

Follow these three steps to be up and running immediately.

1. 1

   Create an account

   Visit the registration page and fill in your email and a password. You will immediately receive a generated API key — save it securely.

2. 2

   Retrieve your API key

   Log in and navigate to your dashboard. Your API key is displayed there; click to copy it.

3. 3

   Upload your first file

   Use the Upload page in the app, or send a request directly to the API (see the cURL example below).

Registration Walkthrough

Registration is free and requires only an email address and password.

1. Navigate to /register.
2. Enter a valid email address and a password of at least 8 characters.
3. Submit the form. On success you will see your API key displayed in a modal — copy it now.
4. The API key is shown only once. Store it in a password manager or environment variable.
5. You are now redirected to the dashboard where you can begin uploading files.

First Upload Tutorial

Upload a file using the web interface or directly via the API.

Using the web interface

1. Log in and navigate to /upload.
2. Drag a file onto the dropzone or click Browse to select one.
3. The file is validated client-side (type and size) before upload begins.
4. Watch the live progress bar. On completion the CID is shown and copied to your upload history.

Using the API

curl -X POST https://your-domain.com/api/v1/files/upload \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@/path/to/your/file.pdf"

A successful response returns the file's CID:

{
  "status": 201,
  "message": "File uploaded successfully",
  "data": {
    "cid": "bafkreih5aznjvttude6c3wbvqeebb6rlx7kibuzn7i56aklrbb2a5v53em",
    "original_filename": "file.pdf",
    "size": 204800,
    "pinned": true,
    "uploaded_at": "2026-03-14T12:00:00Z"
  }
}

API Key Management

Your API key authenticates every request to the IPFS Gateway API.

• →View your key: Log in and go to the dashboard. The key is shown masked; click to reveal or copy it.
• →Renew your key: From the dashboard, initiate the renewal flow. A verification code is generated; submit it to confirm and receive a new key.
• →Use it in requests: Pass the key in the X-API-Key header for every authenticated endpoint.