Guia de migração da API V2 para V3

Texto para imagem

Mapeamento de parâmetros do corpo da solicitação

V2	V3	Descrição
extraobject	extraobject
enable_nsfw_detection boolean	enable_nsfw_detection boolean
nsfw_detection_level Enum: `0, 1, 2`	nsfw_detection_level Enum: `0, 1, 2`
enable_progress_info		Obsoleto
response_image_type Enum: `png`, `jpeg`	response_image_type Enum: `png, webp, jpeg`	V3 adiciona suporte ao formato de imagem `webp`
	requestobject	Novo campo Todos os parâmetros de geração de imagem devem ser passados via `request` no V3
promptstring <lora:$sd_name:$weight>	promptstring	Movido para dentro
	lorasobject[]	Movido para dentro Migrar o uso de LoRA: de `prompt` para o parâmetro `request.loras`
	model_namestring	Novo campo Nome do lora; recupere o valor sd_name_in_api correspondente invocando o endpoint Get Model API com filter.types=lora como parâmetro de consulta.
	strengthnumber(float32)	Novo campo O valor de força do lora. Quanto maior o valor, mais o efeito é direcionado para o lora. Intervalo [0, 1]
negative_promptstring	negative_promptstring	Movido para dentro
sampler_namestring	sampler_namestring	Movido para dentro
batch_sizeinteger	image_numinteger	Alterado `num_images` → `request.image_num`
n_iter		Obsoleto
stepsstring	stepsstring	Movido para dentro
cfg_scaleinteger	guidance_scale number(float32)	Alterado `cfg_scale`→ `request.guidance_scale`
seedinteger	seedinteger	Movido para dentro
heightinteger	heightinteger	Movido para dentro Alteração de intervalo: [128, 2048].
widthinteger	widthinteger	Movido para dentro Alteração de intervalo: [128, 2048].
model_namestring	model_namestring	Movido para dentro Este parâmetro especifica o nome do checkpoint do modelo. Recupere o valor sd_name correspondente invocando a API Query Model com filter.types=checkpoint como parâmetro de consulta.
restore_facesbool	restore_facesbool	Movido para dentro
restore_faces_model		Obsoleto
sd_vaestring	sd_vaestring	Movido para dentro
clip_skipinteger	clip_skipinteger	Movido para dentro
enable_hrboolean	hires_fixobject	Alterado `enable_hr`→ `request.hires_fix`
hr_upscaler Enum: `Latent`, `ESRGAN_4x`, `R-ESRGAN 4x+`, `R-ESRGAN 4x+ Anime6B`	upscaler Enum: `RealESRGAN_x4plus_anime_6B`, `RealESRNet_x4plus,Latent`	Alterado `hr_upscaler`→`request.hires_fix.upscaler`
hr_scalenumber		Obsoleto
hr_resize_xinteger	target_widthinteger	Alterado `hr_resize_x`→ `request.hires_fix.target_width`
hr_resize_yinteger	target_heightinteger	Alterado `hr_resize_y`→ `request.hires_fix.target_height`
img_expire_ttlinteger		Obsoleto Padrão 3600s
sd_refinerobject	refinerobject	Alterado `sd_refiner`→ `request.refiner`
checkpointstring		Obsoleto
switch_at number(float32)	switch_at number(float32)	Alterado `sd_refiner.switch_at`→ `request.refiner.switch_at`
controlnet_unitsobject[]		Obsoleto Somente `img2img`

Mapeamento de parâmetros de resposta

V2	V3	Descrição
code		Obsoleto
msg		Obsoleto
data		Obsoleto
task_id	task_id	Alterado `data.task_id`→ `task_id`
warn		Obsoleto

Exemplo

Texto para imagem V2

Solicitação

curl --location "https://api.novita.ai/v2/txt2img" \
--header "Authorization: Bearer {{API Key}}" \
--header "Content-Type: application/json" \
--data '{
  "extra": {
    "enable_nsfw_detection": false,
    "nsfw_detection_level": 0,
    "response_image_type": "jpeg"
  },
  "prompt": "(masterpiece, best quality, ultra-detailed:1.3), <lora:AnimeStyle_XL_v1_AutoRunMech_103883:0.8>, 1girl, mecha armor, futuristic city background, glowing neon lights, dynamic pose, cyberpunk style, intricate mechanical details, (floating holographic interface:1.2), sparkling blue eyes, wind-blown hair, (steam and energy particles:1.1), cinematic lighting",
  "negative_prompt":"(worst quality, low quality:1.4), (deformed, distorted:1.3), disfigured, blurry, bad anatomy, extra limbs, (mutated hands:1.2), (text, watermark:1.5), 
