Skip to content

Get Inspiration

FreshGET
GET https://api.creatify.ai/api/inspirations/{id}/

Retrieve a specific inspiration template by its ID.

Path Parameters

NameTypeRequiredDescription
idstringYesThe inspiration ID

Headers

HeaderTypeRequiredDescription
X-API-IDstringYesYour Creatify API ID
X-API-KEYstringYesYour Creatify API key

Example Request

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

Response

json
{
  "id": "insp-001",
  "name": "Product Showcase",
  "description": "Dynamic product showcase with rotating angles",
  "thumbnail": "https://cdn.creatify.ai/inspirations/insp-001-thumb.jpg",
  "preview_url": "https://cdn.creatify.ai/inspirations/insp-001-preview.mp4",
  "category": "ecommerce",
  "parameters": {
    "product_url": {"type": "string", "required": true},
    "headline": {"type": "string", "required": false}
  },
  "created_at": "2024-01-15T10:30:00Z"
}

Response Fields

FieldTypeDescription
idstringUnique inspiration identifier
namestringInspiration name
descriptionstringDescription of the creative concept
thumbnailstringThumbnail image URL
preview_urlstringVideo preview URL
categorystringCategory (e.g., ecommerce, saas, food)
parametersobjectConfigurable parameters for this inspiration
created_atstringISO 8601 timestamp

Status Codes

CodeDescription
200Success
401Unauthorized -- invalid API credentials
404Inspiration not found
500Internal server error