Creatify API Docs

Appearance

Inspiration ​

Fresh

Purpose ​

Browse and use pre-made video styles and schemas from Creatify's Inspiration library to kickstart video creation.

Prerequisites ​

  • Authenticated API access (Authentication SOP)
  • Sufficient credits for the selected inspiration style

Procedure ​

Step 1: Browse Inspirations ​

bash
curl --request GET \
  --url https://api.creatify.ai/api/inspirations/ \
  --header "X-API-ID: $CREATIFY_API_ID" \
  --header "X-API-KEY: $CREATIFY_API_KEY"

Response (partial):

json
[
  {
    "id": "inspiration-uuid-001",
    "name": "Product Highlight Reel",
    "description": "Dynamic product showcase with motion graphics",
    "thumbnail": "https://cdn.creatify.ai/inspirations/thumb-001.jpg",
    "category": "e-commerce"
  },
  {
    "id": "inspiration-uuid-002",
    "name": "Testimonial Style",
    "description": "Avatar-based testimonial with branded overlay",
    "thumbnail": "https://cdn.creatify.ai/inspirations/thumb-002.jpg",
    "category": "marketing"
  }
]

Step 2: Get Inspiration Details ​

bash
curl --request GET \
  --url https://api.creatify.ai/api/inspirations/inspiration-uuid-001/ \
  --header "X-API-ID: $CREATIFY_API_ID" \
  --header "X-API-KEY: $CREATIFY_API_KEY"

Step 3: Create an Inspiration Job ​

bash
curl --request POST \
  --url https://api.creatify.ai/api/inspirations/jobs/ \
  --header "Content-Type: application/json" \
  --header "X-API-ID: $CREATIFY_API_ID" \
  --header "X-API-KEY: $CREATIFY_API_KEY" \
  --data '{
    "inspiration_id": "inspiration-uuid-001",
    "variables": {
      "product_url": "https://example.com/product",
      "headline": "Introducing the Future"
    }
  }'

Response:

json
{
  "id": "inspiration-job-uuid",
  "status": "pending"
}

Step 4: Poll and Download ​

bash
curl --request GET \
  --url https://api.creatify.ai/api/inspirations/jobs/inspiration-job-uuid/ \
  --header "X-API-ID: $CREATIFY_API_ID" \
  --header "X-API-KEY: $CREATIFY_API_KEY"

Credit Cost ​

OperationCredits
List inspirations0
Get inspiration details0
Create inspiration jobVaries by style

Verification Checklist ​

  • [ ] Selected inspiration matches the desired video style
  • [ ] All required variables are provided
  • [ ] Job creation returns pending status
  • [ ] Output video matches the inspiration style
  • [ ] Custom variables are correctly applied

See Also