Concepts overview

This page defines the main ideas you will see across the Integration API and dashboard. Implementation details of hosting and internal systems are omitted on purpose.

Business account (User)

A business account is your brand or platform’s DrapeItOn account. It owns API keys, credits, webhook configuration, and optional end-user (shopper) limits.

Accounts are invite-only beta; there is no public self-registration. See Introduction to request access.

API key

An API key authenticates Integration API requests. Create keys in the dashboard. The full secret is shown once at creation; later you only see a masked form. You may have up to 10 active keys.

Send the secret with each Integration API request as X-API-Key or Authorization: Bearer. Details: Authentication.

If an administrator blocks the account, programmatic try-on and dashboard access are disabled until unblocked.

End-user (shopper)

An end-user is a shopper on your site or app. They do not create a DrapeItOn account. You may pass an optional end_user_id on generation requests so the platform can enforce per-shopper cooldown and monthly limits you configure in the dashboard. See End-user limits.

Generation

A generation (try-on job) takes a person image URL, a garment image URL, and a garment category, then produces a result image (or a failure). Jobs are asynchronous: you receive a job id immediately, then poll or wait for a webhook.

Statuses and lifecycle: Generations.

Credit

A credit is the unit of try-on usage. Submitting a generation reserves one credit. Balance is available via GET /v1/credits. Credits reserved for jobs that fail terminally are returned to your balance. See Credits.

Webhook

A webhook is an HTTPS endpoint you host. When a generation finishes, DrapeItOn can POST an event (generation.completed or generation.failed) so you do not have to poll. Configure URLs and secrets in the dashboard. See Webhooks.

Integration API vs dashboard

Related

• Introduction — product positioning
• Quickstart — first request