Skip to main content
1

Create an API key

In the Ekly app open Settings → Team → API keys and choose Create key. You need to be an organization admin. The secret is shown once; keep it somewhere safe and never commit it.
2

See which models you can use

Each entry lists the parameters the model accepts and its credit price for your organization. The id is what you pass as model below. GET /v1/models/{id} adds a ready-to-send example_request per mode, so you never have to guess a field name.
3

Estimate the cost

An estimate reserves nothing. It tells you the credits after your discounts and whether your balance covers it.
4

Generate an image

The response comes back immediately with "status": "pending" and an id. Credits are reserved now and settled when the job finishes. The Idempotency-Key header means a retry of the same request returns the same generation instead of charging twice.
5

Poll until it finishes

Poll every 2–5 seconds. Images usually finish in under a minute, video in a few minutes. When status is completed, outputs holds the download URLs; when it is failed, error says why and nothing was charged.
6

Download the output

Output URLs are not permanent. Download promptly or copy the file to your own storage.

​
Where next

  • Generations: the lifecycle, polling guidance and idempotency in detail.
  • Uploads: register a reference image, video or audio file and get its asset id.
  • Choosing a model: which model fits which job.
  • The API reference tab has every endpoint with request and response examples in several languages.