overexposed, underexposed, (cartoonish:1.2), (simplistic background:1.3), 
grainy, (traditional drawing:1.2), (realistic:1.4), (noisy:1.3)",
  "sampler_name":"DPM++ 2M Karras",
  "batch_size": 1,
  "n_iter": 1,
  "steps": 25,
  "cfg_scale": 7,
  "seed": 65531,
  "height": 512,
  "width": 512,
  "model_name": "sd_xl_base_1.0.safetensors",
  "restore_faces": false,
  "restore_faces_model": "",
  "sd_vae": "",
  "clip_skip": 1,
  "enable_hr": true,
  "hr_upscaler": "Latent",
  "hr_scale": 2,
  "hr_resize_x": 1024,
  "hr_resize_y": 1024,
  "img_expire_ttl": 3600
}'

Resposta

{
  "code": 0,
  "msg": "",
  "data": {
    "task_id": "12905b6a-d436-4010-b199-d800130c0aab"
  }
}

Texto para imagem V3

Solicitação

curl --location 'https://api.novita.ai/v3/async/txt2img' \
--header 'Authorization: Bearer {{API Key}}' \
--header 'Content-Type: application/json' \
--data '{
    "extra": {
        "enable_nsfw_detection": false,
        "nsfw_detection_level": 0,
        "response_image_type": "jpeg"
    },
    "request": {
      "prompt": "(masterpiece, best quality, ultra-detailed:1.3), 1girl, mecha armor, futuristic city background, glowing neon lights, dynamic pose, cyberpunk style, intricate mechanical details,(floating holographic interface:1.2), sparkling blue eyes, wind-blown hair, (steam and energy particles:1.1), cinematic lighting",
      "negative_prompt": "(worst quality, low quality:1.4), (deformed, distorted:1.3), disfigured,blurry, bad anatomy, extra limbs, (mutated hands:1.2), (text, watermark:1.5),overexposed, underexposed,(cartoonish:1.2), (simplistic background:1.3), grainy, (traditional drawing:1.2),(realistic:1.4), (noisy:1.3)",
        "model_name": "sd_xl_base_1.0.safetensors",
        "width": 512,
        "height": 512,
        "image_num": 1,
        "steps": 25,
        "seed": 65531,
        "restore_faces": false,
        "clip_skip": 1,
        "sampler_name":"DPM++ 2M Karras",
        "guidance_scale": 7,
        "hires_fix": {
            "target_width": 1024,
            "target_height": 1024,
            "strength": 0.8,
            "upscaler": "Latent"
        },
        "loras": [
          {
            "model_name": "AnimeStyle_XL_v1_AutoRunMech_103883",
            "strength": 0.8
          }
        ]
    }
}'

Resposta

{
  "task_id":"0696ce57-22df-4a89-9efc-80c386a82dbd"
}

Imagem para imagem

Mapeamento de parâmetros do corpo da solicitação

V2	V3	Descrição
extraobject	extraobject
enable_nsfw_detection boolean	enable_nsfw_detection boolean
nsfw_detection_level Enum: `0, 1, 2`	nsfw_detection_level Enum: `0, 1, 2`
enable_progress_info		Obsoleto
response_image_type Enum: `png`, `jpeg`	response_image_type Enum: `png, webp, jpeg`	V3 adiciona suporte ao formato de imagem `webp`
	requestobject	Novo campo Todos os parâmetros de geração de imagem devem ser passados via `request` no V3
promptstring <lora:$sd_name:$weight>	promptstring	Movido para dentro
	lorasobject[]	Movido para dentro Migrar o uso de LoRA: de `prompt` para o parâmetro `request.loras`
	model_namestring	Novo campo Nome do lora; recupere o valor sd_name_in_api correspondente invocando o endpoint Get Model API com filter.types=lora como parâmetro de consulta.
	strength number(float32)	Novo campo O valor de força do lora. Quanto maior o valor, mais o efeito é direcionado para o lora. Intervalo [0, 1]
