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

# Playground

> How the request display in this reference works, why it is not a live production console, and how to try requests safely.

## What the playground does

The API reference shows each operation's path, parameters, required scopes, and an example request. Examples are copyable so you can adapt them in your own terminal or code.

## What it deliberately does not do

| Capability | Enabled |
| - | - |
| Copy an example request | Yes |
| Read parameter documentation | Yes |
| Send a live request from the browser with your secret key | No |
| Proxy requests through a third party | No |
| Store credentials in the browser | No |

This is a deliberate configuration, not a limitation of the documentation tooling.

## Why live requests are disabled

1. **Production safety.** Most operations mutate real data. A one-click delete or hard delete in a documentation page is a foot-gun, not a feature.
2. **Credential safety.** These endpoints require a secret key. Sending it from a documentation page means the secret exists in a browser tab and potentially in a proxy.
3. **CORS.** API-key headers are not allowed by CORS, so a browser request would fail preflight anyway.
4. **No auth proxy.** Routing your secret through a documentation proxy moves the trust boundary without a security review.

> [!TIP]
>
> Try requests from a terminal, or from a scratch environment where a mistake cannot destroy real data. Use a key restricted to a disposable bucket.

## Safe way to experiment

1. Create a dedicated bucket named for experimentation.
2. Create a key with `buckets:read`, `buckets:write`, `files:read`, `files:write`, `folders:read`, `folders:write`.
3. Restrict that key to the experiment bucket.
4. Export credentials as environment variables.
5. Run the examples from the reference.

```bash theme={null}
export EVB_PUBLIC_KEY="pk_your_public_key"
export EVB_SECRET_KEY="sk_your_secret_key"
export EVB_BUCKET_ID="00000000-0000-0000-0000-000000000000"
```

Never place real values in a shell history you share. Use a secret manager in real deployments.

## Example: read-only smoke test

```bash theme={null}
curl -sS "https://api.everabyte.io/api/folders/findAll/$EVB_BUCKET_ID?page=1&limit=20" \
  -H "X-Public-Key: $EVB_PUBLIC_KEY" \
  -H "X-Secret-Key: $EVB_SECRET_KEY" \
  | jq '.data.total'
```

Expected: a number. If you get `403`, read the `code`.

## Example: list a bucket's files

```bash theme={null}
curl -sS "https://api.everabyte.io/api/files/findAll/$EVB_BUCKET_ID?page=1&limit=20" \
  -H "X-Public-Key: $EVB_PUBLIC_KEY" \
  -H "X-Secret-Key: $EVB_SECRET_KEY" \
  | jq '.data.total'
```

## Destructive operations

Delete, hard delete, and version deletion are documented for completeness. Do not run them against a bucket that holds data you need.

If you must test them:

1. Upload a file you can discard.
2. Record its `fileId`.
3. Soft delete it and restore it.
4. Only then consider a hard delete, on the disposable file.

## About the examples

Examples across this site are illustrative. They use placeholder identifiers and omit retries, structured error decoding, and secret management for brevity.

They are **examples, not official SDKs**. There is no official Everabyte SDK documented at this time.

## Related

> **[Quickstart](https://docs.everabyte.com/getting-started/quickstart.md)**
>
> A guided first request.

> **[API keys](https://docs.everabyte.com/authentication/api-keys.md)**
>
> Create a scoped experiment key.

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

> **[Errors](https://docs.everabyte.com/api-reference/errors.md)**
>
> Interpreting failures.


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