eroq

Référence de l’API · Platform

Creations library

Every image and video you rendered, with its recipe.

GETPOSTPATCHDELETE/v1/creationsFree

Every /v1 image, video and speech render is saved to your creation library automatically (free) with the full recipe in meta — model, rack, seconds, references. Pass folder_id on the generation call (images, videos, video edits, speech, remove-background, film renders) and it lands straight in that folder. GET /v1/creations/{id} fetches one; PATCH /v1/creations/{id} moves it between folders ({ "folderId": … | null }) and hearts it ({ "favorite": true } — favoritedAt on every creation); DELETE removes it and its file.

Folders: GET /v1/folders lists them, POST /v1/folders ({ "name": … }) creates, PATCH /v1/folders/{id} renames, DELETE /v1/folders/{id} removes — deleting a folder keeps its creations (they fall back to the root).

Public folder links (Team, Agency and Enterprise). POST /v1/folders/{id}/share gives a folder a page anyone with the link can open, signed out — share.url (eroq.ai/f/…). Visitors see the files only: never a prompt, a model or your account; downloads: false makes it view-only. The page follows the folder (files you add appear), pauses while the workspace that shared it is off the business tier, and never gets indexed. DELETE /v1/folders/{id}/share kills the link at once — sharing again mints a new one. A role that cannot publish answers 403 role_forbidden; a plan below Team, 403 plan_required.

Community publishing. POST /v1/creations/{id}/publish puts a creation on the public shelf at eroq.ai/community and on your profile at eroq.ai/@username — title is its public face; an image or a clip shows its prompt unless you pass showPrompt: false (the rest of the recipe stays private, and a voice line never shows its script); durationSeconds overrides the badge with the exact measured length. DELETE …/publish pulls it back (likes, comments and views survive a re-publish). POST …/thumbnail (multipart file, image ≤ 5MB) sets the cover of a video or voice.

Endpoints

Sélectionne un verbe pour charger sa requête, son playground et sa réponse.

GET/v1/creationsaffiché

List your renders with folders and recipes.

GET/v1/creations/{id}

One creation, full meta — the Remix recipe.

PATCH/v1/creations/{id}

Move it between folders ({ "folderId": … | null }) and/or heart it ({ "favorite": true }).

folderIdstring

Target folder id, or null to move it back to the root.

favoriteboolean

true adds it to your favorites (stamps favoritedAt), false removes it.

DELETE/v1/creations/{id}

Delete the creation and its file.

POST/v1/creations/{id}/publish

Submit to the community shelf. Every publish is reviewed by our team first: review is pending, then approved (live) or rejected — readable on the creation. Publishing again keeps the verdict unless the title changes or a hidden prompt is shown; a rejected item is resubmitted.

titlestring

Public title, up to 120 characters. Defaults to a trimmed prompt — except a voice line, which defaults to its voice's name (its prompt is the script, and stays private).

durationSecondsnumber

Exact media length for the duration badge — pass what your player measured.

showPromptboolean

Show the prompt on the post (images and clips). Defaults to true on a first publish; omitted on a re-publish = unchanged.

DELETE/v1/creations/{id}/publish

Remove it from the community — engagement is kept for a re-publish.

POST/v1/creations/{id}/thumbnail

Set the cover of a video/voice (multipart file, image ≤ 5MB). A new cover on an approved community item sends it back to review (review in the response).

filefileobligatoire

Cover image, up to 5MB.

POST/v1/creations/{id}/feedback

Report a render that came out wrong — a reason and a few words, read by our team when working on the engine. One report per creation (sending again rewrites it), up to 20 a day (429 daily_limit past that). Free, and never a refund.

reasonstringobligatoire

What went wrong: body (broken body or hands), face (face does not match), motion (unnatural motion), glitch (glitches or artifacts), sound (sound is off), prompt (ignored part of the prompt), other (something else).

commentstring

What is wrong, and where — up to 1,000 characters.

GET/v1/folders

List your folders — share is the public link, null while private.

POST/v1/folders

Create a folder.

namestringobligatoire

Folder name, unique per account, up to 40 characters.

PATCH/v1/folders/{id}

Rename a folder.

namestringobligatoire

The new name, unique per account, up to 40 characters.

DELETE/v1/folders/{id}

Delete a folder — its creations fall back to the root, its public link dies. A folder locked by a PIN takes its creations with it (remove the PIN first to keep them).

POST/v1/folders/{id}/lock

Lock a folder with a 4-digit PIN: its creations leave every list (/v1/creations, reads by id) until the PIN is typed, and its public link is turned off. 409 already_locked on a locked folder. There is no recovery: a forgotten PIN leaves the folder shut. Answers an unlock token for the next 30 minutes.

pinstringobligatoire

Four digits.

POST/v1/folders/{id}/unlock

Type a locked folder's PIN. The right one answers an unlock token, good for 30 minutes: send it in the x-eroq-unlocked header (comma-separated, one per folder) and the folder's creations come back on a read of that folder (GET /v1/creations?folder=<id>, or open_folders=true for every folder a token opens) — never in a plain list of everything. A wrong PIN answers 403 wrong_pin with attempts_left; after 5 in a row the folder answers 423 pin_blocked (with retry_at) for 15 minutes.

pinstringobligatoire

Four digits.

DELETE/v1/folders/{id}/lock

Remove a folder's PIN, with the PIN: its creations go back into every list and every unlock token out stops working. Wrong PINs count toward the same block as /unlock.

pinstringobligatoire

The folder's PIN.

POST/v1/folders/{id}/share

Share a folder publicly (Team, Agency, Enterprise) — or update the live link. Idempotent: a shared folder keeps its link.

downloadsboolean

May visitors download the files? false = view only. Defaults to true on a new link; omitted on a live link = unchanged.

DELETE/v1/folders/{id}/share

Stop sharing — the link stops working at once; sharing again mints a new one.

curl https://eroq.ai/v1/creations \
  -H "Authorization: Bearer $EROQ_API_KEY"
/v1/creations
→ GET /v1/creations
Lance l’exemple — il rejoue un vrai échange à partir des données de la doc. Pas de clé, pas de requête, rien de facturé.

Réponse

200 · application/json
{
  "folders": [{ "id": "…", "name": "Campaign A" }],
  "creations": [{
    "id": "…", "kind": "video", "url": "https://…", "model": "seedance-2-5",
    "prompt": "slow pan over the rooftop", "meta": { "seconds": 10, "shot": "push-in" }
  }]
}