Skip to main content
POST
/
api
/
ai_generations
/
cURL
curl --request POST \
  --url https://api.creatify.ai/api/ai_generations/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "model_name": "<string>",
  "input_params": "<any>",
  "webhook_url": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "model_name": "<string>",
  "gen_type": "<string>",
  "status": "initializing",
  "failed_reason": "<string>",
  "assets": "<string>",
  "aspect_ratio": "<string>",
  "output_nums": -1,
  "duration": -1,
  "resolution": "<string>",
  "input_params": "<any>",
  "webhook_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-ID
string
header
required

API ID, from your settings page.

​
X-API-KEY
string
header
required

API Key, from your settings page.

Body

​
model_name
string
required

Name of the AI generation model.

Maximum length: 255
​
input_params
any
required

Parameters for generation

​
webhook_url
string<uri>

Webhook URL

Response

201 - application/json
​
id
string<uuid>
required
​
model_name
string
required

Name of the AI generation model used.

​
gen_type
string
required

Type of the AI generation model used.

​
failed_reason
string
required

Reason for failure if the generation failed.

​
assets
string
required

List of generated assets.

​
input_params
any
required

Input parameters used for AI generation.

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
status
enum<string>
  • initializing - initializing
  • generating - generating
  • done - done
  • failed - failed
Available options:
initializing,
generating,
done,
failed
​
aspect_ratio
string | null

Aspect ratio of the asset

Maximum length: 128
​
output_nums
integer

Number of outputs

Required range: -2147483648 <= x <= 2147483647
​
duration
integer | null

Video duration in seconds

Required range: -2147483648 <= x <= 2147483647
​
resolution
string | null

e.g., 1080x1920

Maximum length: 128
​
webhook_url
string<uri> | null

Webhook URL for status updates. Default is null.

Maximum length: 200