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

# API reference overview

> What the reference covers, how operations are grouped, and how to read the contracts.

The API reference is generated from an OpenAPI document that covers the file, folder, and read-only bucket endpoints needed to manage content — endpoints verified against the backend and reachable with company API-key credentials.

## Base URL

```text theme={null}
https://api.everabyte.io/api
```

Every path in the reference is relative to this base.

## What is included

| Group | Operations | Purpose |
| - | - | - |
| Files | 14 | List, upload, download, update, move, copy, delete, restore, versions |
| Folders | 10 | List, inspect, browse, create, update, delete, restore, copy, move |
| Buckets | 2 | List accessible buckets, read bucket size |

Bucket creation and configuration stay in the dashboard. The published bucket operations are read-only: they let a key discover its `bucketId` values and track stored size. Use them as the container identifiers for file and folder calls.

## What is excluded

Excluded does not mean forbidden forever. It means this documentation does not publish a stable public contract for them.

* Bucket creation, update, deletion, and provisioning. Use the dashboard.
* Datacenter and region routes. They are session-only and are not reachable with an API key.
* Global (bucket-less) file and folder listings. Scope every listing to a `bucketId`.
* Recently accessed items, download-route resolution, and per-file security restriction reads.
* Session-only endpoints, including file details that require a browser session.
* Sharing, permission, and collaborator management.
* API key lifecycle (dashboard only, step-up protected).
* Billing and subscription management.
* Audit and compliance exports.
* Administrative, reseller, and partner provisioning.
* Backup agent, semantic search, upload-progress, and other surfaces still stabilizing.
* MCP tools (documented separately in [Integrations](https://docs.everabyte.com/integrations/mcp.md), not as REST operations).

## Reading the contracts

Each operation documents:

* **Path and method**, including optional segments.
* **Authentication**: always the same two headers for this surface.
* **Parameters**: path, query, and body, with types and constraints.
* **Required scopes**: the scope pair needed.
* **Responses**: status codes and response shapes.

> [!WARNING]
>
> Response examples are illustrative. They show the shape and field names the backend produces, but identifiers, sizes, and timestamps are not real production data. Do not copy values from examples into tests as fixtures.

## Two envelope shapes

The most common source of integration bugs is assuming one error shape. See [Conventions](https://docs.everabyte.com/api-reference/conventions.md) for the exact variants, but the short version:

* Controller success: `{ "status", "message", "data" }`
* Controller error: `{ "status", "message", "error" }`
* Middleware error: `{ "status", "message", "data": null, "code" }`

Middleware errors carry a stable `code`. Controller errors generally do not.

## Versioning

The documented surface is unversioned in the URL. This reference is the record of current behavior; treat undocumented fields as unstable.

## Getting started

> **[Authentication](https://docs.everabyte.com/api-reference/authentication.md)**
>
> Headers and which surface they apply to.

> **[Conventions](https://docs.everabyte.com/api-reference/conventions.md)**
>
> Envelopes, types, and identifiers.

> **[Pagination](https://docs.everabyte.com/api-reference/pagination.md)**
>
> List pagination shape.

> **[Errors](https://docs.everabyte.com/api-reference/errors.md)**
>
> Status codes and stable error codes.

> **[Playground](https://docs.everabyte.com/api-reference/playground.md)**
>
> How the request display works and its limits.

> **[Files](https://docs.everabyte.com/api-reference/files/overview.md)**
>
> File operation guide.

> **[Folders](https://docs.everabyte.com/api-reference/folders/overview.md)**
>
> Folder operation guide.

> **[Buckets](https://docs.everabyte.com/api-reference/buckets/overview.md)**
>
> Bucket discovery and stored size.


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