generation_doc.proto (version not set)

Download OpenAPI specification:Download

GenerationService

AsyncCancel

Request Body schema: application/json

requestId	string
asyncHandle	string

Responses

Request samples

Payload

Content type

application/json

{"requestId": "string",
"asyncHandle": "string"
}

Response samples

200
default

Content type

application/json

{ }

AsyncGenerate

Request Body schema: application/json

A Request is a set of Artifacts, which can be of any type with model or transform parameters. It is sent to the server, which will respond with an Answer.

engineId	string
requestId	string
requestedType	string (ArtifactType) Default: "ARTIFACT_NONE" Enum: "ARTIFACT_NONE" "ARTIFACT_IMAGE" "ARTIFACT_VIDEO" "ARTIFACT_TEXT" "ARTIFACT_TOKENS" "ARTIFACT_EMBEDDING" "ARTIFACT_CLASSIFICATIONS" "ARTIFACT_MASK" "ARTIFACT_LATENT" "ARTIFACT_TENSOR" "ARTIFACT_LORA"
	Array of objects (Prompt)
	object (ImageParameters)

Responses

Request samples

Payload

Content type

application/json

{"engineId": "string",
"requestId": "string",
"requestedType": "ARTIFACT_NONE",
"prompt": [{"parameters": {"init": true,
"weight": 0
},
"text": "string",
"tokens": {"tokens": [{"text": "string",
"id": 0
}
],
"tokenizerId": "string"
},
"artifact": {"id": "string",
"type": "ARTIFACT_NONE",
"mime": "string",
"magic": "string",
"binary": "string",
"text": "string",
"tokens": {"tokens": [{"text": "string",
"id": 0
}
],
"tokenizerId": "string"
},
"tensor": {"dtype": "DT_INVALID",
"shape": ["string"
],
"data": "string",
"attrType": "AT_PARAMETER"
},
"lora": {"target": "LORA_UNET",
"tensors": [{"dtype": "DT_INVALID",
"shape": ["string"
],
"data": "string",
"attrType": "AT_PARAMETER"
}
]
},
"index": 0,
"finishReason": "NULL",
"seed": 0,
"uuid": "string",
"size": "string",
"adjustments": [{"blur": {"sigma": 0,
"direction": "DIRECTION_NONE"
},
"invert": { },
"levels": {"inputLow": 0,
"inputHigh": 0,
"outputLow": 0,
"outputHigh": 0
},
"channels": {"r": "CHANNEL_R",
"g": "CHANNEL_R",
"b": "CHANNEL_R",
"a": "CHANNEL_R"
},
"rescale": {"height": "string",
"width": "string",
"mode": "RESCALE_STRICT",
"algorithmHint": ["string"
]
},
"crop": {"top": "string",
"left": "string",
"width": "string",
"height": "string"
}
}
],
"postAdjustments": [{"blur": {"sigma": 0,
"direction": "DIRECTION_NONE"
},
"invert": { },
"levels": {"inputLow": 0,
"inputHigh": 0,
"outputLow": 0,
"outputHigh": 0
},
"channels": {"r": "CHANNEL_R",
"g": "CHANNEL_R",
"b": "CHANNEL_R",
"a": "CHANNEL_R"
},
"rescale": {"height": "string",
"width": "string",
"mode": "RESCALE_STRICT",
"algorithmHint": ["string"
]
},
"crop": {"top": "string",
"left": "string",
"width": "string",
"height": "string"
}
}
]
}
}
],
"image": {"height": "string",
"width": "string",
"seed": [0
],
"samples": "string",
"steps": "string",
"transform": {"diffusion": "SAMPLER_DDIM",
"upscaler": "UPSCALER_RGB"
},
"parameters": [{"scaledStep": 0,
"sampler": {"eta": 0,
"samplingSteps": "string",
"latentChannels": "string",
"downsamplingFactor": "string",
"cfgScale": 0,
"churn": {"churn": 0,
"churnTmin": 0,
"churnTmax": 0
},
"sigma": {"sigmaMin": 0,
"sigmaMax": 0,
"karrasRho": 0
},
"noiseType": "SAMPLER_NOISE_NORMAL"
},
"schedule": {"start": 0,
"end": 0,
"value": 0
},
"guidance": {"guidancePreset": "GUIDANCE_PRESET_NONE",
"instances": [{"models": [{"architecture": "MODEL_ARCHITECTURE_NONE",
"publisher": "string",
"dataset": "string",
"version": 0,
"semanticVersion": "string",
"alias": "string"
}
],
"guidanceStrength": 0,
"schedule": [{"duration": 0,
"value": 0
}
],
"cutouts": {"cutouts": [{ }
],
"count": 0,
"gray": 0,
"blur": 0,
"sizePower": 0
},
"prompt": {"parameters": {"init": true,
"weight": 0
},
"text": "string",
"tokens": {"tokens": [null
],
"tokenizerId": "string"
},
"artifact": {"id": "string",
"type": "ARTIFACT_NONE",
"mime": "string",
"magic": "string",
"binary": "string",
"text": "string",
"tokens": {"tokens": [ ],
"tokenizerId": null
},
"tensor": {"dtype": null,
"shape": [ ],
"data": null,
"attrType": null
},
"lora": {"target": null,
"tensors": [ ]
},
"index": 0,
"finishReason": "NULL",
"seed": 0,
"uuid": "string",
"size": "string",
"adjustments": [null
],
"postAdjustments": [null
]
}
}
}
]
}
}
],
"extension": {"parameters": [{"name": "string",
"float": 0,
"int": "string",
"str": "string"
}
]
},
"hires": {"enable": true,
"oosFraction": 0
},
"tiling": true
}
}

