SporalizeLabs-api / README.md
Shoraky's picture
Fix xome issues
f09becf
metadata
title: Sporalize API
emoji: 
colorFrom: blue
colorTo: green
sdk: docker
app_port: 7860
pinned: false

Sporalize API

Public Docker Space for the Sporalize backend API.

Runtime behavior:

  • Does not bundle private runtime code or model assets in the public image.
  • Loads pipeline.py, ViTPose, optional Weights, and seeded Storage from the private runtime repo at startup.
  • Defaults SPORALIZE_ASSETS_REPO_ID to SPORALIZE_STORAGE_REPO_ID, which defaults to Shoraky/SporalizeLabs-runtime-private.
  • Downloads model weights at startup if they are not already present in the private repo or cache.
  • Serves the FastAPI API on port 7860.
  • Exposes /healthz with pipelineSource, pipelineRoot, and private asset repo metadata so the frontend deployment can verify which pipeline source is active.

Required deployment secret:

  • HF_TOKEN: token with read access to the private runtime repo and write access if archive storage sync is enabled.

Optional deployment variables:

  • SPORALIZE_ASSETS_REPO_ID: override the private repo that provides pipeline.py and ViTPose.
  • SPORALIZE_ASSETS_REVISION: pin the private pipeline to a branch, tag, or commit.
  • SPORALIZE_STORAGE_REPO_ID: override the private repo used for persistent Storage sessions.
  • SPORALIZE_PUBLIC_BASE_URL: public API URL used when returning /storage/... links.
  • CORS_ALLOW_ORIGINS: comma-separated frontend origins; omit or set * for open CORS.