SlabUploader/docs/OPENAPI.md

OpenAPI Contract — SvelteKit Client ↔ FastAPI

Status: SPEC · 2026-08-27 · SlabUploader Base path: /api/v1. All requests/responses JSON unless noted. All timestamps UTC ISO-8601.

Conventions

Auth

No client auth. Trusted LAN/Tailscale + HTTPS.

Errors

Uniform envelope:

{ "error": { "code": "string", "message": "string", "detail": "object|null" } }

• 400 validation — payload failed validation.
• 404 not_found — unknown slab/photo/setting.
• 409 revision_conflict — client_rev/server_rev mismatch. detail carries current_server_rev.
• 409 duplicate_sku — SKU already exists in WooCommerce, any status (draft, private, publish, etc.).
• 422 unpublishable — slab not in a publishable state or missing required field.
• 502 woo_error — WooCommerce rejected the request. detail carries Woo error body.
• 500 internal — unexpected.

Revisions

Create/update carry client_rev. Server echoes server_rev. Client stores server_rev and sends it back on the next update. Mismatch → 409 revision_conflict.

Photos

Uploaded as multipart/form-data. Max 40 MB per request. Two fields per photo:

• files[] — the original image file
• meta[] — JSON { kind: "inventory", role: "topdown"|"extra", seq: 1 }

Pagination

Lists are small (single owner, slab-by-slab). Lists return full arrays.

API Version

URL is /api/v1. Breaking changes bump to /api/v2.

---

Schemas

SlabCreate

{
  "id": "uuid (client-generated)",
  "sku": "string 3..24 [A-Z0-9-]",
  "length_in": 96.0,           // 1/8" step
  "thickness_in": 1.5,        // 1/8" step
  "sqft": 0.64,              // computed by client
  "bdft": 0.96,              // computed by client
  "width_min_in": 14.0,
  "width_max_in": 22.0,
  "width_avg_in": 18.2,
  "species_id": 42,          // → woo_categories (leaf)
  "wood_category_ids": [15, 23],  // JSON array → woo_categories (leaf, 1+)
  "edge_type_term_id": 8,    // → woo_attribute_terms
  "figure_term_ids": [3],    // JSON array → woo_attribute_terms (1+)
  "grade_term_ids": [7],     // JSON array → woo_attribute_terms (1+)
  "thickness_term_id": 12,   // → woo_attribute_terms (round-up)
  "moisture_term_id": 5,     // → woo_attribute_terms (defaults kiln-dried)
  "fig_tag_ids": [99],       // JSON array → woo_tags (fig-*, 1+)
  "feat_tag_ids": [42],      // JSON array → woo_tags (feat-*, 0+)
  "price_per_bdft": 12.50,   // from pricing_rules
  "price": 12.00,            // 2 decimals
  "price_source": "recommendation|override|null",
  "title": "string|null",
  "short_title": "string|null",
  "description": "string|null",
  "content_source": "manual|llm|null",
  "client_rev": 1
}

Photos come as multipart files[] + meta[] alongside this JSON (wrapped in a multipart request where one part is the JSON and the others are the files).

Slab (read model)

All SlabCreate fields (resolved) plus: status, species_confidence, woo_product_id, published_at, server_rev, created_at, updated_at, photos: [PhotoRead], inference_status: null|inferring|done|failed, inference_error: string|null.

PhotoRead

{ "id": "uuid", "kind": "inventory", "role": "topdown|extra",
  "seq": 1, "original_url": "/api/v1/slabs/{id}/photos/{pid}/original",
  "processed_url": "/api/v1/slabs/{id}/photos/{pid}/processed|null" }

InferenceCall1Result (returned by infer-taxon)

Taxonomy fields are Woo IDs from the synced cache. Character/inclusions/voids/checks are free-text observations; the server maps them to Woo feat-* product tags after the call returns. WooCommerce is the authoritative source for feat-* definitions.

