APIリファレンス · Platform

Characters

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

GETPOSTPATCHDELETE/v1/charactersFree

A character is the reusable identity of your products: a persona sheet (folded into chat context and render prompts), reference photos (they feed the look-sheet generation), an accepted look sheet (sheetUrl — the canonical image the renderers condition on) and a voice. Reference one as char:<id> in any elements array, or as the voice of /v1/audio/speech. To put the character in an image or video render, it needs a sheet first (see /v1/sheets) — chatting needs none.

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 and its sheetUrl; 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.

エンドポイント

メソッドを選ぶと、そのリクエスト、プレイグラウンド、レスポンスが表示されます。

GET/v1/characters表示中

List your characters with their reference photos.

POST/v1/characters

Create a character.

namestring必須

Up to 80 characters.

genderstring

female (default), male or nonbinary.

promptstring

The persona sheet — folded into chat context and render prompts, up to 4000 characters.

descriptionstring

Short card description, up to 600 characters.

avatarUrlstring

Hosted portrait URL — drives image→video and face consistency.

ageinteger

18 or older — every character, no exceptions.

voiceIdstring

A roster voice id or one of your clone ids — makes the character speakable via char:<id>.

stylestring

Visual register (photoreal, anime, …) folded into renders.

GET/v1/characters/{id}

One character, reference photos included.

PATCH/v1/characters/{id}

Update any field.

DELETE/v1/characters/{id}

Remove the character — past renders are untouched.

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

/v1/characters通信なし

→ GET /v1/characters

「例を実行」を押すと、ドキュメント自身のデータから実際のやり取りを再生します。キーもリクエストも不要で、料金もかかりません。

レスポンス

200 · application/json

{
  "characters": [{
    "id": "9c1e…", "name": "Nova", "gender": "female",
    "prompt": "sardonic mechanic, quick wit…", "voiceId": "aria",
    "sheetUrl": "https://…", "sheetCreatedAt": "2026-09-20T…Z",
    "references": [{ "url": "https://…", "contentType": "image/webp" }]
  }]
}