Flat Lays Workflow¶

Sequence Diagram

sequenceDiagram
    autonumber

    participant BE as Your<br>Backend
    participant API as Aiuta<br>API

    loop
        BE->>API: Upload an image (bytes)
        API-->>BE: Return Response (id, url)
    end

    BE->>API: Generate operation (uploaded_product_image_ids, prodict info)
    API-->>BE: Return Response (operation_id)

    loop
        BE->>API: Get operation (operation_id)
        API-->>BE: Return Operation object
        BE->>BE: Check status<br>operation field

        critical status
            option SUCCESS
                Note right of BE: generated_images field<br>with url in resulting object
            option FAILED
                rect
                    Note right of BE: error field<br>contains error message
                end
        end
    end

1. Upload input images¶

Upload images of your product for which you want to generate a Flat Lay. For each uploaded image, you will receive an object containing the image id and 'url'. Use these ids in the next step to specify input images for Flat Lay generation.

Try uploading an image

2. Create a generation operation request¶

Provide uploaded_product_image_ids received in the previous step, along with some basic product information: product_category, product_title, and product_description. You will receive an object containing the operation_id of the created Flat Lay generation operation if the request is successful, or an error message otherwise.

Try creating a generation operation request

3. Get the operation results¶

Use the operation_id from the previous step to retrieve the status of the operation. The operation is considered complete when its status becomes SUCCESS or FAILED. If the operation completes successfully, the response will contain the generated image URL(s). If an error occurred, the error field will contain details.

Try getting the operation results