VIvisoid

Render an image using Explore tool

This operation costs 3 credits for 1K, 5 credits for 2K, and 10 credits for 4K (controlled by the quality parameter).

It is possible to pass a Base64 image mask (input.mask) to select only parts of the image that should be changed.

post/images/{imageId}/render/explore

Request

  • Base URL
    https://app.visoid.com/api/v1
  • Auth
    none declared

Path parameters

imageIdstring uuid required

Image ID

Request body

callbackUrlstring uri

URL called when task is finished. Endpoint will be called using POST method with a body containing:

  • imageId the rendered image
  • sourceImageId the original image from which the rendering was made
  • status the state of the operation, could be completed or failed
quality'1K' | '2K' | '4K'

Resolution of the rendered image. Costs 3 credits for 1K, 5 credits for 2K, and 10 credits for 4K.

style'realistic' | 'vector-sketch' | 'vector-illustration' | 'watercolor-sketch' | 'watercolor-collage' | 'highlighted-sketch' | 'pastel-concept' | 'post-digital-collage' | 'ink-sketch'

Visual style applied to the render.

Example request

{
  "input": {
    "mask": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
  }
}

Response

Rendering task started

idstring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.