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

# Introduction

> ALL CAPS AS A SERVICE — the premier API for making text LOUDER.

<div className="acaas-hero">
  <div className="acaas-hero-badge">v0.1 · now in beta</div>

  <h1 className="acaas-hero-title">
    send <em>whisper</em>.<br />
    <span className="acaas-hero-accent">RECEIVE THUNDER.</span>
  </h1>

  <p className="acaas-hero-lede">
    A REST API for making text LOUDER. Send meek, lowercase strings and
    receive them back with full volume. Six endpoints. One mission. Zero chill.
  </p>
</div>

## Try it

<CodeGroup>
  ```bash cURL theme={"dark"}
  curl https://api.acaas.example.com/v1/shout \
    -H "X-API-Key: demo" \
    -H "Content-Type: application/json" \
    -d '{"text": "hello world"}'
  ```

  ```python Python theme={"dark"}
  import requests

  resp = requests.post(
      "https://api.acaas.example.com/v1/shout",
      headers={"X-API-Key": "demo"},
      json={"text": "hello world"},
  )
  print(resp.json()["result"])  # HELLO WORLD
  ```

  ```javascript Node theme={"dark"}
  const resp = await fetch("https://api.acaas.example.com/v1/shout", {
    method: "POST",
    headers: {
      "X-API-Key": "demo",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ text: "hello world" }),
  });
  const { result } = await resp.json(); // "HELLO WORLD"
  ```
</CodeGroup>

```json Response theme={"dark"}
{
  "original": "hello world",
  "result": "HELLO WORLD",
  "characters_amplified": 11
}
```

## Endpoints at a glance

<CardGroup cols={2}>
  <Card title="POST /v1/shout" icon="megaphone" href="/api-reference/shout">
    Uppercase a string. The essential endpoint.
  </Card>

  <Card title="POST /v1/scream" icon="volume-high" href="/api-reference/scream">
    Uppercase with configurable exclamation intensity (1 to 10).
  </Card>

  <Card title="POST /v1/whisper" icon="volume-low" href="/api-reference/whisper">
    The quiet cousin. Returns lowercase.
  </Card>

  <Card title="POST /v1/emphasize" icon="wand-magic-sparkles" href="/api-reference/emphasize">
    Experimental. A model picks which words to bold.
  </Card>

  <Card title="GET /v1/health" icon="heart-pulse" href="/api-reference/health">
    Service health. No auth required.
  </Card>

  <Card title="GET /v1/rate-limits" icon="gauge-high" href="/api-reference/rate-limits">
    Check your quota without spending a request.
  </Card>
</CardGroup>

## Why ACAAS

<Columns cols={3}>
  <div>
    **Fast.** P99 latency under 12ms, because capital letters are cheap.
  </div>

  <div>
    **Loud.** Configurable intensity, from polite emphasis to sustained yelling.
  </div>

  <div>
    **Secure.** Your lowercase text never leaves ACAAS servers. Promise.
  </div>
</Columns>

## Quickstart

<Steps>
  <Step title="Get an API key">
    For the demo, any non-empty string works. In production, generate one from the dashboard.
  </Step>

  <Step title="Make your first request">
    `POST` to `/v1/shout` with your lowercase text in the body.
  </Step>

  <Step title="Handle the response">
    You get back `original`, `result`, and `characters_amplified`.
  </Step>
</Steps>

## Authentication

Every request requires an `X-API-Key` header. For the demo, any non-empty key
works — except `acaas_banned_demo_key`, whose bullhorn has been revoked.

<Note>
  Request size is capped at 10,000 characters. ACAAS rejects larger payloads
  with a polite, lowercase error.
</Note>

## FAQ

<AccordionGroup>
  <Accordion title="Why not just use .toUpperCase()?">
    You could. But does `.toUpperCase()` come with a dashboard, rate limits,
    and a 99.99% uptime SLA? Didn't think so.
  </Accordion>

  <Accordion title="Is this a joke?">
    The product is a joke. The docs are not.
  </Accordion>

  <Accordion title="What's the experimental emphasis model?">
    A model trained to identify which words in a sentence most deserve
    emphasis. Non-deterministic and may change between versions.
    See [/v1/emphasize](/api-reference/emphasize).
  </Accordion>
</AccordionGroup>