negative_promptstring	negative_prompt string	Movido para dentro
sampler_namestring	sampler_namestring	Movido para dentro
batch_sizeinteger	image_numinteger	Alterado `batch_size`→ `request.image_num`
n_iterinteger		Obsoleto
stepsstring	stepsstring	Movido para dentro
cfg_scaleinteger	guidance_scale number(float32)	Alterado `cfg_scale`→ `request.guidance_scale`
seedinteger	seedinteger	Movido para dentro
heightinteger	heightinteger	Movido para dentro Alteração de intervalo: [128, 2048].
widthinteger	widthinteger	Movido para dentro Alteração de intervalo: [128, 2048].
model_namestring	model_namestring	Movido para dentro Este parâmetro especifica o nome do checkpoint do modelo. Recupere o valor sd_name correspondente invocando a API Query Model com filter.types=checkpoint como parâmetro de consulta.
init_imagesstring[]	image_base64string	Alterado `init_images`→ `request.image_base64`
denoising_strength number(float)	strength number(float)	Alterado `denoising_strength`→ `request.strength`
restore_facesbool		Obsoleto
sd_vaestring	sd_vaestring	Movido para dentro
clip_skipinteger	clip_skipinteger	Movido para dentro
maskstring		Obsoleto Recomendação: use a API V3 Inpainting
mask_blurinteger		Obsoleto Recomendação: use a API V3 Inpainting
resize_modeinteger		Obsoleto
image_cfg_scaleinteger		Obsoleto
inpainting_fillinteger		Obsoleto Recomendação: use a API V3 Inpainting
inpaint_full_resinteger		Obsoleto Recomendação: use a API V3 Inpainting
inpaint_full_res_padding integer		Obsoleto Recomendação: use a API V3 Inpainting
inpainting_mask_invert integer		Obsoleto Recomendação: use a API V3 Inpainting
initial_noise_multiplier number(float32)		Obsoleto
img_expire_ttlinteger		Obsoleto Padrão 3600s
sd_refinerobject	refinerobject	Alterado `sd_refiner`→ `request.refiner`
checkpoint		Obsoleto
switch_at number(float32)	switch_at number(float32)	Movido para dentro
	controlnetobject	Novo campo
controlnet_unitsobject[]	unitsobject[]	Alterado `controlnet_units`→ `request.controlnet.units`
modelstring	model_name string	Alterado `controlnet_units.model`→ `request.controlnet.units.model_name`
weightnumber	strength number(float32)	Alterado `controlnet_units.weight`→ `request.controlnet.units.strength`
input_imagestring	image_base64 string	Alterado `controlnet_units.input_image`→ `request.controlnet.units.image_base64`
modulestring,Enum	preprocessor string,Enum	Alterado `controlnet_units.module`→ `request.controlnet.units.preprocessor`
control_mode		Obsoleto
mask		Obsoleto Recomendação: use a API V3 Inpainting
resize_mode		Obsoleto
processor_res		Obsoleto
threshold_a		Obsoleto
threshold_b		Obsoleto
guidance_start number(float32)	guidance_start number(float32)	Movido para dentro
guidance_end number(float32)	guidance_end number(float32)	Movido para dentro
pixel_perfect		Obsoleto

Mapeamento de parâmetros de resposta

V2	V3	Descrição
code		Obsoleto
msg		Obsoleto
data		Obsoleto
task_id	task_id	Alterado `data.task_id`→ `task_id`
warn		Obsoleto

Exemplo

Imagem para imagem V2

Solicitação

