/health
Check API process availability. No authentication or credit charge.
curl --fail-with-body https://api.editly.studio/healthResponse example
Illustrative, simplified response. Additional fields may be returned.
{ "status": "ok" }EDITLY / API REFERENCE
Connect your workflow to Editly’s image and video engines. Start small, authenticate securely, and follow every generation to its final result.
BASE URL https://api.editly.studioThis read-only request requires no account and uses no credits:
curl --fail-with-body https://api.editly.studio/healthA healthy API process responds with {"status":"ok"}. This check does not test upstream AI providers, billing, or storage.
Sign in to the developer dashboard, name your key, choose permissions and an expiry, then copy it once. Store it server-side as EDITLY_API_KEY. Start with the free credits check below.
Create your key in the Editly developer dashboard. Sign-in and applicable 18+ eligibility checks are required. Each key is bound to your account, has an expiry and is displayed only once.
Authorization: Bearer $EDITLY_API_KEY from your server. Never use an AI-provider key or share your account session.credits:read reads the balance; generations:read lists, polls and downloads your results; generations:write creates images and Seedance videos; uploads:write enables temporary video/audio uploads.Retry-After.Never put keys in frontend code, a mobile app bundle, query strings, logs or public repositories. Only a hash is stored by Editly. API keys cannot access account, payment, admin or key-management routes. A read-only key cannot submit paid jobs.
Developer keys support the image and Seedance selections below. Other in-app engines and client-completed job mutations are not enabled for developer keys. JSON requests are limited to 20 MB; image references can use image URLs or image data URLs.
| Model | Request field | Value |
|---|---|---|
| Nano Banana 2 | model | gemini-3.1-flash-image |
| Nano Banana Pro | model | gemini-3-pro-image |
| GPT Image 2 | model | gpt-image-2 |
| Seedance 2.0 | provider | seedance |
| Seedance 2.5 | provider | seedance25 |
Send type: "image", a prompt, a model, and an aspect ratio to POST /api/generations. Optional inputImage or inputImages provide references. Supported media limits depend on the selected model.
Use POST /api/generations/seedance. For a first integration, use a text-only prompt, 5 seconds, 480p, and 16:9. Other durations, resolutions and media combinations are validated against the selected model and server configuration.
seedanceImageMode: "reference" accepts up to nine image references.seedanceImageMode: "first_frame" uses a first image and optionally a last image; first-frame output framing follows the image constraints.POST /api/uploads/seedance/presign with filename, contentType, kind (video/audio), sizeBytes and durationSeconds. PUT the file bytes to the returned data.uploadUrl using the same Content-Type, then send referenceVideo or referenceAudio as {key: data.key, durationSeconds: …}. Do not attach your Editly key to the storage PUT. Uploads are temporary, validated and account-bound; submit before expiry. Arbitrary video URLs are not supported. Audio must be paired with a visual reference.Upload only content you have rights and any required consent to use. Provider moderation and Editly’s terms still apply.
data.id. A 200 create response means the job was accepted, not that the output is ready.GET /api/generations/{id} approximately every 3–6 seconds. Responses can include intermediate states such as pending; treat non-terminal states as still in progress.completed, read data.imageUrl or data.videoUrl, or use the authenticated download endpoint. On failed, inspect the returned failure information.Use the Editly generation ID—not the provider’s task ID or the filename UUID. Generation detail and download endpoints are restricted to the owning account.
The API checks ownership, but an output’s underlying media URL may be publicly reachable by anyone who has it. Do not assume that hiding a URL or requiring API login makes the media storage private.
API generation uses the same account credit balance as Editly. Read GET /api/credits to see purchased credits, subscription credits, applicable expiration information and general cost settings.
costs object is not a universal quote for every video configuration.Check current plans in Editly pricing. This portal does not introduce new plans, discounts, payment methods, or billing terms.
8 operations
Check API process availability. No authentication or credit charge.
curl --fail-with-body https://api.editly.studio/healthIllustrative, simplified response. Additional fields may be returned.
{ "status": "ok" }Submit a prompt-based image job using an authenticated account with sufficient credits.
curl --fail-with-body https://api.editly.studio/api/generations \
-H "Authorization: Bearer $EDITLY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "image",
"model": "gemini-3.1-flash-image",
"prompt": "A blue origami boat on a sunlit pond",
"aspectRatio": "16:9"
}'Illustrative, simplified response. Additional fields may be returned.
{ "data": { "id": "<generation-id>", "status": "queued" } }Submit a Seedance text-to-video job. The server selects the matching model from the provider.
curl --fail-with-body https://api.editly.studio/api/generations/seedance \
-H "Authorization: Bearer $EDITLY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"provider": "seedance25",
"prompt": "A blue origami boat glides across a pond",
"duration": 5,
"resolution": "480p",
"aspectRatio": "16:9"
}'Illustrative, simplified response. Additional fields may be returned.
{ "data": { "id": "<generation-id>", "status": "queued" } }Read the status and output of a generation owned by the authenticated account.
curl --fail-with-body \
"https://api.editly.studio/api/generations/$GENERATION_ID" \
-H "Authorization: Bearer $EDITLY_API_KEY"Illustrative, simplified response. Additional fields may be returned.
{ "data": { "id": "<generation-id>", "status": "completed",
"videoUrl": "https://<media-host>/<output>.mp4" } }Read the authenticated account’s balance, subscription and expiration information.
curl --fail-with-body https://api.editly.studio/api/credits \
-H "Authorization: Bearer $EDITLY_API_KEY"Illustrative, simplified response. Additional fields may be returned.
{ "data": { "credits": 120,
"purchasedCredits": 100, "subscriptionCredits": 20 } }Download completed media owned by the authenticated account. Returns binary media, not a JSON URL.
curl --fail-with-body \
"https://api.editly.studio/api/generations/$GENERATION_ID/download" \
-H "Authorization: Bearer $EDITLY_API_KEY" \
--output editly-output.mp4Illustrative, simplified response. Additional fields may be returned.
Binary file response · use .jpg or the returned image format for image jobs.List your account’s generation history, with page and limit query parameters. Requires generations:read.
curl --fail-with-body "https://api.editly.studio/api/generations?page=1&limit=20" \
-H "Authorization: Bearer $EDITLY_API_KEY"Illustrative, simplified response. Additional fields may be returned.
{ "data": [], "current_page": 1, "total_pages": 0, "total_items": 0, "per_page": 20 }Create a temporary video/audio upload. Requires uploads:write. Replace the example file size and duration with the real values, then upload bytes to the returned URL.
curl --fail-with-body https://api.editly.studio/api/uploads/seedance/presign \
-H "Authorization: Bearer $EDITLY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"filename":"reference.mp4","contentType":"video/mp4",
"kind":"video","sizeBytes":1048576,"durationSeconds":5}'Illustrative, simplified response. Additional fields may be returned.
{ "data": { "key": "<temporary-object-key>",
"uploadUrl": "<signed-PUT-url>", "expiresInSeconds": 900,
"maxBytes": 104857600 } }No matching endpoints. Try “video”, “credits”, or “GET”.
| HTTP status | What to do |
|---|---|
| 400 | Check model, settings and media constraints. Read the error message. |
| 401 | Check your API key, expiry and revocation status. |
| 402 | Check the account balance and required credits. |
| 403 | Check the required permission, permitted endpoint and account eligibility. |
| 404 | Check the route and generation ID. Private records owned by another account also return 404. |
| 429 | Slow down and honor Retry-After if returned. |
| 5xx | Back off on reads. Check an existing job before submitting another paid request. |
Most errors use {"error":{"message":"…","code":"…"}}; some legacy endpoints return an error string. Handle both without logging credentials.
Do not automatically repeat a paid POST after a timeout. It may already have created a job and charged credits. Check your recent generations or contact support first.