Skip to main content
Version: v2

Photo Pilot (image edit)

POST 
/v2/studio/artworks/photo-pilot

Start a photo-pilot generation. Billed to your Studio credits. The result arrives by webhook or polling.

Request​

Body

required

    prompt string

    Default value: cat

    Limited to 256 words; additional content will be truncated.

    negativePrompt string

    Limited to 64 words; additional content will be truncated.

    imageGuidance numberrequired

    Possible values: [1, 2, 3]

    When image guidance is set to low, size of image can be set as a parameter; otherwise the input image size is taken as reference.

    modification numberrequired

    Possible values: [1, 2, 3, 4, 5]

    creativity numberrequired

    Possible values: [1, 2, 3, 4, 5]

    effort numberrequired

    Possible values: [1, 2, 3, 4, 5]

    aspectRatio string

    Possible values: [1:1, 2:3, 3:4, 4:3, 9:16, 3:2, 16:9]

    Has effect only if imageGuidance is set to LOW. Cannot be used together with width and height — provide only aspectRatio or explicit size.

    highResolution boolean

    Toggle high resolution size of supported aspect ratios.

    width number

    Possible values: >= 256 and <= 2048

    Custom width. Use aspectRatio instead for better quality. Only honored when imageGuidance is LOW. When LOW, width × height must not exceed 1,478,656 pixels (e.g., 1216 × 1216), or 1,763,584 pixels (e.g., 1328 × 1328) when highResolution is true.

    height number

    Possible values: >= 256 and <= 2048

    Custom height. Use aspectRatio instead for better quality. Only honored when imageGuidance is LOW. When LOW, width × height must not exceed 1,478,656 pixels (e.g., 1216 × 1216), or 1,763,584 pixels (e.g., 1328 × 1328) when highResolution is true.

    imageUrls uri[]required

    Possible values: >= 1, <= 3

    Source image URLs for img2img. 1-3 entries; the first image's dimensions are used when imageGuidance is HIGH.

    seed integer

    Possible values: >= 1 and <= 2147483647

    Optional random seed for deterministic generation. Range: 1-2147483647.

    outputFormat string

    Possible values: [auto, png, webp]

    Default value: auto

    Output image format. auto lets the provider pick. Supported: auto, png, webp.

    webhook uri

    Optional HTTPS callback URL. Receives a signed delivery when the artwork finalizes.

Responses​

Accepted — generation queued.

Schema

    id string

    Artwork id. Poll GET /studio/artworks/{id} or await the webhook.

Loading...