Setup & API guide
Tryveliq turns a garment image and a model reference into a reviewed clothing preview. It runs inside Shopify and exposes the same workspace to a secure server-to-server API.
1. Connect and choose a plan
Open Tryveliq from Shopify Apps. Choose a paid plan and approve it on Shopify’s pricing page. The app checks the confirmed subscription before enabling the catalog, studio and API. If you return without approving, access stays locked. Contact support for installation access while the public listing is in preparation.
2. Prepare products and images
Shopify products synchronize automatically after a plan is approved; Sync Shopify explicitly refreshes the catalog. Attach a garment image to each product. Upload a model/avatar reference that you own or are authorized to use. The app resizes PNG/JPEG inputs to a maximum of 512 pixels per side. Use clear, front-facing images, an unobstructed garment and a fully clothed model.
3. Generate and review
Choose the product and model in Studio. Submit a generation, wait for it to complete and examine the actual result. Verify prints, seams, sleeves, face and proportions. A failed job does not consume the monthly allowance. Only completed, reviewed results can be published.
4. Add the storefront block
- Sync the product from Shopify in Products, then approve a generated preview or save its measurement chart. Manually created API products are not linked to Shopify product pages.
- Open Online Store → Themes → Customize and select the product template used by your prepared product.
- Choose Add block → Apps → Tryveliq fitting room. If the section does not support app blocks, choose Add section → Apps. An Online Store 2.0 theme with app-block support is required.
- Select the prepared product in the theme preview, adjust the block position and button label, then save. Open the fitting room on that product page and check its content.
Knowledge and Settings in the app include a shortcut that adds an unsaved block in the current theme. Edit an existing Tryveliq block instead of adding a duplicate. Keep Show photo-free guides and approved previews enabled in Settings. If the subscription is inactive, the setting is off, or the product has no approved preview or chart, the button stays hidden.
To remove the button, remove the Tryveliq block in the theme editor and save. To hide all previews and charts, turn off Show photo-free guides and approved previews in app Settings.
5. Add size guidance
Use body-measurement ranges from your own size chart, in centimeters. These are body ranges, not the flat width of the garment. The storefront compares shopper entries locally without sending measurements to Tryveliq. The result is chart-based guidance, not a fit guarantee.
Photo-free assistant
The result updates when required fields are complete. Shoppers can switch between centimeters and inches, focus a field for visual measuring instructions and compare any two configured sizes with exact per-dimension differences. Comparison uses BODY ranges, not garment ease; it never recommends an unavailable replacement or predicts child growth. A source-approved growth mapping is required for the existing growth preference.
An adult or guardian may explicitly save up to three anonymous measurement slots in this browser tab for up to 24 hours, reuse them on other products at this shop, and delete all saved slots. No photo, name, age or shopper account is needed. Examples cannot be saved. Closing clears current inputs; saved slots are opt-in. The optional styling image is not a fit simulation.
Merchant readiness and usage
Dashboard → Photo-free fit insights shows actual guide sizes and 30-day, consent-based per-product event counts. Export displayed rows to CSV. Example checks are excluded. Counts are not unique shoppers, purchases, conversion rates or saved returns. Settings controls collection, which also requires shopper analytics consent. Products can be filtered by missing or configured measurement guides. Reuse a guide only on explicitly selected compatible products.
API quick start
Create a workspace API key in the paid app’s API page. The key is shown once. Keep it in your backend environment. Base URL: https://tryveliq.hakan-olcer.workers.dev/v1.
curl "$TRYVELIQ_URL/v1/products" \
-H "Authorization: Bearer $TRYVELIQ_API_KEY"Set TRYVELIQ_URL=https://tryveliq.hakan-olcer.workers.dev. The key must belong to a workspace with an active verified subscription.
| Endpoint | Purpose |
|---|---|
| GET /products | List workspace products |
| POST /products | Create a product |
| PATCH /products/{id} | Attach a garment asset and size chart |
| POST /assets?kind=avatar&name=Model | Upload raw PNG/JPEG bytes |
| POST /generations | Queue a preview |
| GET /generations/{id} | Poll status and obtain a temporary result URL |
| POST /recommendations | Compare measurements with a supplied chart |
Upload requirements
PNG/JPEG only, 32–512 pixels per side, maximum 2 MB. Set the correct Content-Type and X-Image-Rights-Confirmed: true. Use kind=garment or kind=avatar. Binary uploads are raw bytes, not JSON or multipart.
Start a generation
curl "$TRYVELIQ_URL/v1/generations" \
-H "Authorization: Bearer $TRYVELIQ_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: your-unique-request-id" \
-d '{"productId":"PRODUCT_ID","avatarId":"AVATAR_ASSET_ID"}'Poll the returned job ID. Statuses are queued, running, completed and failed. Result URLs expire after ten minutes; request a fresh one by reading the job again. Use the dashboard to publish results; an API key cannot manage billing, publish previews or create other keys.
Limits and errors
Workspace requests are limited to 120 per minute. Generation allowances depend on the plan and are shared with the dashboard. The monthly allowance resets on the first UTC day of the month. Responses use 401 for invalid authentication, 402 for a required subscription, 403 for insufficient permissions, 429 for limits and 503 when billing verification is temporarily unavailable. The API fails closed if it cannot verify paid access.