Skip to main content
Version: V1 (deprecated)

Create Photo Pilot artwork

POST 
/v1/artworks/photo-pilot

Generate artwork using image-to-image conversion.

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 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 image Guidance is set to low. Can not be used at the same time with width and height provide only aspect ratio or image size.

    highResolution boolean

    Toggle high resolution size of supported aspect ratios

    width number

    Possible values: >= 512 and <= 2048

    Use aspectRatio instead of custom width and height for better quality. Only honored when imageGuidance is LOW; otherwise the source image's dimensions are used. When LOW, the total area (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: >= 512 and <= 2048

    Use aspectRatio instead of custom width and height for better quality. Only honored when imageGuidance is LOW; otherwise the source image's dimensions are used. When LOW, the total area (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.

    bucket string
    imageUrl stringrequired

    Source image URL for img2img.

    webhook uri

    Optional webhook URL. When provided, the server will POST the final artwork result to this URL upon completion.

Responses​

Response indicating that the artwork was successfully created.

Schema

    id uuidrequired
    artworkType stringrequired

    Possible values: [photo_pilot]

    parameters

    object

    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 number

    Possible values: [1, 2, 3]

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

    modification number

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

    creativity number

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

    effort number

    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 image Guidance is set to low. Can not be used at the same time with width and height provide only aspect ratio or image size.

    highResolution boolean

    Toggle high resolution size of supported aspect ratios

    width number

    Possible values: >= 512 and <= 2048

    Use aspectRatio instead of custom width and height for better quality. Only honored when imageGuidance is LOW; otherwise the source image's dimensions are used. When LOW, the total area (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: >= 512 and <= 2048

    Use aspectRatio instead of custom width and height for better quality. Only honored when imageGuidance is LOW; otherwise the source image's dimensions are used. When LOW, the total area (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.

    bucket string
    imageUrls uri[]

    Possible values: >= 1, <= 3

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

    webhook uri

    Optional webhook URL. When provided, the server will POST the final artwork result to this URL upon completion.

    duration numberrequired
    results string[]required
    status stringrequired

    Possible values: [starting, processing, succeeded, failed, canceled]

    createdAt date-timerequired
Loading...