Inpainting

POST/api/v1/nova/button

After a successful upscale (U1, U2, U3, U4). You have the option to use the Vary (Region) button to redraw a section of your image; also known as Inpainting.

You can use this tool to generate the mask and retrieve its base64 encoded string.

If you are making mask by yourself, please make sure it uses background in black, and white color for selected zone.

Request

Authorization: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

messageId

string

required

The unique identify from your previous upscale request.

button

enum<string>

required

The button action.

Allowed value:

Vary (Region)

Default:

Vary (Region)

Example:

Vary (Region)

mask

string

required

The mask is a base64 encoded string of the region you want to inpaint.

prompt

string

optional

You can optionally pass prompt in your command - which can be used useful for the inpainting area.

ref

string

optional

The reference metadata which will return as part of the webhook.

webhookOverride

string

optional

The webhook URL which the response will send to, the payload of this webhook is same as our Message endpoint.

{
  "messageId": "e57fb09d-25f0-49f7-8f0f-2e902ffe9fdd",
  "mask": "UklGRiQAAABXRUJQVlA4WAoAAAAQABAJAAABKAAATAwAAABAAEAAAAAAABIAAAAAQAAAEgAAA...",
  "prompt": "A little cat running on the grass",
  "button": "Vary (Region)"
}

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

success

boolean

required

The status of the request.

messageId

string

required

The messageId of the request, which will be used for querying the progress, sending subsequential actions later, etc.

createdAt

string

required

The timestamp of the job creation.

error

string

optional

The error message, if any

{
  "success": true,
  "messageId": "d15c1541-229a-442b-9873-d3494dede12a",
  "createdAt": "2023-08-01T14:03:01.817Z"
}

Last modified: 1 个月前