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

# Integration overview

> The supported ways to integrate with Everabyte, and which ones are gated or contractual.

There are five realistic integration paths. Choose based on what you are building, not on what sounds familiar.

| Path | Best for | Availability |
| - | - | - |
| REST storage API | Server-side applications | Generally available |
| Laravel / PHP backend | Web applications on PHP | Generally available |
| Desktop backup agent | First-party backup of a machine | Available, device-bound |
| MCP server | AI clients and tool-using agents | Paid plans only |
| S3-compatible gateway | Existing S3 tooling | Feature-gated |

## REST storage API

This is the primary path. It is company-scoped, API-key authenticated, and documented in the [API reference](https://docs.everabyte.com/api-reference/introduction.md).

Use it when:

* you control a server,
* you need deterministic storage semantics,
* you want scopes and bucket restriction,
* you can keep a secret in a secret manager.

Do not use it directly from a browser. API-key headers are not CORS-allowed. See [Requests and CORS](https://docs.everabyte.com/authentication/requests-and-cors.md).

## Laravel and PHP

The API is plain JSON over HTTPS, so any HTTP client works. The [Laravel guide](https://docs.everabyte.com/integrations/laravel.md) covers configuration, a small client wrapper, and streaming uploads.

## Backup agent

The desktop agent is a first-party application that backs up a machine to Everabyte. It uses device-bound keys, not general-purpose developer keys.

It is not a documented integration contract for third parties. If you need scheduled backup from a server, use the REST API with your own scheduler.

## MCP server

The MCP endpoint exposes an authenticated tool surface for AI clients. It requires:

* the `mcp` scope on the key,
* a paid subscription.

Trial accounts are refused before the MCP handshake. See [MCP](https://docs.everabyte.com/integrations/mcp.md).

## S3-compatible gateway

A SigV4 gateway exists and supports common operations, but it is gated by a platform flag and not enabled by default.

Do not assume S3 compatibility. See [S3 compatibility](https://docs.everabyte.com/integrations/s3-compatibility.md).

> [!WARNING]
>
> There is no universal S3 compatibility guarantee. Documentation that says "point any S3 client at Everabyte" is inaccurate unless the gateway has been explicitly enabled for your account.

## Choosing the right path

| Requirement | Path |
| - | - |
| Server-to-server file storage | REST API |
| Browser-only storage | Proxy through your server to the REST API |
| Backup of a laptop or desktop | Backup agent |
| AI agent with storage tools | MCP |
| Existing rclone / restic workflow | S3 gateway, if enabled |
| Strict jurisdictional isolation | REST API with dedicated workspaces |

## What not to expect

* No official SDK is published at this time. Examples on this site are illustrations.
* No public bucket provisioning API.
* No public sharing or permission API.
* No self-service partner onboarding.
* No guarantee of S3 API parity.

## Related

> **[Laravel](https://docs.everabyte.com/integrations/laravel.md)**
>
> PHP client patterns and streaming uploads.

> **[S3 compatibility](https://docs.everabyte.com/integrations/s3-compatibility.md)**
>
> Gateway scope and gating.

> **[Backup agent](https://docs.everabyte.com/integrations/backup-agent.md)**
>
> Device-bound backup.

> **[MCP](https://docs.everabyte.com/integrations/mcp.md)**
>
> Tool surface for AI clients.


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