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

# Overview

> The Hypastack v3 REST API: plain JSON, one error shape, no SDK required.

Drive your files and your CDN from your own code. Plain REST, plain JSON, no SDK to install. If you can make an HTTP request, you already know this API.

```text theme={null}
Base URL   https://api.hypastack.com/v3
```

## Your first call

```bash theme={null}
export HYPASTACK_API_KEY="hsk_your_key_here"

curl "https://api.hypastack.com/v3/files" \
  -H "Authorization: Bearer $HYPASTACK_API_KEY"
```

That returns your files. If it returns `401`, the key is wrong. If it returns `403 plan_required`, your plan has no API access, see [Pricing & Plans](/pricing).

## Getting a key

Open **Settings → Account**, turn on **Developer mode**, then go to the **Developer** tab and hit **New key**. Pick a name and tick only the permissions you need. The key is shown once and never again, so copy it then. Full walkthrough in [Account & Passkeys](/account-and-api-keys).

## What's covered here

<CardGroup cols={2}>
  <Card title="Authentication & Scopes" icon="key" href="/api-reference/authentication">
    Bearer tokens and the six scopes a key can hold.
  </Card>

  <Card title="Uploading" icon="upload" href="/api-reference/uploading">
    The three-step reserve / PUT / commit flow.
  </Card>

  <Card title="Pagination" icon="list" href="/api-reference/pagination">
    Cursor-based, not offsets.
  </Card>

  <Card title="Errors" icon="triangle-exclamation" href="/api-reference/errors">
    One error shape, switch on the code.
  </Card>

  <Card title="Rate Limits" icon="gauge" href="/api-reference/rate-limits">
    Per-key budgets by plan.
  </Card>

  <Card title="Full Example" icon="file-code" href="/api-reference/full-example">
    One runnable script covering everything.
  </Card>
</CardGroup>