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": "<unknown>",
"webhook_url": "<string>"
}
'import requests
url = "https://api.creatify.ai/api/inspiration_jobs/"
payload = {
"inspiration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input_params": "<unknown>",
"webhook_url": "<string>"
}
headers = {
"X-API-ID": "<api-key>",
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-ID': '<api-key>',
'X-API-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
inspiration_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
input_params: '<unknown>',
webhook_url: '<string>'
})
};
fetch('https://api.creatify.ai/api/inspiration_jobs/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.creatify.ai/api/inspiration_jobs/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'inspiration_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'input_params' => '<unknown>',
'webhook_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-ID: <api-key>",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.creatify.ai/api/inspiration_jobs/"
payload := strings.NewReader("{\n \"inspiration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input_params\": \"<unknown>\",\n \"webhook_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-ID", "<api-key>")
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.creatify.ai/api/inspiration_jobs/")
.header("X-API-ID", "<api-key>")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"inspiration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input_params\": \"<unknown>\",\n \"webhook_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creatify.ai/api/inspiration_jobs/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-ID"] = '<api-key>'
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inspiration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input_params\": \"<unknown>\",\n \"webhook_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inspiration_id": "<string>",
"gen_type": "<string>",
"status": "<string>",
"failed_reason": "<string>",
"input_params": "<string>",
"output": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"webhook_url": "<string>"
}API Reference
Create Inspiration Job
Create a new inspiration job by submitting the required parameters. This endpoint queues the job for processing and returns details about the created job.
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": "<unknown>",
"webhook_url": "<string>"
}
'import requests
url = "https://api.creatify.ai/api/inspiration_jobs/"
payload = {
"inspiration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input_params": "<unknown>",
"webhook_url": "<string>"
}
headers = {
"X-API-ID": "<api-key>",
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-ID': '<api-key>',
'X-API-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
inspiration_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
input_params: '<unknown>',
webhook_url: '<string>'
})
};
fetch('https://api.creatify.ai/api/inspiration_jobs/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.creatify.ai/api/inspiration_jobs/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'inspiration_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'input_params' => '<unknown>',
'webhook_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-ID: <api-key>",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.creatify.ai/api/inspiration_jobs/"
payload := strings.NewReader("{\n \"inspiration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input_params\": \"<unknown>\",\n \"webhook_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-ID", "<api-key>")
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.creatify.ai/api/inspiration_jobs/")
.header("X-API-ID", "<api-key>")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"inspiration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input_params\": \"<unknown>\",\n \"webhook_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creatify.ai/api/inspiration_jobs/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-ID"] = '<api-key>'
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inspiration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input_params\": \"<unknown>\",\n \"webhook_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inspiration_id": "<string>",
"gen_type": "<string>",
"status": "<string>",
"failed_reason": "<string>",
"input_params": "<string>",
"output": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"webhook_url": "<string>"
}Authorizations
API ID, from your settings page.
API Key, from your settings page.
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Response
201 - application/json
ID of the inspiration.
Generation type of the community recipe.
Current status of the generation job.
Reason for failure if the generation failed.
Parameters for generation
List of generated assets.
Webhook URL for status updates. Default is null.
Maximum string length:
200⌘I

