# API documentation

This API allows developers to write applications that interact with Flipsnack from a 3rd party system. The API exposes different methods to manage a single workspace's flipbooks, based on an API key provided for that specific user.

## What can you do with the API:

* Upload files to create new flipbooks;
* Update flipbook settings;
* Delete flipbooks;
* Get flipbook data;
* Retrieve a list of flipbooks for the user who owns the API key;
* Retrieve statistics data for an entire user workspace or a single flipbook;
* Get the embed code for a specific flipbook.
* Generate the HTML package and get the download url for a flipbook.

To protect our users' data and the Flipsnack application, our public API imposes certain [limitations](https://developers.flipsnack.com/api-limitations). Abusing the API will get your API key banned and you will not be able to access Flipsnack data as a result. Your API key is available during your subscription period. Once your subscription ends, the API key will be disabled automatically.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.flipsnack.com/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.