API Reference
request and response description
Background Generation contract
Below, you can see all possible options for the request body. See the AI Background Options and Image generation I/O sections to learn more about Background Generation options.
Specifies:
- object to place on the scene and its properties (
object
) - scene properties (
scene
) - how many images will be created and where they will be stored (
output
)
URL of the output images. If output
is not defined, we store the output image on our bucket and return the temporary URL. Images are stored for one day.
Manipulate object on the scene so that the output images meet your requirements.
Customize the scene so that the output images meet your requirements.
Request
Read a response
Once you have made the request to https://api.claid.ai/v1-ea/scene/create
you will get a response with information about input text and output images.
Image information is shown in the response:
ext
string
File extension. Will have png
value
mps
integer
Megapixel count
mime
string
MIME type (also known as ‘media type’)
width
integer
Image width in pixels
height
integer
Image height in pixels
format
string
File format. Will have png
value
tmp_url
string
Temporary URL of a processed image. Will be empty if output
is specified
Response body
Headers:
See the Request Headers and Response Headers to learn about headers.
Last updated