Tryonnex SDK

The official Node.js SDK for the Tryonnex API. Integrate photorealistic AI Virtual Try-On into your e-commerce store, mobile app, or web application in minutes.

Features

• Simple Integration: Perform complex AI try-ons with a single function call.
• Type-Safe: Full TypeScript support with included type definitions.
• Promise-based: Modern async/await API.
• Credits Management: Built-in methods to check user balance.
• Lightweight: Zero heavy dependencies.

Installation

Install the package via your preferred package manager:

npm install tryonnex-sdk
# or
yarn add tryonnex-sdk
# or
pnpm add tryonnex-sdk

Quick Start

1. Get your API Key

Sign up at tryonnex.com to get your free API key.
New accounts receive 5 free credits.

2. Usage Example (TypeScript)

import { Tryonnex } from 'tryonnex-sdk';

// Initialize the client
const client = new Tryonnex({
  apiKey: 'sk_live_YOUR_API_KEY_HERE',
});

async function main() {
  try {
    console.log("Generating Try-On...");

    const result = await client.generate({
      human_image: 'https://example.com/model.jpg',
      garment_image: 'https://example.com/shirt.jpg',
      category: 'upper_body', // 'upper_body' | 'lower_body' | 'dresses'
    });

    console.log("Success!");
    console.log("Result URL:", result.result_url);
    console.log("Credits Remaining:", result.credits_remaining);
  } catch (error: any) {
    console.error("Error:", error.message);
  }
}

main();

API Reference

generate(params)

Generates a virtual try-on image by merging a person image and a garment image.

Parameters

| Name | Type | Required | Description | |------|------|----------|-------------| | human_image | string | Yes | Public URL of the model/person image | | garment_image | string | Yes | Public URL of the clothing item | | category | string | No | Default: upper_body. Options: upper_body, lower_body, dresses |

Returns (Promise)

{
  success: boolean;
  result_url: string;
  credits_remaining: number;
  processing_time?: string;
}

getCredits()

Check your current credit balance and plan details.

Returns (Promise)

{
  credits: number;
  plan: string;
}

Error Handling

The SDK throws standard JavaScript errors. Always wrap calls in a try/catch block.

| Status Code | Error Message | Meaning | |------------|--------------|--------| | 401 | Unauthorized | Invalid or missing API key | | 402 | Payment Required | Insufficient credits | | 400 | Bad Request | Missing required parameters | | 500 | Server Error | Internal server error |

License

MIT © Tryonnex