Creatify API Docs

Appearance

Quickstart Guide ​

Fresh

Purpose ​

Get from zero to your first Creatify API call in under 5 minutes. This guide covers obtaining API credentials, checking your credit balance, and generating your first video.

Prerequisites ​

  • A Creatify account with an active plan at creatify.ai
  • API access enabled on your account
  • curl or any HTTP client (Postman, Insomnia, etc.)

Procedure ​

Step 1: Get Your API Credentials ​

  1. Log in to your Creatify dashboard
  2. Navigate to Settings then API
  3. Copy your API ID and API Key
  4. Store them securely (environment variables recommended)
bash
export CREATIFY_API_ID="your-api-id-here"
export CREATIFY_API_KEY="your-api-key-here"

Step 2: Verify Your Credentials by Checking Credits ​

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

Expected response:

json
{
  "remaining_credits": 150
}

TIP

If you receive a 401 or 403 error, double-check your API ID and API Key values. They are case-sensitive.

Before generating a URL-to-video, create a link from a webpage URL. Creatify scrapes the page to extract product information.

bash
curl --request POST \
  --url https://api.creatify.ai/api/links/ \
  --header "Content-Type: application/json" \
  --header "X-API-ID: $CREATIFY_API_ID" \
  --header "X-API-KEY: $CREATIFY_API_KEY" \
  --data '{
    "url": "https://www.example.com/product-page"
  }'

Expected response:

json
{
  "id": "abc123-link-id",
  "url": "https://www.example.com/product-page",
  "title": "Product Name",
  "description": "Product description extracted from page...",
  "media": ["https://...image1.jpg", "https://...image2.jpg"]
}

Save the id value -- you will need it for the next step.

Step 4: Generate a Video Preview ​

Use the link ID to create a URL-to-video task with a preview (1 credit/30s instead of 5):

bash
curl --request POST \
  --url https://api.creatify.ai/api/url_to_videos/ \
  --header "Content-Type: application/json" \
  --header "X-API-ID: $CREATIFY_API_ID" \
  --header "X-API-KEY: $CREATIFY_API_KEY" \
  --data '{
    "link_id": "abc123-link-id",
    "aspect_ratio": "9:16"
  }'

Expected response:

json
{
  "id": "video-task-id-123",
  "status": "pending",
  "aspect_ratio": "9:16"
}

Step 5: Poll for Completion ​

The video generation is asynchronous. Poll the task status:

bash
curl --request GET \
  --url https://api.creatify.ai/api/url_to_videos/video-task-id-123/ \
  --header "X-API-ID: $CREATIFY_API_ID" \
  --header "X-API-KEY: $CREATIFY_API_KEY"

Poll every 5-10 seconds. Status progression:

StatusMeaning
pendingTask is queued
processingVideo is being generated
doneVideo is ready for download
failedGeneration failed (check failed_reason)

Step 6: Download Your Video ​

When status is done, the response includes an output field with the video URL:

json
{
  "id": "video-task-id-123",
  "status": "done",
  "output": "https://cdn.creatify.ai/videos/output-video.mp4",
  "duration": 30
}

Download the video from the output URL.

Verification Checklist ​

  • [ ] API credentials return a valid credit balance
  • [ ] Link creation returns an id with extracted page data
  • [ ] Video task creation returns a pending status
  • [ ] Polling eventually shows done status
  • [ ] Output URL returns a playable MP4 video

Credit Cost ​

OperationCredits
Check credits0
Create link0
URL-to-video (create)5 per 30s
URL-to-video (preview)1 per 30s
URL-to-video (render)4 per 30s

Credit Tip

Always generate a preview first (1 credit/30s), review the output, then render the final version (4 credits/30s). This saves credits when iterations are needed.

Common First Errors ​

ErrorCauseFix
401 UnauthorizedInvalid API ID or KeyRe-check credentials from dashboard
403 ForbiddenAPI access not enabledEnable API access in account settings
400 Bad RequestMissing required fieldsCheck the request body matches the expected format
402 Payment RequiredInsufficient creditsPurchase more credits or upgrade plan

See Also