APIリファレンス · Platform

Elements

Your reusable references: places, props and styles.

GETPOSTPATCHDELETE/v1/elementsFree

Elements are reusable prompt references (up to 50 per account): a place, a prop or a visual style with a description the prompt-engineering layer folds into any render, and optional reference photos. Characters are referenced as char:<id> in elements arrays — they live on their own endpoints in the studio.

POST /v1/elements creates one (kind location|object|style, name, description, optional imageUrl); GET /v1/elements/{id} fetches one with its reference-photo pool and its sheetUrl; PATCH /v1/elements/{id} updates it; DELETE /v1/elements/{id} removes it. Pass their ids in the elements array of chat, image and video generations. A location or object you want to render must carry an accepted look sheet (see /v1/sheets) — a style is description-only and never sheeted.

エンドポイント

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

GET/v1/elements表示中

List your elements (places, props, styles — each with its sheetUrl).

POST/v1/elements

Create an element.

kindstring必須

location, object or style.

namestring必須

Display name, up to 60 characters — what @-mentions match.

descriptionstring

The prompt fragment folded into renders, up to 600 characters.

imageUrlstring

Optional reference photo URL — joins the engine references and the sheet pool.

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 — past renders are untouched.

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

/v1/elements通信なし

→ GET /v1/elements

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

レスポンス

200 · application/json

{
  "elements": [{
    "id": "0b6c…", "kind": "location", "name": "Rooftop bar",
    "description": "rooftop cocktail bar at dusk, string lights", "imageUrl": "", "sheetUrl": ""
  }]
}