Remix Image

Generates an AI image using the a remix image and a provided prompt.

This operation costs 1 credit.

Endpoint

POST api/remix/generate

Parameter	Type	Required	Description
model_id	string	Yes	Unique identifier of the model.
artwork_image	binary	Yes	Image to be used as artwork.
mask_image	binary	Yes	Image containing the mask.
prompt	string	No	Prompt to use. Defaults to "".
negative_prompt	string	No	Negative Prompt to use. Defaults to "".
mode	string	No	Options: "sync" or "async". Defaults to "sync".

Bearer

Bearer token authentication uses a token to access APIs. Include the token in your request header as Authorization: Bearer YOUR_SECRET_API_KEY to authenticate your requests.

Sync mode

The API's mode parameter can be sync or async. Sync mode provides immediate results and is easy to implement. Async mode allows the client to perform other tasks while waiting.

Request Example

curl -X POST "https://api.deepmode.ai/api/remix/generate" \
-H "Content-Type: multipart/form-data" \
-H "Authorization: Bearer YOUR_SECRET_API_KEY" \
-F "model_id": "b8a9f7e5d1c3a2f91e3d5" \
-F "artwork_image=@artwork.jpg" \
-F "mask_image=@mask.jpg" \
-F "prompt=cartoon, pixar, 3d animation" \
-F "negative_prompt=oversaturated, realistic, photo, deformed" \
-F "mode=sync"

Response

Upon successful generation, the API returns the following response:

{
  "id": "668f1a2bdb4c27d16052c82b",
  "file_name": "a62a9740-1600-44ab-8529-bff93922a4ed.jpeg",
  "status": "completed",
  "created_at": "2024-07-10T23:32:59.210000Z",
  "image_url": "https://deepmodeimage.blob.core.windows.net/face-id-remix-generation/a62a9740-1600-44ab-8529-bff93922a4ed.jpeg?st=2024-07-10T23%3A34%3A17Z&se=2024-07-11T00%3A34%3A17Z&sp=r&sv=2024-05-04&sr=b&sig=aJERtEIw64nX5Ehj5v3LSoHHARpm0t36LEyw4ypNzXc%3D"
}