Guide de migration de l’API V2 vers V3

Texte vers image

Mappage des paramètres du corps de requête

V2	V3	Description
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		Obsolète
response_image_type Enum: `png`, `jpeg`	response_image_type Enum: `png, webp, jpeg`	V3 ajoute la prise en charge du format d’image `webp`
	requestobject	Nouveau champ Tous les paramètres de génération d’image doivent être transmis via `request` dans V3
promptstring <lora:$sd_name:$weight>	promptstring	Déplacé à l’intérieur
	lorasobject[]	Déplacé à l’intérieur Migrer l’utilisation de LoRA : du paramètre `prompt` vers le paramètre `request.loras`
	model_namestring	Nouveau champ Nom de lora ; récupérez la valeur sd_name_in_api correspondante en appelant l’endpoint Get Model API avec filter.types=lora comme paramètre de requête.
	strengthnumber(float32)	Nouveau champ Valeur de force de lora. Plus la valeur est élevée, plus l’effet est orienté vers lora. Plage [0, 1]
negative_promptstring	negative_promptstring	Déplacé à l’intérieur
sampler_namestring	sampler_namestring	Déplacé à l’intérieur
batch_sizeinteger	image_numinteger	Modifié `num_images` → `request.image_num`
n_iter		Obsolète
stepsstring	stepsstring	Déplacé à l’intérieur
cfg_scaleinteger	guidance_scale number(float32)	Modifié `cfg_scale`→ `request.guidance_scale`
seedinteger	seedinteger	Déplacé à l’intérieur
heightinteger	heightinteger	Déplacé à l’intérieur Changement de plage : [128, 2048].
widthinteger	widthinteger	Déplacé à l’intérieur Changement de plage : [128, 2048].
model_namestring	model_namestring	Déplacé à l’intérieur Ce paramètre spécifie le nom du point de contrôle du modèle. Récupérez la valeur sd_name correspondante en appelant l’API Query Model avec filter.types=checkpoint comme paramètre de requête.
restore_facesbool	restore_facesbool	Déplacé à l’intérieur
restore_faces_model		Obsolète
sd_vaestring	sd_vaestring	Déplacé à l’intérieur
clip_skipinteger	clip_skipinteger	Déplacé à l’intérieur
enable_hrboolean	hires_fixobject	Modifié `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`	Modifié `hr_upscaler`→`request.hires_fix.upscaler`
hr_scalenumber		Obsolète
hr_resize_xinteger	target_widthinteger	Modifié `hr_resize_x`→ `request.hires_fix.target_width`
hr_resize_yinteger	target_heightinteger	Modifié `hr_resize_y`→ `request.hires_fix.target_height`
img_expire_ttlinteger		Obsolète Par défaut 3600s
sd_refinerobject	refinerobject	Modifié `sd_refiner`→ `request.refiner`
checkpointstring		Obsolète
switch_at number(float32)	switch_at number(float32)	Modifié `sd_refiner.switch_at`→ `request.refiner.switch_at`
controlnet_unitsobject[]		Obsolète `img2img` uniquement

Mappage des paramètres de réponse

V2	V3	Description
code		Obsolète
msg		Obsolète
data		Obsolète
task_id	task_id	Modifié `data.task_id`→ `task_id`
warn		Obsolète

Exemple

Texte vers image V2

Requête

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
}'

Réponse

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

Texte vers image V3

Requête

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
          }
        ]
    }
}'

Réponse

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

Image vers image

Mappage des paramètres du corps de requête

V2	V3	Description
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		Obsolète
response_image_type Enum: `png`, `jpeg`	response_image_type Enum: `png, webp, jpeg`	V3 ajoute la prise en charge du format d’image `webp`
	requestobject	Nouveau champ Tous les paramètres de génération d’image doivent être transmis via `request` dans V3
promptstring <lora:$sd_name:$weight>	promptstring	Déplacé à l’intérieur
	lorasobject[]	Déplacé à l’intérieur Migrer l’utilisation de LoRA : du paramètre `prompt` vers le paramètre `request.loras`
	model_namestring	Nouveau champ Nom de lora ; récupérez la valeur sd_name_in_api correspondante en appelant l’endpoint Get Model API avec filter.types=lora comme paramètre de requête.
	strength number(float32)	Nouveau champ Valeur de force de lora. Plus la valeur est élevée, plus l’effet est orienté vers lora. Plage [0, 1]
