Developer Docs

Getting Started

Browse documentation

Introduction

API Reference

Account & Billing

Resources

Examples
FAQ

APIonWeb is a general-purpose API marketplace — this guide walks through calling its first live API, Virtual Try-On, from a fresh account to a successful response. The same account, API key, and billing model will apply to every API added to the platform.

1. Create an account

Sign up for an APIonWeb account and verify your email. Every new verified account receives a $5 non-withdrawable welcome balance — enough to make real requests without adding a payment method first.

2. Create an API key

From Dashboard → API Keys , create a new key. It's shown to you once, at creation time — copy it somewhere safe (a password manager or secrets store). Keys are standard bearer tokens in the format {id}|{40-character-token}. See API Keys for details.

3. Make your first request

Send the API key as a Bearer token in the Authorization header. This example tries on a pair of glasses — a real-time/3D category that responds synchronously:

curl -X POST https://apionweb.com/v1/virtual-try-on \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "glasses",
    "person_image": "https://example.com/person.jpg",
    "product_model": "https://example.com/glasses-model.glb"
  }'

<?php

$ch = curl_init('https://apionweb.com/v1/virtual-try-on');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_API_KEY',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'category' => 'glasses',
        'person_image' => 'https://example.com/person.jpg',
        'product_model' => 'https://example.com/glasses-model.glb',
    ]),
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

use Illuminate\Support\Facades\Http;

$response = Http::withToken('YOUR_API_KEY')
    ->post('https://apionweb.com/v1/virtual-try-on', [
        'category' => 'glasses',
        'person_image' => 'https://example.com/person.jpg',
        'product_model' => 'https://example.com/glasses-model.glb',
    ]);

$result = $response->json();

const response = await fetch('https://apionweb.com/v1/virtual-try-on', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    category: 'glasses',
    person_image: 'https://example.com/person.jpg',
    product_model: 'https://example.com/glasses-model.glb',
  }),
});

const result = await response.json();

const https = require('node:https');

const payload = JSON.stringify({
  category: 'glasses',
  person_image: 'https://example.com/person.jpg',
  product_model: 'https://example.com/glasses-model.glb',
});

const req = https.request('https://apionweb.com/v1/virtual-try-on', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    'Content-Length': Buffer.byteLength(payload),
  },
}, (res) => {
  let data = '';
  res.on('data', (chunk) => (data += chunk));
  res.on('end', () => console.log(JSON.parse(data)));
});

req.write(payload);
req.end();

import requests

response = requests.post(
    'https://apionweb.com/v1/virtual-try-on',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    json={
        'category': 'glasses',
        'person_image': 'https://example.com/person.jpg',
        'product_model': 'https://example.com/glasses-model.glb',
    },
)

result = response.json()

4. Read the response

A successful synchronous request returns the rendered result image straight away, along with what it cost:

application/json

{
  "request_id": "8f14e45f-2d1a-4b3c-9e4a-2f6b1c9d0e12",
  "status": "success",
  "category": "glasses",
  "result": {
    "image_url": "https://cdn.apionweb.com/results/8f14e45f....png"
  },
  "cost": {
    "amount": "0.05",
    "currency": "USD"
  },
  "processing_time_ms": 842
}

Some categories (shirts, dresses, jackets, and other AI-generative outfits) are processed asynchronously — the initial request returns a status: "processing" and you poll for the result, or supply a webhook. See Virtual Try-On and Webhooks.

Next steps

Authentication — how API keys are validated and what errors look like.
Virtual Try-On reference — every supported category and request shape.
Errors — the full list of error codes and HTTP statuses.
Usage & Billing — pricing per category and how recharges work.