Response samples

200
default

Content type

application/json

{"requestId": "string",
"asyncHandle": "string"
}

AsyncResult

Request Body schema: application/json

requestId	string
asyncHandle	string

Responses

Request samples

Payload

Content type

application/json

{"requestId": "string",
"asyncHandle": "string"
}

Response samples

200
default

Content type

application/json

{"answer": [{"answerId": "string",
"requestId": "string",
"received": "string",
"created": "string",
"meta": {"gpuId": "string",
"cpuId": "string",
"nodeId": "string",
"engineId": "string"
},
"artifacts": [{"id": "string",
"type": "ARTIFACT_NONE",
"mime": "string",
"magic": "string",
"binary": "string",
"text": "string",
"tokens": {"tokens": [{"text": "string",
"id": 0
}
],
"tokenizerId": "string"
},
"tensor": {"dtype": "DT_INVALID",
"shape": ["string"
],
"data": "string",
"attrType": "AT_PARAMETER"
},
"lora": {"target": "LORA_UNET",
"tensors": [{"dtype": "DT_INVALID",
"shape": ["string"
],
"data": "string",
"attrType": "AT_PARAMETER"
}
]
},
"index": 0,
"finishReason": "NULL",
"seed": 0,
"uuid": "string",
"size": "string",
"adjustments": [{"blur": {"sigma": 0,
"direction": "DIRECTION_NONE"
},
"invert": { },
"levels": {"inputLow": 0,
"inputHigh": 0,
"outputLow": 0,
"outputHigh": 0
},
"channels": {"r": "CHANNEL_R",
"g": "CHANNEL_R",
"b": "CHANNEL_R",
"a": "CHANNEL_R"
},
"rescale": {"height": "string",
"width": "string",
"mode": "RESCALE_STRICT",
"algorithmHint": ["string"
]
},
"crop": {"top": "string",
"left": "string",
"width": "string",
"height": "string"
}
}
],
"postAdjustments": [{"blur": {"sigma": 0,
"direction": "DIRECTION_NONE"
},
"invert": { },
"levels": {"inputLow": 0,
"inputHigh": 0,
"outputLow": 0,
"outputHigh": 0
},
"channels": {"r": "CHANNEL_R",
"g": "CHANNEL_R",
"b": "CHANNEL_R",
"a": "CHANNEL_R"
},
"rescale": {"height": "string",
"width": "string",
"mode": "RESCALE_STRICT",
"algorithmHint": ["string"
]
},
"crop": {"top": "string",
"left": "string",
"width": "string",
"height": "string"
}
}
]
}
]
}
],
"complete": true,
"status": {"code": 0,
"message": "string"
}
}

