Skip to content

API

Integrate API into your product

To generate images via our API, a API How to get started and you need a filter reference — either an integer ID or a UUID. Every filter is built for a specific model (FaceSwap or MultiSwap). There are three ways to obtain one.

1. Standard Filter IDs (integers)

Free for all subscribers. Curated by our team. Each filter targets a specific model.

Retrieve them via API:

Model Endpoint
FaceSwap (v5) GET /v5/filters
FaceSwap (v6) GET /v6/filters
MultiSwap Realistic GET /v1/realistic_multiswap_styles/
MultiSwap Stylized GET /v1/stylized_multiswap_styles/

Or browse the Filter Gallery

FaceSwap filter IDs work with both v5 and v6 endpoints, but visual results will differ between versions.

2. Paid Filters (UUIDs)

Custom filters created by our team for your specific use case.

  • Contact us via email or the wizard on your dashboard.
  • You receive a UUID and the information about which endpoint to use (FaceSwap v5/v6 or MultiSwap/MultiSwap Stylized).
  • Or retrieve all your filters programmatically: GET /v1/users/me/my-custom-filters — returns UUIDs, preview images, and the filter_type field. For details on the response format, see Retrieve Retrieve UUID Filter Informations

3. Self-Created Filters (UUIDs)

Build your own filters in the Filter Creator webapp.

  • Filter Creator Documentation
  • When creating a filter you select the target model (FaceSwap or MultiSwap). Note down which model you built it for.
  • Retrieve the UUID from the Manage Filters page in the Filter Creator.
  • Or retrieve all your filters programmatically: GET /v1/users/me/my-custom-filters — returns UUIDs, preview images, and the filter_type field.For details on the response format, see Retrieve Retrieve UUID Filter Informations

Using Aliases (optional)

Applies to paid and self-created filters. An Alias is a stable UUID that points to a filter. Swap the underlying filter without changing your code.

Important: An alias must always point to a filter of the same model type. If the alias is reassigned to a different type, your integration will return an error. Type-safe aliases (separate v5/v6/multiswap alias types) are under construction.

Choose Your Model

Now that you have a filter reference and know its model type, pick the matching integration guide:

Model Use case Guide
FaceSwap v6 Single-person AI transformations (recommended) FaceSwap Integration Guide
FaceSwap v5 Single-person (same process as v6, different results) Swagger UI
MultiSwap Realistic v5 Group photo transformations MultiSwap Integration Guide
MultiSwap Stylized v1 Artistic group transformations (same process as Realistic) Swagger UI