{ "species_id": 42, "species_confidence": 0.92,
  "wood_category_ids": [15, 23],
  "edge_type_term_id": 8,
  "figure_term_ids": [3], "figure_confidence": 0.87,
  "grade_term_ids": [7], "grade_confidence": 0.75,
  "character": { "type": "knot", "severity": "minor" },
  "inclusions": { "type": "bark pocket", "severity": "none" },
  "voids": "none",
  "checks": "none",
  "wood_categories": [ { "name": "Live edge", "confidence": 0.95 },
                       { "name": "Bowl blank", "confidence": 0.82 },
                       { "name": "Table slab", "confidence": 0.61 } ] }

InferenceCall2Result (returned by infer-content)

{ "title": "string", "short_title": "string", "description": "string" }

PriceRule

{ "id": "uuid", "species": "string", "price_per_bdft": 12.50,
  "created_at": "timestamp", "updated_at": "timestamp" }

SettingsView (read; secrets masked)

{ "woo_base_url": "https://www.whidbeywoodstore.com",  // WOO_BASE_URL env; read-only
  "woo_wp_username": "slab-uploader",   // non-secret identity; password never returned
  "woo_credentials_configured": true,
  "inference_base_url": "http://192.168.1.202:8080/v1",
  "inference_model": "<model>", "inference_enabled": true,
  "content_llm_enabled": false,
  "brand_voice": "...", "geo_context": "...",
  "woo_create_status": "draft",
  "aspect_ratio": "3:4", "output_px": 1600, "output_px_min": 1600,
  "fill_target": 0.80 }

Secrets (application password, inference API key) are never returned. Only a *_configured boolean. Woo auth is WordPress Application Passwords (woo_wp_username + woo_app_password write-only), not consumer keys. Sheet/slider prefs are client localStorage only in POC (not in SettingsView).

---

Endpoints

Health & meta

• GET /api/health → { "status":"ok", "version":"...", "woo_reachable": bool } (canonical deploy/smoke path; may also be exposed as /api/v1/health)
• GET /api/v1/meta → { "version":"...", "templates_configured": bool }

Slabs

• POST /api/v1/slabs — Create a calibrated draft. Body: multipart with data (SlabCreate JSON) + files[] (photos) + meta[] (photo metadata).
  • Returns 201 Slab with status: "calibrated" (mask + axis confirmed; client-sent sqft/bdft/widths stored).
  • Server auto-runs Call 1 only if inference_enabled is true. inference_status becomes inferring, then done/failed.
  • After Call 1, persist inferred values onto the slab only for fields with confidence ≥ 0.7. Below 0.7 leave those columns null so GET does not prefill.
  • 409 duplicate_sku if SKU already exists in Woo, any status (payload as PUT).
• GET /api/v1/slabs → 200 [Slab] (most recent first).
• GET /api/v1/slabs/{id} → 200 Slab / 404.
  • Also used as the poll endpoint for inference and publish. Long-running ops set status to inferring/publishing; client backs off (1s, 2s, 4s, cap 10s).
• PUT /api/v1/slabs/{id} — Update draft fields. Body: partial SlabCreate (any subset of editable fields + client_rev).
  • Server stores client-sent derived fields (sqft, bdft, widths). It may validate shape and ranges. It must not recompute mask, sqft, bdft, or widths as source of truth. Client re-runs TECH-SPEC math and PUTs the new numbers.
  • 409 revision_conflict.
  • 409 duplicate_sku → { "error": "duplicate_sku", "sku": "...", "woo_admin_url": "..."? }. UI maps this to the SKU field (docs/UX.md). Never show the code.
  • 422 stale/invalid field → { "error": "stale_field", "field": "species_id", "options": [...] } after a submission-time taxonomy refresh. UI maps to that field. Draft stays.
• DELETE /api/v1/slabs/{id} → 204. Soft: only unpublished drafts. Published slabs cannot be deleted from the app.

Photo operations

