Velox Developer Hub — DressMe & TriFit

Build virtual try-on into your website, app or retail platform. DressMe turns a shopper photo and a garment image into an AI outfit preview. TriFit is Velox's consumer experience.

This repository is the public home for Velox SDK source, runnable integrations, tutorials and AI-agent integration skills. Start with the demo, then inspect the exact SDK implementation behind it.

Start here

Two public pages, not the Velox operator admin. The dashboard shows only the visitor's own browser-session requests and public SDK downloads. It exposes no keys, routing, quota editing, other visitors' photos or traffic-test controls. Hosted UI updates follow the Studio Development-to-Production release gates; the public host may run an earlier accepted version than the source you inspect.

Install the Codex plugin

See installation and test prompts. The GitHub marketplace package is separate from universal directory review and approval.

One demo, one inspectable SDK integration

The hosted application is this repository's browser UI, demo backend and shared queue, using the JavaScript SDK. It is not a separate partner-specific application or a mock presented as real generation.

• Dedicated hosted partner identity: demo.
• Real DressMe requests; AnimateMe is not enabled for the public demo.
• Signed, durable webhook completion with delayed GET-only recovery if a callback is missing. The UI labels the actual completion source.
• Total elapsed duration, uploads, demo queue and submission-to-observed-completion timings. These are not GPU-only timings.
• Download one look, or all your latest 25 completed requests, as an asset ZIP containing uploaded inputs, results and a timing/checksum manifest. This is separate from the SDK source ZIP.
• One active generation, and at least 10 seconds between starts.
• Personal and product uploads overlap, with durable receipts for both assets. This removes sequential upload waiting without changing generation quality or bypassing the queue and usage limits.
• The dashboard ZIP contains this same public source, SDK, examples and guides.
• No API key is needed to visit the Velox-hosted demo.
• To run your own real backend, apply for your own partner configuration.

The checked-in configuration template identifies the demo integration and Production API URL, but its key is deliberately invalid and real generation is disabled. It is not a public API credential. The hosted service loads the real key privately on Velox's server. It never appears in GitHub, JavaScript sent to the browser or public ZIP downloads.

Run locally

Install Node.js 22 or later. No dependency installation is required:

npm run preview

Open the printed URL. The demo and dashboard work locally; the preview cannot upload or generate. The dashboard's ZIP download works in preview too.

Explore the reference workspace

The public workspace follows the fuller partner-demo layout, with a developer sidebar linking to the public code, SDK ZIP, walkthrough and access application.

• Add up to eight shopper photos and eight product images to local trays. Select a pair and inspect it before sending a request. Adding, selecting or removing a preview performs no upload or generation.
• JPEG, PNG and WebP photos are prepared locally in the browser: automatically resized to at most 2048 pixels on the longest side (never enlarged), with aspect ratio and browser-decoded orientation preserved. Your original files are untouched; only the prepared copies are submitted. No upload occurs while selecting or preparing images. Output stays within the API's 5 MiB cap. For browser safety, source files above 32 MiB or 100 megapixels are rejected with a prominent error. Unsupported or corrupt files also show clear errors.
• Only an explicit consented submission sends the selected pair. The example uploads the pair for each new request; trays are not a persistent asset-ID catalogue or a shared partner library.
• Review the request stages, original inputs, completed result and side-by-side shopper/result comparison. Local inputs are held only in the open page's memory; after reload, request history and available results can be read, not old inputs.
• History shows only this signed browser session's latest 25 requests. Refreshing history or checking an uncertain request is read-only and never replays a job.

No production/development selector, shared photo library, routing, webhook registration or load-test controls are exposed by this public UI. The private partner workbench is unchanged.

For real access:

1. Contact Velox, mentioning Partner API / DressMe, your platform, expected usage and launch timing.
2. Velox reviews your request, creates a unique partner integration and emails private, environment-specific configuration.
3. Save the supplied partner.config.json beside package.json.
4. Run npm start. Startup verifies the assigned API identity and environment.

For webhook-first completion, ask Velox to grant webhooks:write on your own backend key, then register your public HTTPS receiver:

node setup-webhook.mjs https://YOUR_HTTPS_HOST/webhooks/dressme
npm start

The setup command saves the endpoint ID and signing secret privately in partner.config.json. Hosted mounting prefixes must be included in the callback URL. See hosting for the exact origin/proxy contract. With no webhook configured, the local example remains explicitly polling-only; it does not claim webhook delivery. The standalone mock remains an unpaid API-flow fixture.

A free TriFit account is not a partner credential. Real API use can incur charges, including in Development. Never commit the private configuration or reuse the Velox-hosted demo key in another deployment.

Available SDKs

JavaScript (Node.js) + TypeScript declarations are available now, under MIT: SDK source · SDK reference.

The runnable demo is one complete integration of this SDK. More language packages, framework examples and agent guides can be added to this hub; the catalogue lists only implementations that actually exist. Other languages may use the documented HTTP API, but are not advertised as downloadable SDKs until shipped and tested.

Queue, privacy and safe recovery

The 10-second gap is a minimum start interval, not an ETA or performance guarantee. A job taking longer keeps the active slot until it finishes. One pending request per visitor and a backlog of 25 bound temporary admission; there is no lifetime request cap in the example. Velox API quotas and commercial permissions still apply. The newly created hosted partner currently has its default 100/month allowance; this repository does not silently increase it.

Browser sessions are private, signed and HttpOnly, with Secure cookies on HTTPS. The dashboard is session-scoped; clearing cookies loses access to that session's history. A 48-hour cookie expiry is not automatic media deletion. Image consent, the privacy policy and agreed retention apply.

The local evaluator stores receipts in ignored .demo-state/, with a single exclusive owner. It saves input IDs, idempotency keys and job IDs, not image bytes, API keys or signed URLs. An uncertain submission pauses the queue; it is never automatically replayed. After a crash, retain the journal and lock for operator reconciliation. Do not run multiple copies with the shared demo credential.

See hosting and release requirements and security. The queue's rate limit alone is not a financial budget or full bot defence.

Test without paid API calls

npm test
npm run demo:mock
npm run demo:failure

Tests and explicit mock modes use local fixtures only. They do not read private configuration or call Velox. A mock result is not a real AI result or latency proof.

Licence

The public SDKs, examples, documentation and agent skill in this repository are MIT licensed. This does not license Velox's hosted API service, private product code, trademarks or customer material. API access and usage remain subject to separately agreed terms. AI previews are not guarantees of fit, sizing, colour or garment detail.