API reference · Platform

Characters

Your cast: persona sheets, faces and voices, reusable everywhere.

GET/v1/charactersFree

A character is the reusable identity of your products: a persona sheet (folded into chat context and render prompts), reference photos (they drive image→video and hold the face across images) and a voice. Reference one as char:<id> in any elements array, or as the voice of /v1/audio/speech.

POST /v1/characters creates one (name, gender, prompt persona sheet, description, avatarUrl, age, voiceId, style); GET /v1/characters/{id} fetches one with its reference photos; PATCH /v1/characters/{id} updates any field; DELETE /v1/characters/{id} removes it. Reference photo UPLOADS stay in the studio for now — pass hosted URLs via avatarUrl meanwhile.

curl https://eroq.ai/v1/characters \
  -H "Authorization: Bearer $EROQ_API_KEY"

/v1/charactersno network

→ GET /v1/characters

Press run — this replays a real exchange from the docs' own data. No key, no request, no charge.

Response

200 · application/json

{
  "characters": [{
    "id": "9c1e…", "name": "Nova", "gender": "female",
    "prompt": "sardonic mechanic, quick wit…", "voiceId": "aria",
    "references": [{ "url": "https://…", "contentType": "image/webp" }]
  }]
}