API Documentation

cURL

Create a generation

curl -X POST https://us-central1-canvasvid.cloudfunctions.net/api/v1/generations \
  -H "Authorization: Bearer cvid_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "productImageUrl": "https://example.com/product.jpg",
    "style": "clean",
    "mode": "image",
    "imageCount": 3
  }'

Check generation status

curl https://us-central1-canvasvid.cloudfunctions.net/api/v1/generations/gen_abc123 \
  -H "Authorization: Bearer cvid_live_your_key"

Remove background from an image

curl -X POST https://us-central1-canvasvid.cloudfunctions.net/api/v1/tool-runs \
  -H "Authorization: Bearer cvid_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "featureId": "remove-background",
    "input": { "imageUrl": "https://example.com/photo.jpg" }
  }'

JavaScript / Node.js

const API_KEY = "cvid_live_your_key";
const BASE = "https://us-central1-canvasvid.cloudfunctions.net/api";

// Create a generation
const res = await fetch(`${BASE}/v1/generations`, {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    productImageUrl: "https://example.com/product.jpg",
    style: "clean",
    mode: "image",
    imageCount: 3,
  }),
});
const { data } = await res.json();
console.log("Generation ID:", data.id);

// Poll for results
async function waitForCompletion(genId) {
  while (true) {
    const res = await fetch(`${BASE}/v1/generations/${genId}`, {
      headers: { "Authorization": `Bearer ${API_KEY}` },
    });
    const { data } = await res.json();
    if (data.status === "completed") return data.results;
    if (data.status === "failed") throw new Error(data.errorMessage);
    await new Promise((r) => setTimeout(r, 5000)); // wait 5s
  }
}

const results = await waitForCompletion(data.id);
console.log("Images:", results.images);

Python

import requests
import time

API_KEY = "cvid_live_your_key"
BASE = "https://us-central1-canvasvid.cloudfunctions.net/api"
HEADERS = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json",
}

# Create a generation
res = requests.post(f"{BASE}/v1/generations", headers=HEADERS, json={
    "productImageUrl": "https://example.com/product.jpg",
    "style": "clean",
    "mode": "image",
    "imageCount": 3,
})
gen_id = res.json()["data"]["id"]
print(f"Generation ID: {gen_id}")

# Poll for results
while True:
    res = requests.get(f"{BASE}/v1/generations/{gen_id}", headers=HEADERS)
    data = res.json()["data"]
    if data["status"] == "completed":
        print("Images:", data["results"]["images"])
        break
    elif data["status"] == "failed":
        print("Error:", data["errorMessage"])
        break
    time.sleep(5)

# Run a tool
res = requests.post(f"{BASE}/v1/tool-runs", headers=HEADERS, json={
    "featureId": "remove-background",
    "input": {"imageUrl": "https://example.com/photo.jpg"},
})
print("Result:", res.json()["data"])