Migrationsleitfaden von API V2 zu V3

Text zu Bild

Zuordnung der Parameter im Anfragekörper

V2	V3	Beschreibung
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		Veraltet
response_image_type Enum: `png`, `jpeg`	response_image_type Enum: `png, webp, jpeg`	V3 unterstützt zusätzlich das Bildformat `webp`
	requestobject	Neues Feld Alle Bildgenerierungsparameter müssen in V3 über `request` übergeben werden
promptstring <lora:$sd_name:$weight>	promptstring	Nach innen verschoben
	lorasobject[]	Nach innen verschoben LoRA-Nutzung migrieren: Von `prompt` zum Parameter `request.loras`****
	model_namestring	Neues Feld Name von lora; rufe den entsprechenden sd_name_in_api-Wert ab, indem du den Get Model API-Endpunkt mit filter.types=lora als Abfrageparameter aufrufst.
	strengthnumber(float32)	Neues Feld Der strength-Wert von lora. Je größer der Wert, desto stärker ist der Effekt auf lora ausgerichtet, Bereich [0, 1]
negative_promptstring	negative_promptstring	Nach innen verschoben
sampler_namestring	sampler_namestring	Nach innen verschoben
batch_sizeinteger	image_numinteger	Geändert `num_images` → `request.image_num`
n_iter		Veraltet
stepsstring	stepsstring	Nach innen verschoben
cfg_scaleinteger	guidance_scale number(float32)	Geändert `cfg_scale`→ `request.guidance_scale`
seedinteger	seedinteger	Nach innen verschoben
heightinteger	heightinteger	Nach innen verschoben Bereichsänderung: [128, 2048].
widthinteger	widthinteger	Nach innen verschoben Bereichsänderung: [128, 2048].
model_namestring	model_namestring	Nach innen verschoben Dieser Parameter gibt den Namen des model checkpoint an. Rufe den entsprechenden sd_name-Wert ab, indem du die Query Model-API mit filter.types=checkpoint als Abfrageparameter aufrufst.
restore_facesbool	restore_facesbool	Nach innen verschoben
restore_faces_model		Veraltet
sd_vaestring	sd_vaestring	Nach innen verschoben
clip_skipinteger	clip_skipinteger	Nach innen verschoben
enable_hrboolean	hires_fixobject	Geändert `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`	Geändert `hr_upscaler`→`request.hires_fix.upscaler`
hr_scalenumber		Veraltet
hr_resize_xinteger	target_widthinteger	Geändert `hr_resize_x`→ `request.hires_fix.target_width`
hr_resize_yinteger	target_heightinteger	Geändert `hr_resize_y`→ `request.hires_fix.target_height`
img_expire_ttlinteger		Veraltet Standardwert 3600s
sd_refinerobject	refinerobject	Geändert `sd_refiner`→ `request.refiner`
checkpointstring		Veraltet
switch_at number(float32)	switch_at number(float32)	Geändert `sd_refiner.switch_at`→ `request.refiner.switch_at`
controlnet_unitsobject[]		Veraltet Nur `img2img`

Zuordnung der Antwortparameter

V2	V3	Beschreibung
code		Veraltet
msg		Veraltet
data		Veraltet
task_id	task_id	Geändert `data.task_id`→ `task_id`
warn		Veraltet

Beispiel

Text zu Bild V2

Anfrage

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

Antwort

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

Text zu Bild V3

Anfrage

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

Antwort

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

Bild zu Bild

Zuordnung der Parameter im Anfragekörper

V2	V3	Beschreibung
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		Veraltet
response_image_type Enum: `png`, `jpeg`	response_image_type Enum: `png, webp, jpeg`	V3 unterstützt zusätzlich das Bildformat `webp`
	requestobject	Neues Feld Alle Bildgenerierungsparameter müssen in V3 über `request` übergeben werden
promptstring <lora:$sd_name:$weight>	promptstring	Nach innen verschoben
	lorasobject[]	Nach innen verschoben LoRA-Nutzung migrieren: Von `prompt` zum Parameter `request.loras`****
	model_namestring	Neues Feld Name von lora; rufe den entsprechenden sd_name_in_api-Wert ab, indem du den Get Model API-Endpunkt mit filter.types=lora als Abfrageparameter aufrufst.
	strength number(float32)	Neues Feld Der strength-Wert von lora. Je größer der Wert, desto stärker ist der Effekt auf lora ausgerichtet, Bereich [0, 1]