Generate

Request Body schema: application/json

A Request is a set of Artifacts, which can be of any type with model or transform parameters. It is sent to the server, which will respond with an Answer.

engineId	string
requestId	string
requestedType	string (ArtifactType) Default: "ARTIFACT_NONE" Enum: "ARTIFACT_NONE" "ARTIFACT_IMAGE" "ARTIFACT_VIDEO" "ARTIFACT_TEXT" "ARTIFACT_TOKENS" "ARTIFACT_EMBEDDING" "ARTIFACT_CLASSIFICATIONS" "ARTIFACT_MASK" "ARTIFACT_LATENT" "ARTIFACT_TENSOR" "ARTIFACT_LORA"
	Array of objects (Prompt)
	object (ImageParameters)

Responses

Request samples

Payload

Content type

application/json

{"engineId": "string",
"requestId": "string",
"requestedType": "ARTIFACT_NONE",
"prompt": [{"parameters": {"init": true,
"weight": 0
},
"text": "string",
"tokens": {"tokens": [{"text": "string",
"id": 0
}
],
"tokenizerId": "string"
},
"artifact": {"id": "string",
"type": "ARTIFACT_NONE",
"mime": "string",
"magic": "string",
"binary": "string",
"text": "string",
"tokens": {"tokens": [{"text": "string",
"id": 0
}
],
"tokenizerId": "string"
},
"tensor": {"dtype": "DT_INVALID",
"shape": ["string"
],
"data": "string",
"attrType": "AT_PARAMETER"
},
"lora": {"target": "LORA_UNET",
"tensors": [{"dtype": "DT_INVALID",
"shape": ["string"
],
"data": "string",
"attrType": "AT_PARAMETER"
}
]
},
"index": 0,
"finishReason": "NULL",
"seed": 0,
"uuid": "string",
"size": "string",
"adjustments": [{"blur": {"sigma": 0,
"direction": "DIRECTION_NONE"
},
"invert": { },
"levels": {"inputLow": 0,
"inputHigh": 0,
"outputLow": 0,
"outputHigh": 0
},
"channels": {"r": "CHANNEL_R",
"g": "CHANNEL_R",
"b": "CHANNEL_R",
"a": "CHANNEL_R"
},
"rescale": {"height": "string",
"width": "string",
"mode": "RESCALE_STRICT",
"algorithmHint": ["string"
]
},
"crop": {"top": "string",
"left": "string",
"width": "string",
"height": "string"
}
}
],
"postAdjustments": [{"blur": {"sigma": 0,
"direction": "DIRECTION_NONE"
},
"invert": { },
"levels": {"inputLow": 0,
"inputHigh": 0,
"outputLow": 0,
"outputHigh": 0
},
"channels": {"r": "CHANNEL_R",
"g": "CHANNEL_R",
"b": "CHANNEL_R",
"a": "CHANNEL_R"
},
"rescale": {"height": "string",
"width": "string",
"mode": "RESCALE_STRICT",
"algorithmHint": ["string"
]
},
"crop": {"top": "string",
"left": "string",
"width": "string",
"height": "string"
}
}
]
}
}
],
"image": {"height": "string",
"width": "string",
"seed": [0
],
"samples": "string",
"steps": "string",
"transform": {"diffusion": "SAMPLER_DDIM",
"upscaler": "UPSCALER_RGB"
},
"parameters": [{"scaledStep": 0,
"sampler": {"eta": 0,
"samplingSteps": "string",
"latentChannels": "string",
"downsamplingFactor": "string",
"cfgScale": 0,
"churn": {"churn": 0,
"churnTmin": 0,
"churnTmax": 0
},
"sigma": {"sigmaMin": 0,
"sigmaMax": 0,
"karrasRho": 0
},
"noiseType": "SAMPLER_NOISE_NORMAL"
},
"schedule": {"start": 0,
"end": 0,
"value": 0
},
"guidance": {"guidancePreset": "GUIDANCE_PRESET_NONE",
"instances": [{"models": [{"architecture": "MODEL_ARCHITECTURE_NONE",
"publisher": "string",
"dataset": "string",
"version": 0,
"semanticVersion": "string",
"alias": "string"
}
],
"guidanceStrength": 0,
"schedule": [{"duration": 0,
"value": 0
}
],
"cutouts": {"cutouts": [{ }
],
"count": 0,
"gray": 0,
"blur": 0,
"sizePower": 0
},
"prompt": {"parameters": {"init": true,
"weight": 0
},
"text": "string",
"tokens": {"tokens": [null
],
"tokenizerId": "string"
},
"artifact": {"id": "string",
"type": "ARTIFACT_NONE",
"mime": "string",
"magic": "string",
"binary": "string",
"text": "string",
"tokens": {"tokens": [ ],
"tokenizerId": null
},
"tensor": {"dtype": null,
"shape": [ ],
"data": null,
"attrType": null
},
"lora": {"target": null,
"tensors": [ ]
},
"index": 0,
"finishReason": "NULL",
"seed": 0,
"uuid": "string",
"size": "string",
"adjustments": [null
],
"postAdjustments": [null
]
}
}
}
]
}
}
],
"extension": {"parameters": [{"name": "string",
"float": 0,
"int": "string",
"str": "string"
}
]
},
"hires": {"enable": true,
"oosFraction": 0
},
"tiling": true
}
}

