Get Inspiration Job

FreshGET

GET https://api.creatify.ai/api/inspiration_jobs/{id}/

Retrieve a specific inspiration job by its ID.

Path Parameters

Name	Type	Required	Description
id	string	Yes	The inspiration job ID

Headers

Header	Type	Required	Description
X-API-ID	string	Yes	Your Creatify API ID
X-API-KEY	string	Yes	Your Creatify API key

Example Request

curl -X GET 'https://api.creatify.ai/api/inspiration_jobs/insp-job-001/' \
  -H 'X-API-ID: your-api-id' \
  -H 'X-API-KEY: your-api-key'

Response

{
  "id": "insp-job-001",
  "inspiration_id": "insp-001",
  "status": "done",
  "parameters": {
    "product_url": "https://example.com/product",
    "headline": "Best Product Ever"
  },
  "output": "https://cdn.creatify.ai/inspiration-jobs/insp-job-001.mp4",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:40:00Z"
}

Response Fields

Field	Type	Description
id	string	Unique job identifier
inspiration_id	string	Inspiration template used
status	string	Job status: pending, processing, done, failed
parameters	object	Parameter values provided
output	string	Generated video URL
created_at	string	ISO 8601 timestamp
updated_at	string	ISO 8601 timestamp

Status Codes

Code	Description
200	Success
401	Unauthorized -- invalid API credentials
404	Job not found
500	Internal server error