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

# Introduction

> What the Ekly API does, what it does not do yet, and who it is for.

The Ekly API gives your code the same generation models the Ekly app uses, billed from the same
credit balance. One key, one base URL, every image, video, music and speech model in the catalog.

```
https://api.ekly.ai/v1
```

## What you can do

* **Discover models** and their parameters, allowed values and credit prices before you spend anything.
* **Generate** images, videos, video extensions, speech, music and motion-controlled video.
* **Poll** a generation until it finishes and download the outputs.
* **Upload** reference files (images, video, audio) for models that take them.
* **Check credits**, including a per-member cap when your workspace uses one.

## What it does not do yet

The editor timeline, rendering, projects, workspace assets and billing management stay in the app.
If you need one of those over an API, tell us at [hello@ekly.ai](mailto:hello@ekly.ai); it shapes what ships next.

## Who it is for

Teams that already use Ekly and want generations inside their own pipeline: a CMS that needs a
hero image per article, a nightly job that turns scripts into voice-over, an internal tool that
drafts product video. If you work in an agent (Claude, ChatGPT, Cursor), the [MCP server](/mcp)
exposes the same capabilities without any code.

## Using these docs from an AI assistant

Nothing to install. Give your assistant any page URL, or the whole site at once:

* `https://docs.ekly.ai/llms.txt` lists every page; `https://docs.ekly.ai/llms-full.txt` is the entire
  documentation in one file.
* Any page is available as Markdown by appending `.md` to its URL.
* The menu on each page copies it as Markdown or opens it in ChatGPT, Claude, Cursor or VS Code.

An assistant that works from these pages gets the same per-model `example_request` bodies a script does.

<Card title="Quickstart" icon="rocket" href="/quickstart">
  From API key to a downloaded image in about ten minutes.
</Card>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.