Appearance
2D Image Generation
Text-to-image, Sketch-to-image, and Image edit are available now. Spritesheet is coming soon (marked below) and its request contract may change before release.
See Generation styles for the list of built-in genStyleId values.
Text-to-image
Available
This endpoint is live for public API keys.
POST /jobs/text-to-image
Content-Type: application/json| Field | Type | Required | Default | Notes |
|---|---|---|---|---|
prompt | string | yes | - | Up to 4096 characters. |
aspectRatio | "1:1" | "4:3" | "3:4" | "3:2" | "2:3" | "16:9" | "9:16" | no | "1:1" | Shape of the generated image. Any value other than "1:1" produces a non-square image. |
genStyleId | string | no | "Auto" | A generation style ID. See Generation styles. |
referenceImageJobId | string | no | - | ID of a successful, owned image upload to use as an identity reference. |
tPose | boolean | no | false | Generate the subject in a neutral T-pose. |
apiVersion | integer | no | 1 | Only 1 exists today. |
Spritesheet
Coming soon
Not yet enabled for public API keys. The request contract may change before release.
POST /jobs/spritesheet
Content-Type: application/jsonAccepts the text-to-image fields above plus a required spritesheet object.
| Field | Type | Required | Notes |
|---|---|---|---|
spritesheet.assetKind | "background" | "character" | "effect" | "prop" | "ui" | yes | Kind of asset represented. |
spritesheet.mode | "animated" | "background" | "static" | yes | Spritesheet mode. |
spritesheet.frameCount | 1 | 12 | 16 | yes | Must be 12 or 16 in animated mode and 1 otherwise. |
spritesheet.animation | "attack" | "block" | "cast" | "climb" | "death" | "dodge" | "hurt" | "idle" | "interact" | "jump" | "run" | "still" | "walk" | no | Animation performed by the subject. |
spritesheet.direction | "back" | "back-left" | "back-right" | "front" | "front-left" | "front-right" | "left" | "right" | no | Direction the subject faces or moves. |
Sketch-to-image
Available
This endpoint is live for public API keys.
POST /jobs/sketch-to-image
Content-Type: multipart/form-data| Field | Type | Required | Notes |
|---|---|---|---|
file | image file | yes | PNG/JPEG etc. Max 20MB. |
sketchData | string | yes | Serialized sketch metadata used to guide generation. |
genStyleId | string | yes | A generation style ID. |
Image edit
Available
This endpoint is live for public API keys.
POST /jobs/image-edit
Content-Type: application/json| Field | Type | Required | Default | Notes |
|---|---|---|---|---|
jobId | string | yes | - | Source job whose image will be edited. |
prompt | string | no | - | Instructions for the edit. |
genStyleId | string | no | - | A generation style ID. |
references | object[] | no | - | Reference images. Each item contains url and kind. |
references[].url | string | yes | - | Reference image URL. |
references[].kind | "base" | "pose" | "style" | yes | Role played by the reference. | |
userPrompt | string | no | - | Original user-entered prompt before preset augmentation. |
quickFixPresets | string | no | - | Applied preset names or IDs. |
apiVersion | integer | no | 1 | Only 1 exists today. |