FloorZap API

REST API for AI-powered floor visualizations. Generate photorealistic floor renderings programmatically.

Authentication

FloorZap uses OAuth2 client credentials to issue short-lived JWT access tokens. First, obtain your client_id and client_secret from the FloorZap dashboard. Then exchange them for an access token:

{
  "client_id": "eai_abc123...",
  "client_secret": "eais_xyz789..."
}

{
  "access_token": "eyJhbGciOiJIUzI1NiJ9...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "tier": "professional"
}

Generate Visualization

{
  "success": true,
  "data": {
    "id": "gen_a1b2c3d4e5f6...",
    "status": "complete",
    "original_image_url": null,
    "generated_image_url": "https://...",
    "style": {
      "id": "uuid-or-null",
      "name": "White Oak",
      "collection": "Hardwood Classics"
    },
    "provider": "floorzap-vision-v1",
    "processing_time_ms": 14200,
    "credits_used": 1,
    "credits_remaining": 999
  },
  "meta": {
    "request_id": "req_f6e5d4c3b2a1...",
    "rate_limit_remaining": 58,
    "rate_limit_reset": "2026-03-16T12:01:00Z"
  }
}

Batch Generation

Generate 2–10 styles in a single request. Professional and Enterprise tiers only.

{
  "image_base64": "base64...",
  "styles": [
    { "style_name": "White Oak", "collection": "Hardwood Classics" },
    { "style_name": "Ocean Breeze", "collection": "Solid" },
    { "style_name": "Copper Vein" }
  ]
}

{
  "success": true,
  "data": {
    "job_id": "uuid",
    "status": "processing",
    "styles_count": 3
  }
}

{
  "success": true,
  "data": {
    "job_id": "uuid",
    "status": "complete",
    "styles_count": 3,
    "progress": "3/3",
    "results": [
      {
        "style_name": "White Oak",
        "status": "complete",
        "generated_image_url": "https://...",
        "provider": "floorzap-vision-v1",
        "processing_time_ms": 12400
      }
    ]
  }
}

Styles Catalog

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "name": "White Oak",
      "code": "MG-001",
      "slug": "midnight-galaxy",
      "collection": "Hardwood Classics",
      "color_hint": "deep blue with silver flecks",
      "hex_colors": ["#1a1a3e", "#c0c0c0"],
      "swatch_url": "https://...",
      "product_type": "floor"
    }
  ],
  "meta": { "total": 160, "limit": 50, "offset": 0, "has_more": true }
}

Usage

{
  "success": true,
  "data": {
    "period_start": "2026-02-14T00:00:00Z",
    "period_end": "2026-03-16T00:00:00Z",
    "generations_used": 142,
    "generations_limit": 10000,
    "rate_limit_per_minute": 200,
    "tier": "professional"
  }
}

Webhooks

Register callback URLs to receive real-time notifications when events occur. Payloads are signed with HMAC-SHA256 using the webhook secret.

{
  "url": "https://yourapp.com/hooks/floorzap",
  "events": ["generation.complete", "batch.complete"]
}

{
  "success": true,
  "data": {
    "id": "uuid",
    "url": "https://yourapp.com/hooks/floorzap",
    "events": ["generation.complete", "batch.complete"],
    "secret": "whsec_a1b2c3...",
    "is_active": true
  }
}

Rate Limits

Rate limit headers are included on every authenticated response:

Code Examples

cURL

# 1. Get access token
curl -X POST https://floorzap.live/api/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"client_id":"eai_abc123","client_secret":"eais_xyz789"}'

# 2. Generate visualization
curl -X POST https://floorzap.live/api/v1/generate \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "image_base64": "<base64_photo>",
    "style_name": "White Oak",
    "collection": "Hardwood Classics"
  }'

# 3. Browse styles (no auth needed)
curl https://floorzap.live/api/v1/styles?collection=Hardwood Classics&limit=10

JavaScript / Node.js

const BASE = 'https://floorzap.live/api/v1';

// Get token
const tokenRes = await fetch(`${BASE}/auth/token`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    client_id: process.env.FLOORZAP_CLIENT_ID,
    client_secret: process.env.FLOORZAP_CLIENT_SECRET,
  }),
});
const { access_token } = await tokenRes.json();

// Generate
const genRes = await fetch(`${BASE}/generate`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${access_token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    image_base64: photoBase64,
    style_name: 'White Oak',
    collection: 'Hardwood Classics',
  }),
});
const { data } = await genRes.json();
console.log(data.generated_image_url);

Python

import requests, base64

BASE = "https://floorzap.live/api/v1"

# Get token
token_resp = requests.post(f"{BASE}/auth/token", json={
    "client_id": "eai_abc123",
    "client_secret": "eais_xyz789",
})
token = token_resp.json()["access_token"]
headers = {"Authorization": f"Bearer {token}"}

# Read and encode image
with open("garage.jpg", "rb") as f:
    image_b64 = base64.b64encode(f.read()).decode()

# Generate visualization
gen_resp = requests.post(f"{BASE}/generate", headers=headers, json={
    "image_base64": image_b64,
    "style_name": "White Oak",
    "collection": "Hardwood Classics",
})
result = gen_resp.json()["data"]
print(result["generated_image_url"])

Error Codes

FloorZap API v1 — Questions? Contact ops@floorzap.pro