API Reference

Generates an AI image for an asset using a text prompt.

post
https://localhost:44395/api/asset//generate-image

Behavior: Uses AI image generation to create a new image based on the provided text prompt. The generated image is saved as a new asset. A prompt is required in the request body.

Authorization: Requires a valid Bearer token.

Side Effects: A new image asset is created from the AI-generated content.

Error Scenarios: Returns 400 if the prompt is empty or the request body is missing. Returns 401 if the caller is not authenticated. Returns 404 if the input model is null.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier of the asset context for the image generation.

Body Params

The image generation parameters including the text prompt.

Represents a request to generate a new image based on an existing asset using AI image generation capabilities.

uuid

Gets or sets the identifier of the source asset to use as a reference for image generation.

string | null

Gets or sets the text prompt describing the desired image output.

string | null

Gets or sets the optional negative prompt describing elements to exclude from the generated image.

boundingBox
object | null

Gets or sets the optional bounding box that defines the region of interest for image generation.

boolean

Gets or sets a value indicating whether to apply the internally computed bounding box during generation.

string | null

Gets or sets the optional mask prompt used to define areas of the image to modify.

boolean

Gets or sets a value indicating whether to generate a variation of the source image rather than a new image.

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Updated about 21 hours ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 21 hours ago