> For the complete documentation index, see [llms.txt](https://docs.hello-lisa.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hello-lisa.com/developers/rest-api.md).

# REST API

The LiSA REST API lets you integrate LiSA with your own systems: read your shows, short clips, snippets, stories and stickers, manage channels, and subscribe to webhooks to be told when your content changes.

The API follows REST conventions. It uses resource-oriented URLs and standard HTTP methods, accepts and returns JSON, and answers with standard HTTP status codes. All endpoints are served from:

```
https://api.hello-lisa.tech/v1
```

### Before You Start

Requests are authenticated with API keys of your organization, and the API limits how many requests you can make within a period of time. Read these pages before you build your integration:

### API Reference

Every endpoint, with its parameters, request and response bodies, and the error codes it can respond with, is described in the API documentation:

### A First Request

Create an API key under **Settings → Developers** in the LiSA Console, as described in Authentication, and list your shows:

```bash
curl https://api.hello-lisa.tech/v1/shows \
  -H 'Authorization: apikey <your-api-key>'
```

List endpoints return their items along with `scrolling` information. If there are more items than fit into one response, pass the `cursor` it contains to the next request to fetch the next page.

### Serving Your Storefront

The REST API is built for your servers and background processes, not for your storefront's visitors. Call it from your backend, cache what you receive, and serve your visitors from that cache. This keeps your storefront fast, and your integration well within its rate limits.

Never use an API key in a website, a mobile app, or any other code that runs on your customers' devices.