• POST /api/v1/slabs/{id}/u2net/{pid} — post-POC. "Try harder." Server runs U2Net on this one photo, returns a better mask. Do not implement or expose in Gate C / first listing. Keep the contract; do not delete.
  • Returns 202 { mask_url: "..." }. Client uses the mask to re-compute area/widths locally.
  • 404 if photo not found.
• GET /api/v1/slabs/{id}/photos/{pid}/original → image/* (original, while retained).
• GET /api/v1/slabs/{id}/photos/{pid}/processed → image/* (processed PNG, while retained).
  • After publish, both → 410 Gone.

Inference

• POST /api/v1/slabs/{id}/infer-taxon — Trigger or retry Call 1 (vision).
  • Server reads the Call 1 prompt file fresh, uses cached taxonomy + original photos downscaled to 1024px + user metadata, and sends to the configured vision endpoint.
  • Returns 202 { "status": "inferring" }. Client polls GET /api/v1/slabs/{id} for results.
  • Timeout > 45s → 504 gateway_timeout with error detail.
• POST /api/v1/slabs/{id}/infer-content — Trigger Call 2 (text).
  • Server reads the Call 2 prompt file fresh. Default: resend full Call 1 context (prompt + assistant JSON + confirmed vs inferred labels). Use previous_response_id only if test-inference reported stateful support. Per-slab thread; delete on publish or abandon.
  • Taxonomy + deterministic numbers + brand/GEO; LLM prose then templates.
  • Requires test-inference ok: true. Else 422 (not connected / not portable).
  • Returns 202 { "status": "inferring" }. Client polls for results.
  • Timeout > 45s → 504 with error detail.

Publish

• POST /api/v1/slabs/{id}/publish — Publish to WooCommerce.
  • Pre-conditions: status in ready, mandatory set (exactly one species, ≥1 wood category, ≥1 figure, remaining listing fields). Else 422 unpublishable with field keys — UI maps, no raw code.
  • Dedupe: if SKU already exists in Woo under any status → 409 duplicate_sku (same payload as PUT).
  • Stale Woo value → 422 stale_field as above. Draft stays on the phone.
  • Returns 202 { "status": "publishing" }. Client polls.
  • Woo failure → slab failed, sync_log written, poll returns 502 woo_error.
  • Success → slab published, woo_product_id set, images purged, draft row deleted.

Taxonomy

• GET /api/v1/admin/taxonomy → 200 taxonomy grouped by kind:

  { "categories": [...], "attributes": [{ name, slug, terms: [...] }],
    "tags": [...],
    "taxonomy_updated_at": "ISO-8601" }
  

  Client re-pulls if taxonomy_updated_at is newer than its snapshot. Species/attribute/tag lists here are the only legal options for UI pickers and Call 1.
• POST /api/v1/admin/taxonomy/sync → 200 { "categories": n, "attributes": n, "tags": n, "taxonomy_updated_at": "..." }.
  • Pulls from Woo, rebuilds the cache. Bump taxonomy_updated_at only if a stored-subset row changed. 502 woo_error on failure; previous cache retained.

Pricing

• GET /api/v1/admin/pricing → [PriceRule]
• POST /api/v1/admin/pricing → 201 PriceRule
• PUT /api/v1/admin/pricing/{id} → 200 PriceRule
• DELETE /api/v1/admin/pricing/{id} → 204

Settings

• GET /api/v1/settings → 200 SettingsView
• PUT /api/v1/settings — Update settings. Body: partial { key: value }.
  • woo_base_url is not writable (ignore or 422). SoT is WOO_BASE_URL env (HTTPS, compose). GET still returns it for read-only Settings text.
  • Woo credential keys: woo_wp_username (plain) and woo_app_password (write-only; AES-GCM at rest). Reject any payload that still sends woo_consumer_key / woo_consumer_secret.
  • Secrets re-encrypted server-side. 200 SettingsView returned (password never echoed).
• POST /api/v1/settings/test-woo → 200 { "ok": bool, "detail": "...", "taxonomy_updated_at": "..." }
  • Uses stored username + application password over HTTPS Basic Auth against WOO_BASE_URL REST v3. Fails closed if credentials missing or URL is not https.
  • On success, always run a taxonomy resync (bump anchor only if rows changed).
• POST /api/v1/settings/test-inference → 200 { "ok": bool, "vision_capable": bool, "portable_resend": bool, "stateful_previous_response_id": bool, "detail": "..." }
  • Probe whether Call 1→Call 2 can use full-history resend and/or previous_response_id.
  • Fail closed (ok: false) if neither portable resend nor stateful id works. Call 2 must not run.
• GET /api/v1/validation-module → 200 { "hash": "...", "rules": { ... } }
  • Shared FastAPI module. Client caches it. Compare hash on submit only.
  • Length rules are hard input caps. Field-exit uses the cache locally.

---

Request/response examples

Create a slab (multipart)

POST /api/v1/slabs
Content-Type: multipart/form-data; boundary=---

---
Content-Disposition: form-data; name="data"
Content-Type: application/json

{ "id":"9f1c...","sku":"BW-0042","length_in":96.0,"thickness_in":1.5,
  "sqft":0.64,"bdft":0.96,"width_min_in":14.0,"width_max_in":22.0,
  "width_avg_in":18.2,"species_id":42,"wood_category_ids":[15,23],
  "edge_type_term_id":8,"figure_term_ids":[3],"grade_term_ids":[7],
  "thickness_term_id":12,"moisture_term_id":5,"fig_tag_ids":[99],
  "price_per_bdft":12.50,"price":12.00,"price_source":"recommendation",
  "title":null,"short_title":null,"description":null,
  "content_source":null,"client_rev":1 }

---
Content-Disposition: form-data; name="files[]"; filename="topdown.jpg"
Content-Type: image/jpeg

<binary>
---
Content-Disposition: form-data; name="meta[]"
Content-Type: application/json

{ "kind": "inventory", "role": "topdown", "seq": 1 }
---

Response: 201

{ "id":"9f1c...","sku":"BW-0042","status":"calibrated",
  "inference_status":"inferring","server_rev":1,"photos":[...],... }

Call 1 completes (poll)

GET /api/v1/slabs/9f1c...
→ 200 { "status":"calibrated","inference_status":"done",
         "species_id":42,"species_confidence":0.92,
         "wood_category_ids":[15],"edge_type_term_id":8,
         "figure_term_ids":[3],"grade_term_ids":[7],
         "inference_error":null, ... }

Call 2 (user taps Generate)

POST /api/v1/slabs/9f1c.../infer-content
→ 202 { "status":"inferring" }
GET /api/v1/slabs/9f1c...
→ 200 { "title":"Black Walnut 8ft 0in × 18.2in Slab — Cathedral",
         "short_title":"Black Walnut Slab — Cathedral",
         "description":"A one-of-a-one cathedral black walnut slab...",
         "content_source":"llm", ... }

Publish

POST /api/v1/slabs/9f1c.../publish
→ 202 { "status":"publishing" }
GET /api/v1/slabs/9f1c...
→ 200 { "status":"published","woo_product_id":1042,"published_at":"..." }

Taxonomy sync

POST /api/v1/admin/taxonomy/sync
→ 200 { "categories": 24, "attributes": 5, "tags": 12, "synced_at": "..." }

Test connections

POST /api/v1/settings/test-woo
→ 200 { "ok": true, "detail": "Connected to Whidbey Wood Store" }

POST /api/v1/settings/test-inference
→ 200 { "ok": true, "vision_capable": true, "detail": "Model Qwen3.8-27B confirmed" }

---

Versioning

URL is /api/v1. Breaking changes bump to /api/v2. The SvelteKit client pins the version it was built against.

Out of contract (v1)

• Bulk endpoints, staff/role endpoints, webhook push, analytics.