Sign in
OpenAPI 3.1.02026-08-143781,4501.9 MB

3b2cee2701a3

Flows
Image

Create Image Generation

Start an image generation with the selected model.

post/v1/flows/image

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "webhook": {
    "ids": [
      "Q8mVr2LpXcT4nB6yJdKw"
    ]
  },
  "prompt": "A corgi in a tiny lifeguard chair on a sunlit beach at golden hour, photorealistic",
  "images": [
    {
      "generation_id": "JWr5N6X9ZTqf8jD2LmQb"
    }
  ],
  "mask": {
    "generation_id": "JWr5N6X9ZTqf8jD2LmQb"
  }
}

Response

Successful Response

idstring required

The unique identifier of the generation. Pass it to the corresponding GET endpoint to retrieve the output.

status'pending' required

A newly created generation is always pending.

Example response

{
  "id": "JWr5N6X9ZTqf8jD2LmQb",
  "status": "pending"
}