> ## 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.

# Build with Everabyte

> Add secure cloud storage, file automation, and lifecycle controls to your application with the Everabyte developer platform.

![Everabyte developer platform](https://mintcdn.com/everabyte-ltd/IoDhsr9gZXfG83Tj/images/hero-light.svg?fit=max\&auto=format\&n=IoDhsr9gZXfG83Tj\&q=85\&s=f389de3ec964680ab5e14892c0df3c44)

Everabyte gives your application a company-scoped storage layer: encrypted files, folders, buckets, versions, retention, and restore — managed through one REST API.

Use the API when you need to automate uploads, build a document workflow, connect a backup process, or give your own customers a storage experience without operating object storage yourself.

> **[Get Started](https://docs.everabyte.com/getting-started/quickstart.md)**
>
> Follow the quickstart

> **[Explore API Reference](https://docs.everabyte.com/api-reference/introduction.md)**
>
> Open the reference

## Start with a guided path

> **[Authentication](https://docs.everabyte.com/authentication/overview.md)**
>
> API keys, scopes, bucket ceilings, and why keys belong on your server.

> **[Upload & download](https://docs.everabyte.com/storage/upload-files.md)**
>
> Multipart uploads, streaming downloads, range requests, and safe file handling.

> **[Organize content](https://docs.everabyte.com/storage/organize-folders.md)**
>
> Folders, moves, copies, trash, and the rules that protect existing data.

> **[Integrations](https://docs.everabyte.com/integrations/overview.md)**
>
> Choose between the REST API, the backup agent surface, and gated storage interoperability.

> **[Security architecture](https://docs.everabyte.com/security/encryption-architecture.md)**
>
> Server-side encryption, key hierarchy, and the limits we document honestly.

> **[Errors & limits](https://docs.everabyte.com/errors/overview.md)**
>
> Response envelopes, stable error codes, trial quotas, and rate limits.

## How development usually flows

**1. Create a company workspace**

The developer REST API is company-scoped. Sign in to the [Everabyte dashboard](https://app.everabyte.com) with a company account, then confirm billing and email verification where your plan requires it.

Individual EverSpark accounts cannot use the developer REST API. They receive `403 API_COMPANY_ONLY`. The one first-party exception is a key bound to an enrolled backup device.

**2. Issue an API key**

Create a key in the dashboard, choose the narrowest scopes that work, and store the secret in your server's secret manager. The secret is shown only at creation time.

**3. Call the REST API**

Send `X-Public-Key` and `X-Secret-Key` on every request to `https://api.everabyte.io/api`. Start with reads, then add writes.

**4. Handle lifecycle events explicitly**

Files move through upload, versioning, trash, restore, and retention. Build these states into your application instead of assuming a file can always be deleted or overwritten.

## What this documentation covers

The API reference publishes endpoints that are reachable with API-key credentials and verified against the backend route and permission model. Endpoints that exist but are session-only, administrative, reseller-provisioning, or still stabilizing are intentionally not published here.

> [!NOTE]
>
> Code samples are examples for common languages, not official SDKs. Response bodies in this documentation are illustrative, sanitized examples — not captured production traffic. Replace every placeholder credential before running anything.

## Security, stated plainly

Everabyte uses a **layered encryption architecture**: files are encrypted by the application services before they are written to storage, and Everabyte's storage infrastructure applies an additional, independent layer of encryption at rest. Decryption is governed by account-owner authorization: no Everabyte service uses a decryption key, or accesses decrypted content, outside an authorized operation.

Read [Encryption architecture](https://docs.everabyte.com/security/encryption-architecture.md) for the full model, including key custody and the protections it does and does not provide.


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