Skip to main content
POST
/
api
/
inspiration_jobs
/
cURL
curl --request POST \
  --url https://api.creatify.ai/api/inspiration_jobs/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "inspiration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "input_params": "<any>",
  "webhook_url": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inspiration_id": "<string>",
  "gen_type": "<string>",
  "status": "<string>",
  "failed_reason": "<string>",
  "input_params": "<string>",
  "webhook_url": "<string>",
  "output": "<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

​
inspiration_id
string<uuid>
required

ID of the inspiration.

​
input_params
any
required

Parameters for generation

​
webhook_url
string<uri>

Webhook URL

Response

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

ID of the inspiration.

​
gen_type
string
required

Generation type of the community recipe.

​
status
string
required

Current status of the generation job.

​
failed_reason
string
required

Reason for failure if the generation failed.

​
input_params
string
required

Parameters for generation

​
output
string
required

List of generated assets.

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
webhook_url
string<uri> | null

Webhook URL for status updates. Default is null.

Maximum length: 200