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

# Introduction

> What the Everabyte developer platform is, which API surface is public, and how to use this documentation.

Everabyte is a cloud storage platform for companies. The developer API exposes the storage primitives your application needs: buckets, folders, files, versions, retention, trash, and restore.

This documentation is for developers integrating with Everabyte from a trusted server. It is not the [Help Center](https://everabyte.com/help) and it is not marketing material: it describes behavior verified against the backend implementation.

## The API at a glance

| Item | Value |
| - | - |
| Base URL | `https://api.everabyte.io/api` |
| Authentication | Company API key sent as `X-Public-Key` and `X-Secret-Key` |
| Format | JSON requests and responses, except file upload and file download |
| Upload encoding | `multipart/form-data` |
| Download | Binary stream with range support |
| Dashboard | [`app.everabyte.com`](https://app.everabyte.com) |
| Support | [`support@everabyte.com`](mailto:support@everabyte.com) |

All routes are registered under the `/api` prefix. For example, listing a bucket's files is `https://api.everabyte.io/api/files/findAll/BUCKET_ID`.

## Who can use the developer API

The REST storage surface is **company-scoped**. A company API key authenticates as the company workspace and can only reach the company's buckets, folders, and files.

Individual EverSpark accounts are rejected with `403 API_COMPANY_ONLY`. The only first-party exception is an API key bound to an enrolled backup device, which the desktop agent uses for its own upload and restore chain. That exception is not a general-purpose path for third-party integrations.

API keys are limited to storage operations: `/files`, `/folders`, `/buckets`, and the backup agent surface. Requests to other route families are rejected with `403 API_KEY_SURFACE_DENIED` before any quota is consumed.

## What is published here

The API reference contains endpoints that are:

* reachable with API-key credentials,
* allowed by the documented scope model, and
* verified against route registration and controller behavior.

Some backend routes exist but are deliberately excluded: session-only endpoints, administrative and reseller provisioning, sharing controls, audit exports, and features that are still stabilizing. Excluded does not mean forbidden forever; it means this documentation does not yet publish a stable public contract for them.

> [!WARNING]
>
> Do not build against an endpoint merely because you can reach it. If it is not in this reference, treat it as internal and contact support before depending on it.

## Two distinct authentication surfaces

| Surface | Authentication | Audience |
| - | - | - |
| REST storage API | `X-Public-Key` + `X-Secret-Key` | Server-side integrations |
| Dashboard / web application | Browser session and JWT | Human users in the app |

These are separate. A browser session does not authenticate the REST API, and an API key does not authenticate dashboard routes. See [Authentication overview](https://docs.everabyte.com/authentication/overview.md).

## Prerequisites

Before your first request, you need:

1. A company account with access to the dashboard.
2. An API key created for that company, with the scopes your integration needs.
3. Active billing where your plan requires it. Lapsed subscriptions receive `402 SUBSCRIPTION_REQUIRED`.
4. A verified email if you are using trial access.
5. Active encryption keys for the user who owns the uploads. Uploads fail with a clear error until those keys exist.

## Where to go next

> **[Quickstart](https://docs.everabyte.com/getting-started/quickstart.md)**
>
> Make a verified request and upload your first file.

> **[Core concepts](https://docs.everabyte.com/concepts/overview.md)**
>
> Understand buckets, folders, files, versions, and retention.

> **[Authentication](https://docs.everabyte.com/authentication/overview.md)**
>
> Learn how API keys, scopes, and bucket ceilings work.

> **[API reference](https://docs.everabyte.com/api-reference/introduction.md)**
>
> Read the endpoint contracts.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.