curl --request POST \
  --url https://api.novita.ai/v2/img2img \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "extra": {
    "enable_nsfw_detection": false,
    "nsfw_detection_level": 0,
    "response_image_type": "png"
  },
  "prompt": "realistic, photograph, (masterpiece), 8k quality, (detailed eyes:1.2), (highest quality:1.1), highly detailed, majestic, top quality, best quality, newest, ai-generated, (intricate details:1.1), extremely beautiful, elegant, majestic, immersive background+, (detailed face, perfect face), In the heart of a vibrant garden, a girl with red hair and brown eyes sits in contemplation of the nature around her.",
  "negative_prompt": "(worst quality:1.5), (low quality:1.5), (normal quality:1.5), anime, cartoon, painting, drawing, illustration, manga, sketch, nudity, young, child, hairband, headband, horns, lowres, bad anatomy, bad hands, multiple eyebrow, (cropped), extra limb, missing limbs, deformed hands, long neck, long body, long torso, (bad hands), signature, username, artist name, conjoined fingers, deformed fingers, ugly eyes, imperfect eyes, skewed eyes, unnatural face, unnatural body, error, grain, jpeg artifacts",
  "sampler_name":"DPM++ 2M Karras",
  "batch_size": 1,
  "n_iter": 1,
  "steps": 25,
  "cfg_scale": 7.5,
  "seed": 765824,
  "height": 768,
  "width": 512,
  "model_name": "cyberrealistic_v31_62396.safetensors",
  "init_images": [
    "<IMAGE_BASE64>"
  ],
  "denoising_strength": 0.8,
  "restore_faces": false,
  "clip_skip": 1,
  "img_expire_ttl": 3600,
  "controlnet_units": {
    "model": "control_v11p_sd15_lineart",
    "weight": 1,
    "input_image": "<IMAGE_BASE64>",
    "module": "lineart",
    "guidance_start": 0,
    "guidance_end": 1
  }
}'

Resposta

{
  "code": 0,
  "msg": "",
  "data": {
    "task_id": "a1b0d99b-2ef0-4b20-8eeb-c641ae84ed45"
  }
}

Imagem para imagem V3

Solicitação

curl --request POST \
  --url https://api.novita.ai/v3/async/img2img \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '{
  "extra": {
    "enable_nsfw_detection": false,
    "nsfw_detection_level": 0,
    "response_image_type": "png"
  },
  "request": {
    "prompt": "realistic, photograph, (masterpiece), 8k quality, (detailed eyes:1.2), (highest quality:1.1), highly detailed, majestic, top quality, best quality, newest, ai-generated, (intricate details:1.1), extremely beautiful, elegant, majestic, immersive background+, (detailed face, perfect face), In the heart of a vibrant garden, a girl with red hair and brown eyes sits in contemplation of the nature around her.",
    "negative_prompt": "(worst quality:1.5), (low quality:1.5), (normal quality:1.5), anime, cartoon, painting, drawing, illustration, manga, sketch, nudity, young, child, hairband, headband, horns, lowres, bad anatomy, bad hands, multiple eyebrow, (cropped), extra limb, missing limbs, deformed hands, long neck, long body, long torso, (bad hands), signature, username, artist name, conjoined fingers, deformed fingers, ugly eyes, imperfect eyes, skewed eyes, unnatural face, unnatural body, error, grain, jpeg artifacts",
    "sampler_name": "DPM++ 2M Karras",
    "image_num": 1,
    "steps": 25,
    "guidance_scale": 7.5,
    "seed": 765824,
    "height": 768,
    "width": 512,
    "model_name": "cyberrealistic_v31_62396.safetensors",
        "image_base64": "<IMAGE_BASE64>",
    "strength": 0.8,
    "clip_skip": 1,
    "controlnet": {
      "units": [
        {
          "model_name": "control_v11p_sd15_lineart",
          "strength": 1,
          "image_base64": "<IMAGE_BASE64>",
          "preprocessor": "lineart",
          "guidance_start": 0,
          "guidance_end": 1
        }
      ]
    }
  }
}'

Resposta

{
  "task_id": "9490dde7-cd28-493e-9db0-8a38a65bf5e6"
}

Get started

Model APIs

Agent Sandbox

GPUs

Observability

Resources

Guia de migração da API V2 para V3

Texto para imagem

Mapeamento de parâmetros do corpo da solicitação

Mapeamento de parâmetros de resposta

Exemplo

Texto para imagem V2

Texto para imagem V3

Imagem para imagem

Mapeamento de parâmetros do corpo da solicitação

Mapeamento de parâmetros de resposta

Exemplo

Imagem para imagem V2

Imagem para imagem V3

​Texto para imagem

​Mapeamento de parâmetros do corpo da solicitação

​Mapeamento de parâmetros de resposta

​Exemplo

Texto para imagem V2

Texto para imagem V3

​Imagem para imagem

​Mapeamento de parâmetros do corpo da solicitação

​Mapeamento de parâmetros de resposta

​Exemplo

Imagem para imagem V2

Imagem para imagem V3

Texto para imagem

Mapeamento de parâmetros do corpo da solicitação

Mapeamento de parâmetros de resposta

Exemplo

Imagem para imagem

Mapeamento de parâmetros do corpo da solicitação

Mapeamento de parâmetros de resposta

Exemplo