Paint a show_image picture

POST

characters

{id}

image

curl --request POST \
  --url https://api.alakazam.gg/v1/characters/{id}/image \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "<string>",
  "prompt": "<string>"
}
'

{
  "src": "<string>",
  "generated": true
}

Authorizations

Authorization

string

header

required

The scoped runtime session JWT from POST /v1/sessions/token. The embed's browser presents it (Authorization: Bearer, or a token body field) to the runtime exchange routes. Not an API key.

Path Parameters

string<uuid>

required

Body

application/json

token

string

prompt

string

What to paint. Omit to get the base image.

Response

An image (data-URI when generated, the base image URL otherwise).

src

string

data:… URI or an image URL.

generated

boolean

Resume a relationship (welcome-back)Cross-session memory. Returns whether this player (the session token's identity) is RETURNING and a dynamic "welcome back" line that references your shared history. Mint the token with a stable playerIdentity per end-user for memory to work (the default "anon" is never persisted).

⌘I

Paint a show_image picture

curl --request POST \
  --url https://api.alakazam.gg/v1/characters/{id}/image \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "<string>",
  "prompt": "<string>"
}
'

{
  "src": "<string>",
  "generated": true
}