# API reference

> Base URL, authentication and every endpoint of the API at a glance.

Base URL: `https://eroq.ai/v1`. Every request carries your key in an `Authorization: Bearer eroq_sk_…` header (see https://eroq.ai/docs/authentication.md). Request and response shapes follow the OpenAI convention where one exists (`chat/completions`, `images/generations`, `audio/speech`). Image, video and music renders are asynchronous: the call answers `202` with a job to poll, or one your webhooks hear about when it lands.

## Chat

### Chat completions — https://eroq.ai/docs/chat.md

- `POST /v1/chat/completions` — Run a conversation turn against eroq RP+, RP or eroq RP mini

## Media

### Image generation — https://eroq.ai/docs/images.md

- `POST /v1/images/generations` — Generate an image from a text prompt

### Image · job status — https://eroq.ai/docs/image-status.md

- `GET /v1/images/generations/{id}` — Poll an async render until the image is ready

### Remove background — https://eroq.ai/docs/images-remove-background.md

- `POST /v1/images/remove-background` — Send a picture, get the subject back with a transparent background

### Upscale a picture — https://eroq.ai/docs/images-upscale.md

- `POST /v1/images/upscale` — The same picture, two or four times larger, its detail restored

### Video generation — https://eroq.ai/docs/video.md

- `POST /v1/videos/generations` — Start rendering a short clip

### Video · job status — https://eroq.ai/docs/video-status.md

- `GET /v1/videos/generations/{id}` — Poll an async render until the clip is ready

### Video · edit (Replace) — https://eroq.ai/docs/video-edits.md

- `POST /v1/videos/edits` — Put your characters in the place of the people in a clip you bring

### Video · edit people — https://eroq.ai/docs/video-edit-people.md

- `POST /v1/videos/edits/people` — Read the people in a frame of your clip, left to right

### Video · templates — https://eroq.ai/docs/video-templates.md

- `GET /v1/videos/templates` — List the Replace templates

### Video · assemble a template — https://eroq.ai/docs/video-edit-assemble.md

- `POST /v1/videos/edits/assemble` — Put the rendered shots of a several-shot template back into its clip

### Video · render queue — https://eroq.ai/docs/video-list.md

- `GET /v1/videos/generations` — List the workspace's render jobs of the last 24 hours

### Text-to-speech · voice changer — https://eroq.ai/docs/speech.md

- `POST /v1/audio/speech` — Synthesize speech from text

### Conversations — https://eroq.ai/docs/dialogue.md

- `POST /v1/audio/dialogue` — Several voices, one scene

### Music generation — https://eroq.ai/docs/music.md

- `POST /v1/music/generations` — Start a song
- `GET /v1/music/generations/{id}` — Poll one take until the MP3 is ready
- `GET /v1/music/generations` — List the workspace's song takes of the last 24 hours, newest first

### Transcription — https://eroq.ai/docs/transcriptions.md

- `POST /v1/audio/transcriptions` — Transcribe an audio file to text

### Live calls — https://eroq.ai/docs/live.md

- `POST /v1/live/sessions` — Open a call with a character
- `POST /v1/live/sessions/{id}/offer` — Send the browser's WebRTC offer
- `GET /v1/live/sessions/{id}` — The call as it stands
- `POST /v1/live/sessions/{id}/extend` — Buy more time before the bought minutes run out
- `POST /v1/live/sessions/{id}/end` — Hang up

### Look sheets — https://eroq.ai/docs/sheets.md

- `POST /v1/sheets` — Generate a look sheet
- `POST /v1/sheets/apply` — Accept a finished render as the subject's active sheet

## Storage

### Storage · upload — https://eroq.ai/docs/storage.md

- `POST /v1/storage/objects` — Upload a file to the eroq Store and get a CDN URL back

### Storage · list — https://eroq.ai/docs/storage-list.md

- `GET /v1/storage/objects` — List the account's stored objects, newest first

### Storage · delete — https://eroq.ai/docs/storage-delete.md

- `DELETE /v1/storage/objects/{id}` — Delete a stored object from the CDN

## Platform

### Storage — https://eroq.ai/docs/uploads.md

- `GET /v1/uploads` — List every reference
- `POST /v1/uploads` — Upload a reference file
- `PATCH /v1/uploads/{id}` — Rename and/or move a file
- `DELETE /v1/uploads/{id}` — Remove a file from the bucket
- `PATCH /v1/uploads/folders/{name}` — Rename a folder
- `DELETE /v1/uploads/folders/{name}` — Delete a folder and everything in it
- `POST /v1/uploads/link` — Bring a public TikTok, Instagram Reel or YouTube Short into Storage
- `GET /v1/uploads/link/{id}` — A link still being read

### Elements — https://eroq.ai/docs/elements.md

- `GET /v1/elements` — List your elements
- `POST /v1/elements` — Create an element
- `GET /v1/elements/{id}` — One element with its reference-photo pool and sheet
- `PATCH /v1/elements/{id}` — Update name, description or photo
- `DELETE /v1/elements/{id}` — Remove an element

### Characters — https://eroq.ai/docs/characters.md

- `GET /v1/characters` — List your characters with their reference photos
- `POST /v1/characters` — Create a character
- `GET /v1/characters/{id}` — One character, reference photos included
- `PATCH /v1/characters/{id}` — Update any field
- `DELETE /v1/characters/{id}` — Remove the character

### GPU machines — https://eroq.ai/docs/gpu.md

- `GET /v1/gpu/types` — The GPUs, their price per hour, the task kinds and the one-click recipes
- `POST /v1/gpu/machines` — Launch a machine
- `GET /v1/gpu/machines` — Your machines, newest first
- `GET /v1/gpu/machines/{id}` — One machine, its meter and its tasks
- `POST /v1/gpu/machines/{id}/runs` — Send a task
- `GET /v1/gpu/machines/{id}/runs/{run}` — A task, its log, what Blender saw and its files
- `POST /v1/gpu/machines/{id}/runs/{run}/cancel` — Cancel a waiting or running task
- `POST /v1/gpu/machines/{id}/files` — A presigned upload for a file the machine will use
- `POST /v1/gpu/machines/{id}/stop` — Stop the machine

### Voices — https://eroq.ai/docs/voices.md

- `GET /v1/voices` — List the roster and your clones
- `POST /v1/voices` — Clone a voice from audio samples
- `DELETE /v1/voices/{id}` — Delete a clone
- `GET /v1/voices/public` — The public voice catalog
- `POST /v1/voices/{id}/publish` — Submit one of your cloned voices to the public catalog
- `DELETE /v1/voices/{id}/publish` — Take your voice out of the catalog
- `POST /v1/voices/{id}/like` — Like a public voice
- `DELETE /v1/voices/{id}/like` — Take a like back
- `POST /v1/voices/{id}/report` — Report a public voice

### Films — https://eroq.ai/docs/films.md

- `GET /v1/films` — List your film drafts
- `POST /v1/films` — Create a draft
- `GET /v1/films/{id}` — One film, full recipe
- `PATCH /v1/films/{id}` — Update title and/or data
- `DELETE /v1/films/{id}` — Delete the draft
- `POST /v1/films/media` — Fresh signed URLs for media keys
- `POST /v1/films/{id}/export` — Save the rendered cut
- `POST /v1/films/{id}/render` — Shoot the whole storyboard
- `POST /v1/films/{id}/cover` — Set the film's cover
- `POST /v1/films/{id}/publish` — Submit the film to the community
- `DELETE /v1/films/{id}/publish` — Take the film off the community shelf

### Flows — https://eroq.ai/docs/flows.md

- `GET /v1/flows` — List the workspace's flows
- `POST /v1/flows` — Create a flow from a graph, a template, or blank, starting with the tr…
- `GET /v1/flows/{id}` — One flow
- `PATCH /v1/flows/{id}` — Rename it, replace its graph, publish it or take it back to a draft
- `DELETE /v1/flows/{id}` — Delete the flow and its runs
- `POST /v1/flows/{id}/runs` — Run it now
- `GET /v1/flows/{id}/runs` — The flow's runs, newest first
- `GET /v1/flows/{id}/runs/{run_id}` — Where a run stands, step by step
- `POST /v1/flows/{id}/runs/{run_id}/stop` — Stop a run

### Creations library — https://eroq.ai/docs/creations.md

- `GET /v1/creations` — List your renders with folders and recipes
- `GET /v1/creations/{id}` — One creation, full meta
- `PATCH /v1/creations/{id}` — Move it between folders
- `DELETE /v1/creations/{id}` — Delete the creation and its file
- `POST /v1/creations/{id}/publish` — Submit to the community shelf
- `DELETE /v1/creations/{id}/publish` — Remove it from the community
- `POST /v1/creations/{id}/thumbnail` — Set the cover of a video/voice
- `POST /v1/creations/{id}/feedback` — Report a render that came out wrong
- `GET /v1/folders` — List your folders
- `POST /v1/folders` — Create a folder
- `PATCH /v1/folders/{id}` — Rename a folder
- `DELETE /v1/folders/{id}` — Delete a folder
- `POST /v1/folders/{id}/lock` — Lock a folder with a 4-digit PIN
- `POST /v1/folders/{id}/unlock` — Type a locked folder's PIN
- `DELETE /v1/folders/{id}/lock` — Remove a folder's PIN, with the PIN
- `POST /v1/library/lock` — Lock your whole Library with a 4-digit PIN
- `POST /v1/library/unlock` — Type your Library's PIN
- `DELETE /v1/library/lock` — Remove your Library's PIN, with the PIN
- `POST /v1/library/recover` — A forgotten Library PIN
- `POST /v1/folders/{id}/share` — Share a folder publicly
- `DELETE /v1/folders/{id}/share` — Stop sharing

### Prompt enhance — https://eroq.ai/docs/enhance.md

- `POST /v1/prompts/enhance` — Rewrite or invent a prompt

### Prompt dictation — https://eroq.ai/docs/dictate.md

- `POST /v1/prompts/dictate` — Speak a prompt, get the text back

### Engine capabilities — https://eroq.ai/docs/engines.md

- `GET /v1/engines` — Which models are live here, and what each can serve

### List models — https://eroq.ai/docs/models.md

- `GET /v1/models` — The model catalogue with credit pricing

### Webhooks — https://eroq.ai/docs/webhooks.md

- `GET /v1/webhooks` — The workspace's endpoints and subscriptions, newest first
- `POST /v1/webhooks` — Subscribe an endpoint
- `DELETE /v1/webhooks/{id}` — Unsubscribe
- `GET /v1/webhooks/samples` — Up to 3 recent events of a type, exactly as an endpoint would have rec…

### Account — https://eroq.ai/docs/account.md

- `GET /v1/account` — Balance, usage totals and workspace of the calling key


---
Canonical: https://eroq.ai/docs/api-reference · Index for agents: https://eroq.ai/llms.txt · OpenAPI: https://eroq.ai/openapi.json
