API Documentation

Verify API key and get account information. Use this to test authentication.

{
  "id": "user_abc123",
  "email": "user@example.com",
  "credits": 500,
  "tier": "pro"
}

Credits: FREE

Remove the background from an image, leaving only the subject with transparency.

Request Body

Credits: 1-2

Enhance image resolution using AI upscaling.

Request Body

Credits: 1-8

Replace the background of an image with an AI-generated scene.

Request Body

Credits: 3-15

Remove unwanted objects from an image using a mask.

Request Body

Credits: 3

Transform an existing image based on a text prompt while preserving composition.

Request Body

Credits: 1-8

Generate a depth map from an image showing relative distances from the camera.

Request Body

Useful for 3D effects, parallax scrolling, or understanding scene geometry.

Credits: FREE

Translate text within an image to another language while preserving the design.

Request Body

Credits: 3-4

Create an image from a text description using AI.

Request Body

Credits: 1-10

Generate a video from text and/or an image using AI.

Request Body

{
  "id": "zap_abc123",
  "video_url": "https://...",
  "credits_used": 56
}

Credit costs vary by model and duration. veo31, ltx, and kling require an input image. Only sora supports text-to-video.

Credits: 10-80 (varies by duration)

Generate a 3D model from an image using AI.

Request Body

{
  "id": "zap_abc123",
  "model_url": "https://...",
  "glb_url": "https://...",
  "obj_url": "https://...",
  "fbx_url": "https://...",
  "usdz_url": "https://...",
  "thumbnail_url": "https://...",
  "credits_used": 50
}

Credits: 2-50

Place a product in a realistic lifestyle scene for marketing.

Request Body

Credits: 4

Virtually try clothing on a person using AI.

Request Body

Best results with clear, front-facing photos and flat-lay or mannequin shots of the garment.

Credits: 4

Generate AI-powered product descriptions from product info and/or images.

Request Body

{
  "id": "zap_abc123",
  "description": "Introducing the...",
  "style": "professional",
  "length": "medium",
  "language": "en",
  "credits_used": 1
}

Credits: 1

AI-powered image quality review and validation for e-commerce.

Request Body

{
  "id": "zap_abc123",
  "passed": true,
  "results": [
    { "check": "white_background", "passed": true, "message": "Background is white/clean", "confidence": 95 }
  ],
  "summary": { "total_checks": 2, "passed_checks": 2, "failed_checks": 0 },
  "credits_used": 2
}

Dimension checks (min_width, min_height) are free. Each AI check costs 1 credit.

Credits: 1 per AI check

Upload an image file directly for processing. Useful for localhost or password-protected sources.

Request Body

{
  "id": "zap_abc123",
  "url": "https://fal.media/files/...",
  "filename": "product.jpg",
  "size": 245832,
  "content_type": "image/jpeg"
}

Returns a temporary URL valid for 24 hours. Use this URL with other processing endpoints.

Credits: FREE

Generate descriptive alt text for an image using AI vision.

Request Body

{
  "id": "zap_abc123",
  "alt_text": "A red leather handbag with gold hardware...",
  "credits_used": 1
}

Credits: 1

Remove backgrounds from multiple images asynchronously.

Request Body

{
  "id": "zap_abc123",
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "total": 3,
  "estimated_credits": 3,
  "poll_url": "/api/zapier/batch/status/550e8400-...",
  "message": "Batch job queued for processing."
}

Credits: 1-2 per image

Upscale multiple images asynchronously.

Request Body

{
  "id": "zap_abc123",
  "job_id": "550e8400-e29b-41d4-a716-446655440001",
  "status": "queued",
  "total": 2,
  "estimated_credits": 4,
  "poll_url": "/api/zapier/batch/status/550e8400-...",
  "message": "Batch job queued for processing."
}

Credits: 2-3 per image

Generate alt text for multiple images asynchronously using Gemini 2.0 Flash via OpenRouter.

Request Body

{
  "id": "zap_abc123",
  "job_id": "550e8400-e29b-41d4-a716-446655440002",
  "status": "queued",
  "total": 2,
  "estimated_credits": 2,
  "poll_url": "/api/zapier/batch/status/550e8400-...",
  "message": "Batch job queued for processing."
}

Credits: 1 per image

Check the status of a batch job and retrieve results when complete.

Request Headers

// In progress:
{
  "job_id": "550e8400-...",
  "status": "processing",
  "total": 10,
  "completed": 4,
  "failed": 0,
  "pending": 6,
  "progress": 40,
  "credits_used": 4
}

// Completed (image results):
{
  "job_id": "550e8400-...",
  "status": "completed",
  "total": 3,
  "completed": 3,
  "failed": 0,
  "results": [
    { "id": "product-001", "status": "success", "image_url": "https://..." },
    { "id": "product-002", "status": "success", "image_url": "https://..." }
  ]
}

// Completed (alt text results):
{
  "job_id": "550e8400-...",
  "status": "completed",
  "results": [
    { "id": "img-001", "status": "success", "alt_text": "A red handbag..." }
  ]
}

Status values: pending, queued, processing, completed, failed. Results include image_url for image operations or alt_text for alt text operations.

Credits: FREE

Initiate OAuth flow. Redirects user to login, then back to WordPress with API key.

Request Headers

// User is redirected to redirect_uri with these query params:
?api_key=sk_live_xxx
&credits=100
&tier=PRO
&sirv_plan=Business
&state=your_state_token

// On error:
?error=oauth_failed&state=your_state_token

redirect_uri must be HTTPS in production and contain 'wp-admin' or 'admin.php' in the path.

Credits: FREE

Exchange Sirv API credentials for a Sirv AI Studio API key. Creates account if user doesn't exist.

Request Body

{
  "success": true,
  "api_key": "sk_live_abc123...",
  "credits": 70,
  "tier": "FREE",
  "sirv_plan": "Business 50",
  "is_new_user": false
}

Validates credentials against Sirv API. New users receive 20 welcome credits + Sirv plan bonus (Business: 50, Enterprise: 150).

Credits: FREE