X Image Splitter logoX Image Splitter
X Image Splitter logoX Image Splitter

Developers

Read a generation

GET
/generations/{creationId}

The status of one of the caller’s generations and, once succeeded, its outputs with a splitterLinks URL per image that opens it in the Image Splitter.

Authorization

headerAuthorizationBearer <token>

An API Key the User creates in account settings, sent as Authorization: Bearer <key>. It holds the Scopes chosen at creation.

Path Parameters

creationId*string
Length1 <= length

Response Body

Success.

application/json
  1. response
creationId*string
status*string
Value in"generating""succeeded""failed"
mediaType*string
Value in"image""video""audio""music"
operation*string
Value in"text-to-image""image-to-image""text-to-video""image-to-video""video-to-video""text-to-audio""text-to-music"
modelKey*string
Value in"nano-banana-2""nano-banana-2-lite""nano-banana-pro""nano-banana""seedream-5-0-lite""seedream-4-5""seedance-2""seedance-2-fast""seedance-1-5-pro""kling-3-0""veo-3-1""seed-audio-1-0""elevenlabs-tts-multilingual-v2""elevenlabs-tts-turbo-2-5""suno-music-v6""minimax-h3""seedream-5-5"
modelFamily*string
prompt*string
negativePrompt*string|null
optionValues*
inputAssets?array<>
outputAssets?array<>
primaryOutput*|null
aspectRatio*string|null
durationSeconds*number|null
resolution*string|null
recreatable*boolean
createdAt*string
isReadyForPreview*boolean
shared*boolean
originalPrompt*string|null
splitterLinks*array<>
Example request
curl -X GET 'https://ximagesplitter.com/api/v1/generations/string'
Example response
{
  "creationId": "string",
  "status": "generating",
  "mediaType": "image",
  "operation": "text-to-image",
  "modelKey": "nano-banana-2",
  "modelFamily": "string",
  "prompt": "string",
  "negativePrompt": "string",
  "optionValues": {
    "property1": "string",
    "property2": "string"
  },
  "inputAssets": [
    {
      "id": "string",
      "slotId": "string",
      "type": "image",
      "role": "source",
      "url": "http://example.com",
      "mimeType": "string",
      "fileName": "string",
      "sizeBytes": 0,
      "width": 1,
      "height": 1,
      "durationSeconds": 1,
      "referenceName": "string"
    }
  ],
  "outputAssets": [
    {
      "id": "string",
      "type": "image",
      "url": "http://example.com",
      "isPrimary": true,
      "posterUrl": "http://example.com",
      "mimeType": "string",
      "sizeBytes": 0,
      "width": 0,
      "height": 0,
      "durationSeconds": 0,
      "hasAudio": true,
      "storageKey": "string"
    }
  ],
  "primaryOutput": {
    "id": "string",
    "type": "image",
    "url": "http://example.com",
    "isPrimary": true,
    "posterUrl": "http://example.com",
    "mimeType": "string",
    "sizeBytes": 0,
    "width": 0,
    "height": 0,
    "durationSeconds": 0,
    "hasAudio": true,
    "storageKey": "string"
  },
  "aspectRatio": "string",
  "durationSeconds": 0,
  "resolution": "string",
  "recreatable": true,
  "createdAt": "string",
  "isReadyForPreview": true,
  "shared": true,
  "originalPrompt": "string",
  "splitterLinks": [
    {
      "output": 0,
      "url": "http://example.com"
    }
  ]
}