negative_promptstring	negative_prompt string	Déplacé à l’intérieur
sampler_namestring	sampler_namestring	Déplacé à l’intérieur
batch_sizeinteger	image_numinteger	Modifié `batch_size`→ `request.image_num`
n_iterinteger		Obsolète
stepsstring	stepsstring	Déplacé à l’intérieur
cfg_scaleinteger	guidance_scale number(float32)	Modifié `cfg_scale`→ `request.guidance_scale`
seedinteger	seedinteger	Déplacé à l’intérieur
heightinteger	heightinteger	Déplacé à l’intérieur Changement de plage : [128, 2048].
widthinteger	widthinteger	Déplacé à l’intérieur Changement de plage : [128, 2048].
model_namestring	model_namestring	Déplacé à l’intérieur Ce paramètre spécifie le nom du point de contrôle du modèle. Récupérez la valeur sd_name correspondante en appelant l’API Query Model avec filter.types=checkpoint comme paramètre de requête.
init_imagesstring[]	image_base64string	Modifié `init_images`→ `request.image_base64`
denoising_strength number(float)	strength number(float)	Modifié `denoising_strength`→ `request.strength`
restore_facesbool		Obsolète
sd_vaestring	sd_vaestring	Déplacé à l’intérieur
clip_skipinteger	clip_skipinteger	Déplacé à l’intérieur
maskstring		Obsolète Recommandation : utilisez l’API V3 Inpainting
mask_blurinteger		Obsolète Recommandation : utilisez l’API V3 Inpainting
resize_modeinteger		Obsolète
image_cfg_scaleinteger		Obsolète
inpainting_fillinteger		Obsolète Recommandation : utilisez l’API V3 Inpainting
inpaint_full_resinteger		Obsolète Recommandation : utilisez l’API V3 Inpainting
inpaint_full_res_padding integer		Obsolète Recommandation : utilisez l’API V3 Inpainting
inpainting_mask_invert integer		Obsolète Recommandation : utilisez l’API V3 Inpainting
initial_noise_multiplier number(float32)		Obsolète
img_expire_ttlinteger		Obsolète Par défaut 3600s
sd_refinerobject	refinerobject	Modifié `sd_refiner`→ `request.refiner`
checkpoint		Obsolète
switch_at number(float32)	switch_at number(float32)	Déplacé à l’intérieur
	controlnetobject	Nouveau champ
controlnet_unitsobject[]	unitsobject[]	Modifié `controlnet_units`→ `request.controlnet.units`
modelstring	model_name string	Modifié `controlnet_units.model`→ `request.controlnet.units.model_name`
weightnumber	strength number(float32)	Modifié `controlnet_units.weight`→ `request.controlnet.units.strength`
input_imagestring	image_base64 string	Modifié `controlnet_units.input_image`→ `request.controlnet.units.image_base64`
modulestring,Enum	preprocessor string,Enum	Modifié `controlnet_units.module`→ `request.controlnet.units.preprocessor`
control_mode		Obsolète
mask		Obsolète Recommandation : utilisez l’API V3 Inpainting
resize_mode		Obsolète
processor_res		Obsolète
threshold_a		Obsolète
threshold_b		Obsolète
guidance_start number(float32)	guidance_start number(float32)	Déplacé à l’intérieur
guidance_end number(float32)	guidance_end number(float32)	Déplacé à l’intérieur
pixel_perfect		Obsolète

Mappage des paramètres de réponse

V2	V3	Description
code		Obsolète
msg		Obsolète
data		Obsolète
task_id	task_id	Modifié `data.task_id`→ `task_id`
warn		Obsolète

Exemple

Image vers image V2

Requête

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
  }
}'

Réponse

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

Image vers image V3

Requête

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
        }
      ]
    }
  }
}'

Réponse

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

Get started

Model APIs

Agent Sandbox

GPUs

Observability

Resources

Guide de migration de l’API V2 vers V3

Texte vers image

Mappage des paramètres du corps de requête

Mappage des paramètres de réponse

Exemple

Texte vers image V2

Texte vers image V3

Image vers image

Mappage des paramètres du corps de requête

Mappage des paramètres de réponse

Exemple

Image vers image V2

Image vers image V3

​Texte vers image

​Mappage des paramètres du corps de requête

​Mappage des paramètres de réponse

​Exemple

Texte vers image V2

Texte vers image V3

​Image vers image

​Mappage des paramètres du corps de requête

​Mappage des paramètres de réponse

​Exemple

Image vers image V2

Image vers image V3

Texte vers image

Mappage des paramètres du corps de requête

Mappage des paramètres de réponse

Exemple

Image vers image

Mappage des paramètres du corps de requête

Mappage des paramètres de réponse

Exemple