Response samples

200
default

Content type

application/json

{"result": {"answerId": "string",
"requestId": "string",
"received": "string",
"created": "string",
"meta": {"gpuId": "string",
"cpuId": "string",
"nodeId": "string",
"engineId": "string"
},
"artifacts": [{"id": "string",
"type": "ARTIFACT_NONE",
"mime": "string",
"magic": "string",
"binary": "string",
"text": "string",
"tokens": {"tokens": [{"text": "string",
"id": 0
}
],
"tokenizerId": "string"
},
"tensor": {"dtype": "DT_INVALID",
"shape": ["string"
],
"data": "string",
"attrType": "AT_PARAMETER"
},
"lora": {"target": "LORA_UNET",
"tensors": [{"dtype": "DT_INVALID",
"shape": ["string"
],
"data": "string",
"attrType": "AT_PARAMETER"
}
]
},
"index": 0,
"finishReason": "NULL",
"seed": 0,
"uuid": "string",
"size": "string",
"adjustments": [{"blur": {"sigma": 0,
"direction": "DIRECTION_NONE"
},
"invert": { },
"levels": {"inputLow": 0,
"inputHigh": 0,
"outputLow": 0,
"outputHigh": 0
},
"channels": {"r": "CHANNEL_R",
"g": "CHANNEL_R",
"b": "CHANNEL_R",
"a": "CHANNEL_R"
},
"rescale": {"height": "string",
"width": "string",
"mode": "RESCALE_STRICT",
"algorithmHint": ["string"
]
},
"crop": {"top": "string",
"left": "string",
"width": "string",
"height": "string"
}
}
],
"postAdjustments": [{"blur": {"sigma": 0,
"direction": "DIRECTION_NONE"
},
"invert": { },
"levels": {"inputLow": 0,
"inputHigh": 0,
"outputLow": 0,
"outputHigh": 0
},
"channels": {"r": "CHANNEL_R",
"g": "CHANNEL_R",
"b": "CHANNEL_R",
"a": "CHANNEL_R"
},
"rescale": {"height": "string",
"width": "string",
"mode": "RESCALE_STRICT",
"algorithmHint": ["string"
]
},
"crop": {"top": "string",
"left": "string",
"width": "string",
"height": "string"
}
}
]
}
]
},
"error": {"code": 0,
"message": "string",
"details": [{"@type": "string",
"property1": null,
"property2": null
}
]
}
}