asset_generator

POST /api/asset_generator/

Changed on

Start an image, video or music generation with any Asset Generator model.

Request

  • The document declares no server URL.
  • Auth
    API key in header X-API-ID and API key in header X-API-KEY

Request body

model_namestring required

Name of the AI generation model.

input_paramsunknown required
webhook_urlstring uri

Webhook URL

Response

idstring uuid required
model_namestring required

Name of the AI generation model used.

gen_typestring required

Type of the AI generation model used.

status'initializing' | 'generating' | 'done' | 'failed'
  • initializing - initializing
  • generating - generating
  • done - done
  • failed - failed
failed_reasonstring required

Reason for failure if the generation failed.

assetsstring required

List of generated assets.

aspect_ratiostring nullable

Aspect ratio of the asset

output_numsinteger

Number of outputs

durationinteger required
resolutionstring nullable

e.g., 1080x1920

input_paramsobject required

Input parameters used for AI generation.

webhook_urlstring uri nullable

Webhook URL for status updates. Default is null.

api_key_idstring uuid nullable required

ID of the API key that created this generation.

api_key_namestring nullable required

Name of the API key that created this generation.

credits_usednumber required

Credits used in this API call

created_atstring date-time required
updated_atstring date-time required

Changes

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status