negative_promptstring	negative_prompt string	Nach innen verschoben
sampler_namestring	sampler_namestring	Nach innen verschoben
batch_sizeinteger	image_numinteger	Geändert `batch_size`→ `request.image_num`
n_iterinteger		Veraltet
stepsstring	stepsstring	Nach innen verschoben
cfg_scaleinteger	guidance_scale number(float32)	Geändert `cfg_scale`→ `request.guidance_scale`
seedinteger	seedinteger	Nach innen verschoben
heightinteger	heightinteger	Nach innen verschoben Bereichsänderung: [128, 2048].
widthinteger	widthinteger	Nach innen verschoben Bereichsänderung: [128, 2048].
model_namestring	model_namestring	Nach innen verschoben Dieser Parameter gibt den Namen des model checkpoint an. Rufe den entsprechenden sd_name-Wert ab, indem du die Query Model-API mit filter.types=checkpoint als Abfrageparameter aufrufst.
init_imagesstring[]	image_base64string	Geändert `init_images`→ `request.image_base64`
denoising_strength number(float)	strength number(float)	Geändert `denoising_strength`→ `request.strength`
restore_facesbool		Veraltet
sd_vaestring	sd_vaestring	Nach innen verschoben
clip_skipinteger	clip_skipinteger	Nach innen verschoben
maskstring		Veraltet Empfehlung: V3 Inpainting API verwenden
mask_blurinteger		Veraltet Empfehlung: V3 Inpainting API verwenden
resize_modeinteger		Veraltet
image_cfg_scaleinteger		Veraltet
inpainting_fillinteger		Veraltet Empfehlung: V3 Inpainting API verwenden
inpaint_full_resinteger		Veraltet Empfehlung: V3 Inpainting API verwenden
inpaint_full_res_padding integer		Veraltet Empfehlung: V3 Inpainting API verwenden
inpainting_mask_invert integer		Veraltet Empfehlung: V3 Inpainting API verwenden
initial_noise_multiplier number(float32)		Veraltet
img_expire_ttlinteger		Veraltet Standardwert 3600s
sd_refinerobject	refinerobject	Geändert `sd_refiner`→ `request.refiner`
checkpoint		Veraltet
switch_at number(float32)	switch_at number(float32)	Nach innen verschoben
	controlnetobject	Neues Feld
controlnet_unitsobject[]	unitsobject[]	Geändert `controlnet_units`→ `request.controlnet.units`
modelstring	model_name string	Geändert `controlnet_units.model`→ `request.controlnet.units.model_name`
weightnumber	strength number(float32)	Geändert `controlnet_units.weight`→ `request.controlnet.units.strength`
input_imagestring	image_base64 string	Geändert `controlnet_units.input_image`→ `request.controlnet.units.image_base64`
modulestring,Enum	preprocessor string,Enum	Geändert `controlnet_units.module`→ `request.controlnet.units.preprocessor`
control_mode		Veraltet
mask		Veraltet Empfehlung: V3 Inpainting API verwenden
resize_mode		Veraltet
processor_res		Veraltet
threshold_a		Veraltet
threshold_b		Veraltet
guidance_start number(float32)	guidance_start number(float32)	Nach innen verschoben
guidance_end number(float32)	guidance_end number(float32)	Nach innen verschoben
pixel_perfect		Veraltet

Zuordnung der Antwortparameter

V2	V3	Beschreibung
code		Veraltet
msg		Veraltet
data		Veraltet
task_id	task_id	Geändert `data.task_id`→ `task_id`
warn		Veraltet

Beispiel

Bild zu Bild V2

Anfrage

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

Antwort

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

Bild zu Bild V3

Anfrage

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

Antwort

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

Get started

Model APIs

Agent Sandbox

GPUs

Observability

Resources

Migrationsleitfaden von API V2 zu V3

Text zu Bild

Zuordnung der Parameter im Anfragekörper

Zuordnung der Antwortparameter

Beispiel

Text zu Bild V2

Text zu Bild V3

Bild zu Bild

Zuordnung der Parameter im Anfragekörper

Zuordnung der Antwortparameter

Beispiel

Bild zu Bild V2

Bild zu Bild V3

​Text zu Bild

​Zuordnung der Parameter im Anfragekörper

​Zuordnung der Antwortparameter

​Beispiel

Text zu Bild V2

Text zu Bild V3

​Bild zu Bild

​Zuordnung der Parameter im Anfragekörper

​Zuordnung der Antwortparameter

​Beispiel

Bild zu Bild V2

Bild zu Bild V3

Text zu Bild

Zuordnung der Parameter im Anfragekörper

Zuordnung der Antwortparameter

Beispiel

Bild zu Bild

Zuordnung der Parameter im Anfragekörper

Zuordnung der Antwortparameter

Beispiel