> For the complete documentation index, see [llms.txt](https://wingbits.gitbook.io/wingbits-ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wingbits.gitbook.io/wingbits-ai/build/rest-api-quickstart.md).

# REST API quickstart

The Wingbits REST API gives you on-demand snapshots and lookups — ideal when you don't need a continuous stream.

> **Looking for the full endpoint reference?** See the [REST API reference](https://wingbits.gitbook.io/wingbits-ai/reference/rest-api-reference.md) (auto-generated from our OpenAPI spec).

## 1. Get an API key

See [Access & authentication](https://wingbits.gitbook.io/wingbits-ai/build/access-and-auth.md). Pass it as a bearer token on every request.

## 2. Make your first call

```bash
curl -H "Authorization: Bearer $WINGBITS_API_KEY" \
  "https://customer-api.wingbits.com/..."
```

## 3. Handle the response

See the [Data dictionary](https://wingbits.gitbook.io/wingbits-ai/reference/data-dictionary.md) for field meanings.

## When to use REST vs. the stream

| Use REST when…                   | Use the [stream](https://wingbits.gitbook.io/wingbits-ai/build/nats-stream.md) when… |
| -------------------------------- | ------------------------------------------------------------------------------------ |
| You need point-in-time snapshots | You need every update as it happens                                                  |
| You make occasional queries      | You're powering a live map/dashboard                                                 |
| You want simple request/response | You can run a long-lived connection                                                  |

> **DRAFT** — endpoints and examples to be completed with the API team.
