=== URL: https://useapi.net/docs/start-here/setup-faceswap ===
Document URL: https://useapi.net/docs/start-here/setup-faceswap
---
layout: default
title: Setup InsightFaceSwap
parent: Start Here
nav_order: 500
---
# <img style="height:1.8em;vertical-align: middle;" src="https://useapi.net/assets/images/picsi.png"> Setup InsightFaceSwap 
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

<small>Approximately 3 minutes to complete setup steps.</small>  

---

## Create Discord account

You need a [Discord](https://discord.com) account to interact with [InsightFaceSwap Discord bot](https://discord.gg/Ym3X8U59ZN). Create a [new account](https://discord.com/register) if you don't have one already.

Please note even if you have an existing Discord account we are **strongly** recommending creating a separate Discord account specifically designated to be used with useapi.net API.   

## Create Discord server 

Please log in to your Discord account and create a new Discord server following [official instructions](https://support.discord.com/hc/en-us/articles/204849977-How-do-I-create-a-server-).


## Create `#api` text channel on your Discord server 

Once you created the Discord server you need to create a designated for API-related work text channel. You can refer to [official instructions](https://support.discord.com/hc/en-us/articles/4412085582359-Text-Channels-Text-Chat-In-Voice-Channels) to learn about Discord channels and how to manage them on your server. We suggest naming the text channel `#api` for clarity and also making that channel private. Please see [Midjourney instructions](https://docs.midjourney.com/docs/invite-the-bot) to learn how you can restrict the bot to a single private channel.

## Join Picsi.Ai - Powered by InsightFace Discord Server 

Follow Picsi.Ai [instructions](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md) and join official [Picsi.Ai - Powered by InsightFace Discord Server](https://discord.gg/Ym3X8U59ZN).

## Add InsightFaceSwap bot to your Discord server 

Please follow [official instructions](https://discord.com/channels/1095014106576212101/1128550062683865178/1189604165006135379) to add InsightFaceSwap bot to your Discord server created earlier.

## Example of Discord server with private `#api` text channel and InsightFace bot 

Below you can see we created `useapi` Discord server with private `#api` text channel:

![](../../assets/images/discord_faceswap_server_setup_example.png)

InsightFace bot invited to the server and has access to private `#api` text channel

![](../../assets/images/discord_faceswap_channel_setup_example.png)

## Test InsightFace bot

Navigate to the created above `#api` text channel and execute few InsightFaceSwap bot command(s) to make sure it works.

## Make a note of your server id and channel id values

Your Discord URL looks like `https://discord.com/channels/<server_id>/<chanel_id>` 

In the screenshot above URL is `https://discord.com/channels/1122226477161144546/1122277481822456166` where `1122226477161144546` is your Discord <u>server id</u> and `1122277481822456166` is your private `#api` <u>channel id</u>.

Save both server id and channel id values, you will need those numbers for API.

## Obtain Discord token

There are many tutorials describing how to obtain Discord tokens. Please refer to the following links bellow for additional guidance:
- [How to Find Your Discord Token](https://discordhelp.net/discord-token)
- [How To Get Your Discord Token](https://pcstrike.com/how-to-get-discord-token/)
- [How to get Discord Token](https://linuxhint.com/get-discord-token/)

Keep in mind that anyone with a Discord token can have **full access** to your Discord account so please keep it **safe** and **secure**. To reset your Discord token simply change your Discord password.

## Verify Discord access

<script>
  async function verifyServer() {
    const discord = document.getElementById(`server-discord`)?.value;
    const server = document.getElementById(`server-server`)?.value;      

    const data = { 
        method: 'GET',
        headers: {
          'Authorization': `${discord}`,
          'Content-Type': 'application/json'
        }
      };

      const url=`https://discord.com/api/v10/guilds/${server}`;

      await apiExecute(url, 'server', data);
}  

async function verifyChannel() {
    const discord = document.getElementById(`channel-discord`)?.value;
    const channel = document.getElementById(`channel-channel`)?.value;      

    const data = { 
        method: 'GET',
        headers: {
          'Authorization': `${discord}`,
          'Content-Type': 'application/json'
        }
      };

      const url=`https://discord.com/api/v10/channels/${channel}`;

      await apiExecute(url, 'channel', data);
}
</script>

Once all the above steps are completed you should have the following:
- Discord token
- Discord server id number
- Discord private `#api` channel id number

This only verifies that the token, server id and channel id values are correct. To complete setup, you **MUST** proceed to [POST account/`channel`](../api-faceswap-v1/post-faceswap-account-channel) and complete the configuration.

##### Server 
{: .no_toc }

<form id="server" onsubmit="return false;" class="input-form">
  <div class="input-field">
    <div class="input-field-row">
      <label for="server-discord"><span>Discord token</span>
        <input id="server-discord" type="text"  class="input-element" required aria-required="true" oninput="this.size = this.value.length"> 
      </label>
      <label for="server-server"><span>Discord server id</span>
        <input id="server-server" type="text"  class="input-element" required aria-required="true" oninput="this.size = this.value.length"> 
      </label>
    </div>
    <button id="server-button" class="btn btn-primary fs-3" type="submit" onclick="verifyServer()">Go</button>
  </div>
</form>

<div id="server-response" class="response-placeholder visible-false"></div>

##### Channel
{: .no_toc }

<form id="channel" onsubmit="return false;" class="input-form">
  <div class="input-field">
    <div class="input-field-row">
      <label for="channel-discord"><span>Discord token</span>
        <input id="channel-discord" type="text"  class="input-element" required aria-required="true" oninput="this.size = this.value.length"> 
      </label>
      <label for="channel-channel"><span>Discord channel id</span>
        <input id="channel-channel" type="text"  class="input-element" required aria-required="true" oninput="this.size = this.value.length"> 
      </label>
    </div>
    <button id="channel-button" class="btn btn-primary fs-3" type="submit" onclick="verifyChannel()">Go</button>
  </div>
</form>

<div id="channel-response" class="response-placeholder visible-false"></div>

=== URL: https://useapi.net/docs/api-faceswap-v1 ===
Document URL: https://useapi.net/docs/api-faceswap-v1
---
layout: default
title: InsightFaceSwap API v1
nav_order: 9000
has_children: true
permalink: /docs/api-faceswap-v1
---

# <img style="height:1.8em;vertical-align: middle;" src="https://useapi.net/assets/images/picsi.png"> InsightFaceSwap API v1 
<small>February 2024</small>

This is [experimental](../../docs/legal) API for [InsightFaceSwap Discord Bot](https://discord.gg/Ym3X8U59ZN) by [Picsi.Ai](https://www.picsi.ai/). InsightFaceSwap allows users to swap faces from source image(s) onto different target images. It offers free and paid [subscription](https://www.patreon.com/picsi) models. Paid subscribers have access to a wide selection of extra features such as [HiFidelity Mode](https://www.patreon.com/posts/89036144), [ARTIFY](https://www.patreon.com/posts/picsi-ai-v2-0-97389077), oldify/youngify, morphing multiple faces in one image, and [many more](https://discord.com/channels/1095014106576212101/1128550062683865178).

[Setup InsightFaceSwap](../../docs/start-here/setup-faceswap)

[Postman collection](https://www.postman.com/useapinet/useapi-net/collection) <small>(January 20, 2026)</small>  
[LLM-friendly API spec](https://useapi.net/assets/aibot/api-faceswap-v1.txt) <small>Feed this to your LLM to build integrations</small>

Official documentation links:
- [Discord support channel](https://discord.com/channels/1095014106576212101/1128550062683865178) 
- [Patreon support channel](https://www.patreon.com/picsi/posts)
- [YouTube channel](https://www.youtube.com/@PicsiAi)
  
#### Example source code on GitHub 
* [Face swap and animate images generated by Midjourney using InsightFaceSwap and Pika (using webhook)](https://github.com/useapi/examples/tree/main/imagine-faceswap-animate) February 19, 2024

Developer Community:
* <a href="https://discord.gg/w28uK3cnmF"><img style="height:1em;vertical-align: middle;" src="https://useapi.net/assets/images/discord.svg"> Discord Server</a>
* <a href="https://t.me/use_api"><img style="height:1.3em;vertical-align: middle;" src="https://useapi.net/assets/images/telegram.svg"> Telegram Channel</a>
* <a href="https://www.reddit.com/r/aiAPI"><img style="height:1.3em;vertical-align: middle;" src="https://useapi.net/assets/images/reddit.svg"> Reddit Group</a>


=== URL: https://useapi.net/docs/api-faceswap-v1/del-faceswap-account-channel ===
Document URL: https://useapi.net/docs/api-faceswap-v1/del-faceswap-account-channel
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-delete">DEL</code> faceswap/account/<code class="language-plaintext highlighter-rouge">channel</code>
parent: InsightFaceSwap API v1
nav_order: 400
---
## Delete InsightFaceSwap account
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

{: .delete }
> **https://api.useapi.net/v1/faceswap/account/`channel`**

The `channel` value should correspond to an account configured previously via a [POST](post-faceswap-account-channel) request.

##### Request Headers
``` yaml
Authorization: Bearer {API token}
```

- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Responses 

{% tabs del_account_InsightFaceSwap_response %}

{% tab del_account_InsightFaceSwap_response <span class="http-status-good">204</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204" rel="noreferrer" target="_blank"><span class="http-status-good">204 No Content</span></a> 

{% endtab %}

{% tab del_account_InsightFaceSwap_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>
```json
{
  "error": "Unauthorized",
  "code": 401
}
```
{% endtab %}

{% tab del_account_InsightFaceSwap_response <span class="http-status-bad">404</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404" rel="noreferrer" target="_blank"><span class="http-status-bad">404 Not Found</span></a>

{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  error: string,
  errorDetails: string,
  code: number
}
```

##### Examples

{% tabs del_account_InsightFaceSwap_example %}

{% tab del_account_InsightFaceSwap_example Curl %}
``` bash
curl -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer …" \
     -X DELETE https://api.useapi.net/v1/faceswap/account/<channel> 
```
{% endtab %}

{% tab del_account_InsightFaceSwap_example JavaScript %}
``` javascript
const channel = "Previously configured channel id"; 
const apiUrl = `https://api.useapi.net/v1/faceswap/account/${channnel}`; 
const token = "API token";
const data = { 
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json' }
};
const response = await fetch(apiUrl, data);
const result = await response.json();
console.log("response", {response, result});
```
{% endtab %}

{% tab del_account_InsightFaceSwap_example Python %}
``` python
import requests
channel = "Previously configured channel id" 
apiUrl = f"https://api.useapi.net/v1/faceswap/account/{channel}" 
token = "API token"
headers = {
    "Content-Type": "application/json", 
    "Authorization" : f"Bearer {token}"
}
response = requests.delete(apiUrl, headers=headers)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/del-faceswap-delid ===
Document URL: https://useapi.net/docs/api-faceswap-v1/del-faceswap-delid
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-delete">DEL</code> faceswap/delid
parent: InsightFaceSwap API v1
nav_order: 1100
---
## InsightFaceSwap [/delid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#delid-name) command 
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Use this endpoint to submit the InsightFaceSwap [/delid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#delid-name) command to your [InsightFaceSwap Discord channel](../start-here/setup-faceswap). The result will be returned in the response body and can also be sent as a callback to an optional [`replyUrl`](#request-body). 

This is a blocking call, you will **not** be able to make another call to the same InsightFaceSwap Discord channel until the current call is completed. The average execution time is approximately 3 to 10 seconds. If you expect high load and need to make multiple concurrent calls, please consider setting up [multiple InsightFaceSwap accounts](https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel).

It is **important** not to use the InsightFaceSwap account setup for API access for any purposes other than its intended use, such as executing `/delid` or any other InsightFaceSwap commands _manually_ or in conjunction with _any other_ automation tools. The useapi.net API internally tracks the usage of the InsightFaceSwap account, including the number of currently active executions. Using it for other activities may cause API to function incorrectly.

{: .delete }
> **https://api.useapi.net/v1/faceswap/delid**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
Content-Type: multipart/form-data
```
- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Request Body
```json
{
    "channel": "Discord channel id",
    "idname": "idname param",
}
```
- `channel` is optional when only one [faceswap/account](../api-faceswap-v1/get-faceswap-account) configured. However, if you have multiple accounts configured, this parameter becomes **required**.

- `idname` is **required**, please refer to InsightFaceSwap [/delid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#delid-name) for details.

- `replyUrl` is optional, if not provided value from [useapi.net account](../account-management/get-account) will be used.  
  Place here your callback URL. API will call the provided `replyUrl` once job completed or failed.  
  Maximum length 1024 characters.  
  We recommend using sites like [webhook.site](https://webhook.site) to test callback URL functionality.  

 - `replyRef` is optional, place here your reference id which will be stored and returned along with this job response / result.  
  Maximum length 1024 characters.  
  
##### Responses 

{% tabs post_faceswap-delid_response %}

{% tab post_faceswap-delid_response <span class="http-status-good">200</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>

Field `content` contains message generated by InsightFaceSwap.

```json
{
    "jobid": "<jobid>",
    "verb": "faceswap-delid",
    "status": "completed",
    "idname": "me",
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:04:53.490Z",
    "discord": "<ABC…secured…xyz>",
    "server": "<Discord server id>",
    "channel": "<Discord channel id>",
    "replyUrl": "https://webhook.site/abc",
    "replyRef": "<your optional reference id>",
    "messageId": "<Discord message id>",
     "content": "idname me deleted",
    "timestamp": "2023-09-09T02:04:51.926000+00:00",
    "code": 200
}
```
{% endtab %}

{% tab post_faceswap-delid_response <span class="http-status-bad">400</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" rel="noreferrer" target="_blank"><span class="http-status-bad">400 Bad Request</span></a>

```json
{
    "error": 
      "Required param idname is missing or empty"
      "Optional param replyRef is too long"
      "Optional param replyUrl is too long"
      "Required param channel is missing or empty"
      "Configuration not found for channel <channel>, to create POST v1/faceswap/account/<channel>"
    "code": 400
}
```
{% endtab %}


{% tab post_faceswap-delid_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>

```json
{
    "error": "Unauthorized",
    "code": 401
}
```
{% endtab %}

{% tab post_faceswap-delid_response <span class="http-status-bad">402</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402" rel="noreferrer" target="_blank"><span class="http-status-bad">402 Payment Required</span></a>

```json
{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}
```
{% endtab %}

{% tab post_faceswap-delid_response <span class="http-status-bad">429</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429" rel="noreferrer" target="_blank"><span class="http-status-bad">429 Too Many Requests</span></a>

Wait in a loop for **at least** 10..30 seconds and retry again.

There are two possible cases for API response 429.

1. API query is full and can not accept new [faceswap/delid](#insightfaceswap-delid-command) requests. 
```json
{
    "error": "Unable to lock Discord after <attempts> attempts",
    "code": 429
}
```
2. The API received an HTTP status 429 from the Discord API when it attempted to POST to the `/interactions` endpoint. Under normal circumstances, this should be a rare occurrence because the API is designed to strictly adhere to Discord rate limits. However, in certain scenarios, Discord may still issue a 429 response.
```json
{
    "error": "Discord /interactions failed with HTTP status 429",
    "errorDetails": "{\"global\":true,\"message\":\"You are being rate limited.\",\"retry_after\":10}",
    "code": 429
}
```
{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  jobid: string, 
  verb: 'faceswap-delid',
  status: 'completed' | 'failed',
  idname: string,
  created: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  updated: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  discord: string, // Provided for debugging purposes only, contains the first 3 and the last 3 characters of the original value
  server: string,
  channel: string,
  replyUrl: string,
  replyRef: string,
  messageId: string,
  content: string, // Contains message generated by InsightFaceSwap 
  timestamp: string,
  error: string,
  errorDetails: string,
  code: number
}
```

##### Examples

{% tabs faceswap-delid_example %}

{% tab faceswap-delid_example Curl %}
``` bash
curl -H "Accept: application/json" \
     -H "Authorization: Bearer …" \
     -X DELETE https://api.useapi.net/v1/faceswap/delid \
     -F "channel=<Discord channel id>" \
     -F "idname=<idname>" 
```
{% endtab %}

{% tab faceswap-delid_example JavaScript %}
``` javascript
const main = async () => {
    const apiUrl = "https://api.useapi.net/v1/faceswap/delid";
    const token = "API token";
    const channel = "Discord channel";
    const idname = "idname";
    const data = {
        method: 'DELETE',
        headers: {
            'Authorization': `Bearer ${token}`
        }
    };
    const formData = new FormData();
    formData.append("channel", channel);
    formData.append("idname", idname);
    data.body = formData;
    const response = await fetch(apiUrl, data);
    const result = await response.json();
    console.log("response", { response, result });
};
main()
```
{% endtab %}

{% tab faceswap-delid_example Python %}
``` python
import requests

api_url = "https://api.useapi.net/v1/faceswap/delid"
token = "API token"
channel = "Discord channel"
idname = "idname"

headers = {
    'Authorization': f'Bearer {token}'
}

files = {
    'channel': (None, channel),
    'idname': (None, idname)
}

response = requests.delete(api_url, headers=headers, files=files)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-account-channel ===
Document URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-account-channel
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-get">GET</code> faceswap/account/<code class="language-plaintext highlighter-rouge">channel</code>
parent: InsightFaceSwap API v1
nav_order: 200
---
## Retrieve InsightFaceSwap configuration for `channel` 
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

{: .get }
> **https://api.useapi.net/v1/faceswap/account/`channel`**

The `channel` value should correspond to an account configured previously via a [POST](post-faceswap-account-channel) request.

##### Request Headers
``` yaml
Authorization: Bearer {API token}
Content-Type: application/json
```

- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Responses 

{% tabs get_account_InsightFaceSwap_channel_response %}

{% tab get_account_InsightFaceSwap_channel_response <span class="http-status-good">200</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>
```json
{
  "server": "Discord server id",
  "channel": "Discord channel id",
  "discord": "Discord token",
  "credits": {
  "timestamp": "2024-02-01T02:05:24.991000+00:00",
    "total": 50,
    "used": 18
    }
}
```
{% endtab %}

{% tab get_account_InsightFaceSwap_channel_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>
```json
{
  "error": "Unauthorized",
  "code": 401
}
```
{% endtab %}

{% tab get_account_InsightFaceSwap_channel_response <span class="http-status-bad">404</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404" rel="noreferrer" target="_blank"><span class="http-status-bad">404 Not Found</span></a>  

Configuration not found. To create configuration use [faceswap/account/`channel`](https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel).

{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  discord: string,
  server: string, 
  channel: string,
  credits: {
    timestamp: string,
    total:  number,
    used: number
  }
}
```

##### Examples

{% tabs get_account_InsightFaceSwap_channel_example %}

{% tab get_account_InsightFaceSwap_channel_example Curl %}
``` bash
curl https://api.useapi.net/v1/faceswap/account/<channel> \
   -H "Accept: application/json" \
   -H "Authorization: Bearer …" 
```
{% endtab %}

{% tab get_account_InsightFaceSwap_channel_example JavaScript %}
``` javascript
const token = "API token";
const channel = "Previously configured channel id"; 
const apiUrl = `https://api.useapi.net/v1/faceswap/account/${channel}`; 
const response = await fetch(apiUrl, {
  headers: {
    "Authorization": `Bearer ${token}`,
  },
});
const result = await response.json();
console.log("response", {response, result});
```
{% endtab %}

{% tab get_account_InsightFaceSwap_channel_example Python %}
``` python
import requests
token = "API token"
channel = "Previously configured channel id"
apiUrl = f"https://api.useapi.net/v1/faceswap/account/{channel}"
headers = {
    "Content-Type": "application/json", 
    "Authorization" : f"Bearer {token}"
}
response = requests.get(apiUrl, headers=headers)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-account ===
Document URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-account
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-get">GET</code> faceswap/account
parent: InsightFaceSwap API v1
nav_order: 100
---
## Retrieve InsightFaceSwap accounts information
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Before you start using the API, you **must** [configure](../start-here/setup-faceswap) at least one InsightFaceSwap Discord account. You may specify multiple InsightFaceSwap accounts, the API will automatically perform load balancing by randomly selecting an account with available credits before making calls to InsightFaceSwap Discord bot.

This endpoint retrieves the complete list of configured accounts for InsightFaceSwap.

{: .get }
> **https://api.useapi.net/v1/faceswap/account**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
Content-Type: application/json
```

- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Responses 

{% tabs account_InsightFaceSwap_response %}

{% tab account_InsightFaceSwap_response <span class="http-status-good">200</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>
```json
{
    "Discord channel A": {
        "server": "Discord server A",
        "channel": "Discord channel A",
        "discord": "Discord token A",
        "credits": {
            "timestamp": "2024-02-01T02:05:24.991000+00:00",
            "total": 50,
            "used": 18
        },
    },
    "Discord channel B": {
        "server": "Discord server B",
        "channel": "Discord channel B",
        "discord": "Discord token B"
    },
    "Discord channel N": {
        "server": "Discord server N",
        "channel": "Discord channel N",
        "discord": "Discord token N",
        "credits": {
            "timestamp": "2024-02-01T03:17:48.159000+00:00",
            "total": 200,
            "used": 115
        }
    }    
}
```
{% endtab %}

{% tab account_InsightFaceSwap_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>
```json
{
  "error": "Unauthorized",
  "code": 401
}
```
{% endtab %}

{% tab account_InsightFaceSwap_response <span class="http-status-bad">404</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404" rel="noreferrer" target="_blank"><span class="http-status-bad">404 Not Found</span></a>

Configuration not found. To create configuration use [faceswap/account/`channel`](https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel).

{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  [channel: string]: {
    discord: string,
    server: string, 
    channel: string,
    credits: {
      timestamp: string,
      total:  number,
      used: number
    }
  }
}
```

##### Examples

{% tabs account_InsightFaceSwap_example %}

{% tab account_InsightFaceSwap_example Curl %}
``` bash
curl https://api.useapi.net/v1/faceswap/account \
   -H "Accept: application/json" \
   -H "Authorization: Bearer …" 
```
{% endtab %}

{% tab account_InsightFaceSwap_example JavaScript %}
``` javascript
const token = "API token";
const apiUrl = "https://api.useapi.net/v1/faceswap/account"; 
const response = await fetch(apiUrl, {
  headers: {
    "Authorization": `Bearer ${token}`,
  },
});
const result = await response.json();
console.log("response", {response, result});
```
{% endtab %}

{% tab account_InsightFaceSwap_example Python %}
``` python
import requests
token = "API token"
apiUrl = "https://api.useapi.net/v1/faceswap/account"
headers = {
    "Content-Type": "application/json", 
    "Authorization" : f"Bearer {token}"
}
response = requests.get(apiUrl, headers=headers)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-jobid ===
Document URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-jobid
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-get">GET</code> faceswap/jobs/?jobid=<code class="language-plaintext highlighter-rouge">jobid</code>
parent: InsightFaceSwap API v1
nav_order: 1300
---

## Retrieve InsightFaceSwap job status and results
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Use this endpoint to retrieve status and results of 
- [faceswap/headshot](../api-faceswap-v1/post-faceswap-headshot)
- [faceswap/changebg](../api-faceswap-v1/post-faceswap-changebg)
- [faceswap/picsi](../api-faceswap-v1/post-faceswap-picsi) with initial jobs status returned `started`

If you specified optional parameter [`replyUrl`](../api-faceswap-v1/post-faceswap-headshot#request-body) you technically do not need to use this endpoint to retrieve results since API will call provided `replyUrl` once job generation completed.

**Important** API periodically polls (checks) Discord every 15 to 60 seconds (depending on the load) and updates all currently executed jobs statuses and results. Polling interval is used for safety reasons, aiming to prevent any potential issues with Discord and InsightFaceSwap, such as bans or excessive requests.

Jobs lifespan guaranteed to be at least 31 days, after that they will be expired and may be recycled.

{: .get }
> **https://api.useapi.net/v1/faceswap/jobs/?jobid=`jobid`**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
```
- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Query Parameter
`jobid` is **required**, use value returned by 
- [faceswap/headshot](../api-faceswap-v1/post-faceswap-headshot)
- [faceswap/changebg](../api-faceswap-v1/post-faceswap-changebg)
- [faceswap/picsi](../api-faceswap-v1/post-faceswap-picsi) with initial jobs status returned `started`

##### Responses 
{:toc}

{% tabs get_faceswap_jobid_response %}

{% tab get_faceswap_jobid_response <span class="http-status-good">200</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>

If field `status` value is *created*, *started* or *progress* wait in a loop for **at least** 10..30 seconds and retry again. When completed retrieve generated images or video from `attachments` array. Field `content` contains message generated by InsightFaceSwap reflecting current generation parameters and progress. Optional array `embeds` contains additional information.  

```json
{
    "jobid": "<jobid>",
    "verb": "faceswap-headshot",
    "status": "completed",
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:19:20.256Z",
    "prompt": "me, a mad king with an evil smile, wearing medieval royal blue attire and a crown. --no green --square",
    "discord": "<ABC…secured…xyz>",
    "server": "<Discord server id>",
    "channel": "<Discord channel id>",
    "messageId": "<Discord message id>",
    "content": "<@Discord user id>  Picsi.Ai Headshot Job Submitted [jobid: 8a1f574fdbf79e8cd57e070476d9d5f3] [credits: 4] [prompt: 'a mad king with an evil smile, wearing medieval royal blue attire and a crown. --no green --square'] [time: <time>] [SaveID: 'me'] (796/800 credits remaining)",
    "timestamp": "2023-09-09T02:05:24.991000+00:00",
    "attachments": [
        {
            "url": "<generated image url>",
            "proxy_url": "<generated proxy image url>",
            "width": 768,
            "height": 768,
            "content_type": "<generated image type>",
            "id": "<Discord attachment id>",
            "filename": "<generated image filename>",
            "size": 7204115
        }
    ],
    "code": 200
}
```
{% endtab %}

{% tab get_faceswap_jobid_response <span class="http-status-bad">400</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" rel="noreferrer" target="_blank"><span class="http-status-bad">400 Bad Request</span></a>

```json
{
    "error": "Query param jobid not provided",
    "code": 400
}
```
{% endtab %}

{% tab get_faceswap_jobid_response <span class="http-status-bad">401</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>

```json
{
    "error": "Unauthorized",
    "code": 401
}
```

{% endtab %}

{% tab get_faceswap_jobid_response <span class="http-status-bad">402</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402" rel="noreferrer" target="_blank"><span class="http-status-bad">402 Payment Required</span></a>

```json
{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}
```
{% endtab %}


{% tab get_faceswap_jobid_response <span class="http-status-bad">404</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404" rel="noreferrer" target="_blank"><span class="http-status-bad">404 Not Found</span></a>

```json
{
    "error": "Unable to locate job <jobid>",
    "code": 404
}
```

{% endtab %}

{% tab get_faceswap_jobid_response <span class="http-status-bad">410</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/410" rel="noreferrer" target="_blank"><span class="http-status-bad">410 Gone</span></a>

```json
{
    "error": "Job has expired",
    "code": 410
}
```

{% endtab %}

{% endtabs %}

##### Model
```typescript
{ // TypeScript, all fields are optional
  jobid: string,
  parentJobId: string,
  verb:  'faceswap-changebg' | 'faceswap-headshot' | 'faceswap-picsi' |
         'faceswap-swapid' | 'faceswap-saveid' | 'faceswap-setid' | 'faceswap-INSwapper' | 
         'faceswap-listid' | 'faceswap-delall' | 'faceswap-delid' | 'faceswap-swap',
  status: 'created' | 'started' | 'moderated' | 'progress' | 
          'completed' | 'failed' | 'cancelled',
  created: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  updated: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  prompt: string,
  a_background_photo_of: string,
  options: string,
  image: { size: number, type: string  },
  source_image: { size: number, type: string  },
  target_image_gif_or_video: { size: number, type: string  },
  idname: string,
  saveid_idname: string,
  saveid_image: { size: number, type: string  },
  swapid_idname: string,
  swapid_image: { size: number, type: string  },
  targetMessageId: string,
  discord: string, // Provided for debugging purposes only, contains the first 3 and the last 3 characters of the original value
  server: string,
  channel: string,
  messageId: string,
  content: string, // Contains message generated by InsightFaceSwap reflecting current generation parameters and progress
  timestamp: string,
  attachments: [
      {
          id: string,
          content_type: string,
          filename: string,
          url: string,
          proxy_url: string,
          size: number,
          width: number,
          height: number
      }
  ],
  embeds: [
      {
          type: string,
          description: string,
          image: {
              url: string,
              proxy_url: string,
              width: number,
              height: number
          }
      }
  ], 
  error: string,
  errorDetails: string,
  code: 200
}
```

##### Examples

{% tabs faceswap_jobid_example %}

{% tab faceswap_jobid_example Curl %}
``` bash
curl https://api.useapi.net/v1/faceswap/jobs/?jobid=… \
   -H "Accept: application/json" \
   -H "Authorization: Bearer …" 
```
{% endtab %}

{% tab faceswap_jobid_example JavaScript %}
``` javascript
const token = "API token";
const jobid = "jobid returned by faceswap/changebg, faceswap/headshot or faceswap/picsi";      
const apiUrl = `https://api.useapi.net/v1/faceswap/jobs/?jobid=${jobid}`; 
const response = await fetch(apiUrl, {
  headers: {
    "Authorization": `Bearer ${token}`,
  },
});
const result = await response.json();
console.log("response", {response, result});
```
{% endtab %}

{% tab faceswap_jobid_example Python %}
``` python
import requests
token = "API token"
jobid = "jobid returned by faceswap/changebg, faceswap/headshot or faceswap/picsi"
apiUrl = f"https://api.useapi.net/v1/faceswap/jobs/?jobid={jobid}"
headers = {
    "Content-Type": "application/json", 
    "Authorization" : f"Bearer {token}"
}
response = requests.get(apiUrl, headers=headers)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-jobs-cancel ===
Document URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-jobs-cancel
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-get">GET</code> …/cancel/?jobid=<code class="language-plaintext highlighter-rouge">jobid</code>
parent: InsightFaceSwap API v1
nav_order: 2000
---

## Cancel InsightFaceSwap job
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Cancel execution of job created by 
- [faceswap/headshot](../api-faceswap-v1/post-faceswap-headshot)
- [faceswap/changebg](../api-faceswap-v1/post-faceswap-changebg)
- [faceswap/picsi](../api-faceswap-v1/post-faceswap-picsi) with initial jobs status returned `started`

{: .get }
> **https://api.useapi.net/v1/faceswap/jobs/cancel/?jobid=`jobid`**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
```
- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Query Parameter
`jobid` is **required**, use value returned by 
- [faceswap/headshot](../api-faceswap-v1/post-faceswap-headshot)
- [faceswap/changebg](../api-faceswap-v1/post-faceswap-changebg)
- [faceswap/picsi](../api-faceswap-v1/post-faceswap-picsi) with initial jobs status returned `started`

##### Responses 
{:toc}

{% tabs post_faceswap_cancel_response %}

{% tab post_faceswap_cancel_response <span class="http-status-good">200</span> %}

```json
{
    "jobid": "<jobid>",
    "status": "cancelled"
}   "code": 200
```

{% endtab %}

{% tab post_faceswap_cancel_response <span class="http-status-bad">400</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" rel="noreferrer" target="_blank"><span class="http-status-bad">400 Bad Request</span></a>

```json
{
    "error": "Query param jobid not provided",
    "code": 400
}
```

{% endtab %}

{% tab post_faceswap_cancel_response <span class="http-status-bad">401</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>

```json
{
    "error": "Unauthorized",
    "code": 401
}
```

{% endtab %}

{% tab post_faceswap_cancel_response <span class="http-status-bad">402</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402" rel="noreferrer" target="_blank"><span class="http-status-bad">402 Payment Required</span></a>

```json
{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}
```

{% endtab %}


{% tab post_faceswap_cancel_response <span class="http-status-bad">404</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404" rel="noreferrer" target="_blank"><span class="http-status-bad">404 Not Found</span></a>

```json
{
    "error": "Unable to locate job <jobid>",
    "code": 404
}
```

{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  jobid: string, 
  status: 'created' | 'started' | 'moderated' | 'progress' | 
          'completed' | 'failed' | 'cancelled',
  error: string,
  errorDetails: string,
  code: number
}
```

##### Examples

{% tabs faceswap_cancel_example %}

{% tab faceswap_cancel_example Curl %}
``` bash
curl https://api.useapi.net/v1/faceswap/jobs/cancel/?jobid=… \
   -H "Accept: application/json" \
   -H "Authorization: Bearer …" 
```
{% endtab %}

{% tab faceswap_cancel_example JavaScript %}
``` javascript
const token = "API token";
const jobid = "jobid returned by faceswap/changebg, faceswap/headshot or faceswap/picsi";      
const apiUrl = `https://api.useapi.net/v1/faceswap/jobs/cancel/?jobid=${jobid}`; 
const response = await fetch(apiUrl, {
  headers: {
    "Authorization": `Bearer ${token}`,
  },
});
const result = await response.json();
console.log("response", {response, result});
```
{% endtab %}

{% tab faceswap_cancel_example Python %}
``` python
import requests
token = "API token"
jobid = "jobid returned by faceswap/changebg, faceswap/headshot or faceswap/picsi"
apiUrl = f"https://api.useapi.net/v1/faceswap/jobs/cancel/?jobid={jobid}"
headers = {
    "Content-Type": "application/json", 
    "Authorization" : f"Bearer {token}"
}
response = requests.get(apiUrl, headers=headers)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-jobs ===
Document URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-jobs
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-get">GET</code> faceswap/jobs
parent: InsightFaceSwap API v1
nav_order: 3000
---

## Get list of currently executing InsightFaceSwap jobs
{: .no_toc }
 
## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

{: .get }
> **https://api.useapi.net/v1/faceswap/jobs**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
```
- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Responses 
{:toc}

{% tabs post_pika_jobs_response %}

{% tab post_pika_jobs_response <span class="http-status-good">200</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>

```json
[ "<jobid>", "<jobid>", "<jobid>" ]
```

{% endtab %}

{% tab post_pika_jobs_response <span class="http-status-bad">401</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>

```json
{
    "error": "Unauthorized",
    "code": 401
}
```

{% endtab %}

{% tab post_pika_jobs_response <span class="http-status-bad">402</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402" rel="noreferrer" target="_blank"><span class="http-status-bad">402 Payment Required</span></a>

```json
{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}
```

{% endtab %}

{% endtabs %}

##### Model
```typescript
// TypeScript
string[]
```

##### Examples

{% tabs pika_jobs_example %}

{% tab pika_jobs_example Curl %}
``` bash
curl https://api.useapi.net/v1/faceswap/jobs \
   -H "Accept: application/json" \
   -H "Authorization: Bearer …" 
```
{% endtab %}

{% tab pika_jobs_example JavaScript %}
``` javascript
const token = "API token";
const apiUrl = `https://api.useapi.net/v1/faceswap/jobs`; 
const response = await fetch(apiUrl, {
  headers: {
    "Authorization": `Bearer ${token}`,
  },
});
const result = await response.json();
console.log("response", {response, result});
```
{% endtab %}

{% tab pika_jobs_example Python %}
``` python
import requests
token = "API token"
apiUrl = f"https://api.useapi.net/v1/faceswap/jobs"
headers = {
    "Content-Type": "application/json", 
    "Authorization" : f"Bearer {token}"
}
response = requests.get(apiUrl, headers=headers)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel ===
Document URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-post">POST</code> faceswap/account/<code class="language-plaintext highlighter-rouge">channel</code>
parent: InsightFaceSwap API v1
nav_order: 300
---
## Create or update InsightFaceSwap account information
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Before you start using the API, you **must** [configure](../start-here/setup-faceswap) at least one InsightFaceSwap Discord account. You may specify multiple InsightFaceSwap accounts, the API will automatically perform load balancing by randomly selecting an account with available credits before making calls to InsightFaceSwap Discord bot.

{: .post }
> **https://api.useapi.net/v1/faceswap/account/`channel`**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
Content-Type: application/json
```

- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Request Body
```json
{
    "discord": "Discord token",
    "server": "Discord server id",
    "channel": "Discord channel id"
}
```
- `discord`, `channel` and `server` are **required**. Please see [Setup InsightFaceSwap](../start-here/setup-faceswap) for details. 

- `channel` value specified in the request body **must match** the channel value specified in the URL path https://api.useapi.net/v1/faceswap/account/`channel`.

##### Responses 

{% tabs post_account_InsightFaceSwap_response %}

{% tab post_account_InsightFaceSwap_response <span class="http-status-good">204</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204" rel="noreferrer" target="_blank"><span class="http-status-good">204 No Content</span></a> 

{% endtab %}

{% tab post_account_InsightFaceSwap_response <span class="http-status-bad">400</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" rel="noreferrer" target="_blank"><span class="http-status-bad">400 Bad Request</span></a>
```json
{
  "error": 
    "Required param discord is missing or empty"
    "Required param server is missing or empty"
    "Required param channel is missing or empty"
    "Required param channel (<server>) is not valid Discord channel id"
    "Required param channel (<channel>) is not valid Discord channel id"
    "Required param channel (<channel>) not matching to /faceswap/account/<channel>"
    "Channel <channel> configuration has same discord value"
    "Channel <channel> configuration has same server value"
  "code": 400
}
```
{% endtab %}

{% tab post_account_InsightFaceSwap_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>
```json
{
  "error": "Unauthorized",
  "code": 401
}
```
{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  discord: string, 
  server: string,
  channel: string,
  error: string,
  errorDetails: string,
  code: number
}
```

##### Examples

{% tabs post_account_InsightFaceSwap_example %}

{% tab post_account_InsightFaceSwap_example Curl %}
``` bash
curl -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer …" \
     -X POST https://api.useapi.net/v1/faceswap/account/<channel> \
     -d '{"discord": "…", "server": "…", "channel": …}'
```
{% endtab %}

{% tab post_account_InsightFaceSwap_example JavaScript %}
``` javascript
const channel = "Discord channel id";      
const apiUrl = `https://api.useapi.net/v1/faceswap/account/${channel}`; 
const token = "API token";
const discord = "Discord token";
const server = "Discord server id";      
const data = { 
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json' }
};
data.body = JSON.stringify({ 
  discord, server, channel
});
const response = await fetch(apiUrl, data);
const result = await response.json();
console.log("response", {response, result});
```
{% endtab %}

{% tab post_account_InsightFaceSwap_example Python %}
``` python
import requests
channel = "Discord channel id"
apiUrl = f"https://api.useapi.net/v1/faceswap/account/{channel}" 
token = "API token"
discord = "Discord token"
server = "Discord server id"
maxJobs = 10
headers = {
    "Content-Type": "application/json", 
    "Authorization" : f"Bearer {token}"
}
body = {
    "discord": f"{discord}", 
    "server": f"{server}",
    "channel": f"{channel}"
}
response = requests.post(apiUrl, headers=headers, json=body)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-changebg ===
Document URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-changebg
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-post">POST</code> faceswap/changebg
parent: InsightFaceSwap API v1
nav_order: 470
---
## InsightFaceSwap [/changebg](https://www.patreon.com/posts/introducing-ai-5-104943286) command 
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Use this endpoint to submit the InsightFaceSwap [/changebg](https://www.patreon.com/posts/introducing-ai-5-104943286) command to your [InsightFaceSwap Discord channel](../start-here/setup-faceswap). Results obtained as a callback via optional parameter [`replyUrl`](#request-body) or by querying [faceswap/jobs/?jobid=<code class="language-plaintext highlighter-rouge">jobid</code>](../api-faceswap-v1/get-faceswap-jobid) endpoint.  

It is **important** not to use the InsightFaceSwap account setup for API access for any purposes other than its intended use, such as executing `/changebg` or any other InsightFaceSwap commands _manually_ or in conjunction with _any other_ automation tools. The useapi.net API internally tracks the usage of the InsightFaceSwap account, including the number of currently active executions. Using it for other activities may cause API to function incorrectly.

{: .post }
> **https://api.useapi.net/v1/faceswap/changebg**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
Content-Type: multipart/form-data
```
- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Request Body
```json
{
    "channel": "Discord channel id",
    "a_background_photo_of": "Background prompt",
    "image": "Image File or Blob",
    "replyUrl": "Place your call back URL here",
    "replyRef": "Place your reference id here"
}
```
- `channel` is optional, if omitted a randomly selected [configured](https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel) channel with available credits will be used.

- `a_background_photo_of` is **required**, background prompt, please refer to InsightFaceSwap [/changebg](https://www.patreon.com/posts/introducing-ai-5-104943286) for details.

- `image` is **required**, source image. Must be either a [File](https://developer.mozilla.org/en-US/docs/Web/API/File) or [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) object when included in this [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) POST request.

- `replyUrl` is optional, if not provided value from [useapi.net account](../account-management/get-account) will be used.  
  Place here your callback URL. API will call the provided `replyUrl` once job completed or failed.  
  Maximum length 1024 characters.  
  We recommend using sites like [webhook.site](https://webhook.site) to test callback URL functionality.  

 - `replyRef` is optional, place here your reference id which will be stored and returned along with this job response / result.  
  Maximum length 1024 characters.  
  
##### Responses 

{% tabs post_faceswap-changebg_response %}

{% tab post_faceswap-changebg_response <span class="http-status-good">200</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>

Use returned `jobid` to [retrieve InsightFaceSwap job status and results](../api-faceswap-v1/get-faceswap-jobid) or use callback `replyUrl`.

Field `content` contains message generated by InsightFaceSwap.

```json
{
    "jobid": "<jobid>",
    "verb": "faceswap-changebg",
    "status": "started",
    "a_background_photo_of": "sunny beach",
    "image": { "size": 1699405, "type": "image/png" },
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:04:53.490Z",
    "discord": "<ABC…secured…xyz>",
    "server": "<Discord server id>",
    "channel": "<Discord channel id>",
    "replyUrl": "https://webhook.site/abc",
    "replyRef": "<your optional reference id>",
    "messageId": "<Discord message id>",
    "content": "<@Discord user id> Picsi.Ai ChangeBG Job Submitted [jobid: 8a1f574fdbf79e8cd57e070476d9d5f3] [credits: 4] [prompt: 'sunny beach'] [time: <time>] [SaveID: '_'] (796/800 credits remaining)",
    "timestamp": "2023-09-09T02:04:51.926000+00:00",
    "code": 200
}
```
{% endtab %}

{% tab post_faceswap-changebg_response <span class="http-status-bad">400</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" rel="noreferrer" target="_blank"><span class="http-status-bad">400 Bad Request</span></a>

```json
{
    "error": 
      "Required param a_background_photo_of is missing or empty"
      "Required param image is missing or empty"
      "Param image is not File or Blob"
      "Optional param replyRef is too long"
      "Optional param replyUrl is too long"
      "Configuration not found for channel <channel>, to create POST v1/faceswap/account/<channel>"
    "code": 400
}
```
{% endtab %}


{% tab post_faceswap-changebg_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>

```json
{
    "error": "Unauthorized",
    "code": 401
}
```
{% endtab %}

{% tab post_faceswap-changebg_response <span class="http-status-bad">402</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402" rel="noreferrer" target="_blank"><span class="http-status-bad">402 Payment Required</span></a>

```json
{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}
```
{% endtab %}

{% tab post_faceswap-changebg_response <span class="http-status-bad">429</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429" rel="noreferrer" target="_blank"><span class="http-status-bad">429 Too Many Requests</span></a>

Wait in a loop for **at least** 10..30 seconds and retry again.

There are two possible cases for API response 429.

1. API query is full and can not accept new [faceswap/changebg](#insightfaceswap-changebg-command) requests. 
```json
{
    "error": "Unable to lock Discord after <attempts> attempts",
    "code": 429
}
```
2. The API received an HTTP status 429 from the Discord API when it attempted to POST to the `/interactions` endpoint. Under normal circumstances, this should be a rare occurrence because the API is designed to strictly adhere to Discord rate limits. However, in certain scenarios, Discord may still issue a 429 response.
```json
{
    "error": "Discord /interactions failed with HTTP status 429",
    "errorDetails": "{\"global\":true,\"message\":\"You are being rate limited.\",\"retry_after\":10}",
    "code": 429
}
```
{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  jobid: string, 
  verb: 'faceswap-changebg',
  status: 'started' | 'failed',
  a_background_photo_of: string,
  image: { size: number, type: string },
  created: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  updated: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  discord: string, // Provided for debugging purposes only, contains the first 3 and the last 3 characters of the original value
  server: string,
  channel: string,
  replyUrl: string,
  replyRef: string,
  messageId: string,
  content: string, // Contains message generated by InsightFaceSwap 
  timestamp: string,
  error: string,
  errorDetails: string,
  code: number
}
```

##### Examples

{% tabs faceswap-changebg_example %}

{% tab faceswap-changebg_example Curl %}
``` bash
curl -H "Accept: application/json" \
     -H "Authorization: Bearer …" \
     -X POST https://api.useapi.net/v1/faceswap/changebg \
     -F "channel=<Discord channel id>" \
     -F 'image=@"<Path to the image>"' \
     -F "a_background_photo_of=<a_background_photo_of>" 
```
{% endtab %}

{% tab faceswap-changebg_example JavaScript %}
``` javascript
const main = async () => {
    const apiUrl = "https://api.useapi.net/v1/faceswap/changebg";
    const token = "API token";
    const a_background_photo_of = "a_background_photo_of";
    const channel = "Discord channel";
    const data = {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${token}`
        }
    };
    const formData = new FormData();
    formData.append("a_background_photo_of", a_background_photo_of);
    formData.append("channel", channel);
    /*
        // Example 1: Fetch image from URL
        const imageUrl = "https://upload.wikimedia.org/wikipedia/commons/7/7d/Mona_Lisa_color_restoration.jpg";
        const responseImage = await fetch(imageUrl);
        formData.append("image", await responseImage.blob());
    */
    /* 
        // Example 2: Load image from local file (Blob)
        const fsp = require('fs').promises;
        const imageFileName = "./target_photo.png";
        const blob = new Blob([await fsp.readFile(imageFileName)]);
        formData.append("image", blob);
    */
    /*
        // Example 3: Load from input file html element
        // <input id="target-photo-image-file" type="file"> 
        const imageFile = document.getElementById(`target-photo-image-file`);
        if (imageFile.files[0])
            formData.append("image", imageFile.files[0]);
    */
    data.body = formData;
    const response = await fetch(apiUrl, data);
    const result = await response.json();
    console.log("response", { response, result });
};
main()

```
{% endtab %}

{% tab faceswap-changebg_example Python %}
``` python
import requests

api_url = "https://api.useapi.net/v1/faceswap/changebg"
token = "API token"
a_background_photo_of = "a_background_photo_of"
channel = "Discord channel"

headers = {
    'Authorization': f'Bearer {token}'
}

files = {
    'a_background_photo_of': (None, a_background_photo_of),
    'channel': (None, channel)
}

# # Example 1: Fetch image from URL
# image_url = "https://upload.wikimedia.org/wikipedia/commons/7/7d/Mona_Lisa_color_restoration.jpg"
# response_image = requests.get(image_url)
# image_content = response_image.content
# files['image'] = ('image.jpg', image_content, 'image/jpeg')

# # Example 2: Load image from local file
# image_file_path = "./target_photo.png"
# with open(image_file_path, 'rb') as image_file:
#     files['image'] = ('target_photo.png', image_file.read(), 'image/png')

response = requests.post(api_url, headers=headers, files=files)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-delall ===
Document URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-delall
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-delete">DEL</code> faceswap/delall
parent: InsightFaceSwap API v1
nav_order: 1200
---
## InsightFaceSwap [/delall](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#delall) command 
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Use this endpoint to submit the InsightFaceSwap [/delall](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#delall) command to your [InsightFaceSwap Discord channel](../start-here/setup-faceswap). The result will be returned in the response body and can also be sent as a callback to an optional [`replyUrl`](#request-body). 

This is a blocking call, you will **not** be able to make another call to the same InsightFaceSwap Discord channel until the current call is completed. The average execution time is approximately 3 to 10 seconds. If you expect high load and need to make multiple concurrent calls, please consider setting up [multiple InsightFaceSwap accounts](https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel).

It is **important** not to use the InsightFaceSwap account setup for API access for any purposes other than its intended use, such as executing `/delall` or any other InsightFaceSwap commands _manually_ or in conjunction with _any other_ automation tools. The useapi.net API internally tracks the usage of the InsightFaceSwap account, including the number of currently active executions. Using it for other activities may cause API to function incorrectly.

{: .delete }
> **https://api.useapi.net/v1/faceswap/delall**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
Content-Type: multipart/form-data
```
- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Request Body
```json
{
    "channel": "Discord channel id"
}
```
- `channel` is optional when only one [faceswap/account](../api-faceswap-v1/get-faceswap-account) configured. However, if you have multiple accounts configured, this parameter becomes **required**.

- `replyUrl` is optional, if not provided value from [useapi.net account](../account-management/get-account) will be used.  
  Place here your callback URL. API will call the provided `replyUrl` once job completed or failed.  
  Maximum length 1024 characters.  
  We recommend using sites like [webhook.site](https://webhook.site) to test callback URL functionality.  

 - `replyRef` is optional, place here your reference id which will be stored and returned along with this job response / result.  
  Maximum length 1024 characters.  
  
##### Responses 

{% tabs post_faceswap-delall_response %}

{% tab post_faceswap-delall_response <span class="http-status-good">200</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>

Field `content` contains message generated by InsightFaceSwap.

```json
{
    "jobid": "<jobid>",
    "verb": "faceswap-delall",
    "status": "completed",
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:04:53.490Z",
    "discord": "<ABC…secured…xyz>",
    "server": "<Discord server id>",
    "channel": "<Discord channel id>",
    "replyUrl": "https://webhook.site/abc",
    "replyRef": "<your optional reference id>",
    "messageId": "<Discord message id>",
    "content": "All idnames deleted",
    "timestamp": "2023-09-09T02:04:51.926000+00:00",
    "code": 200
}
```
{% endtab %}

{% tab post_faceswap-delall_response <span class="http-status-bad">400</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" rel="noreferrer" target="_blank"><span class="http-status-bad">400 Bad Request</span></a>

```json
{
    "error": 
      "Optional param replyRef is too long"
      "Optional param replyUrl is too long"
      "Required param channel is missing or empty"
      "Configuration not found for channel <channel>, to create POST v1/faceswap/account/<channel>"
    "code": 400
}
```
{% endtab %}


{% tab post_faceswap-delall_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>

```json
{
    "error": "Unauthorized",
    "code": 401
}
```
{% endtab %}

{% tab post_faceswap-delall_response <span class="http-status-bad">402</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402" rel="noreferrer" target="_blank"><span class="http-status-bad">402 Payment Required</span></a>

```json
{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}
```
{% endtab %}

{% tab post_faceswap-delall_response <span class="http-status-bad">429</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429" rel="noreferrer" target="_blank"><span class="http-status-bad">429 Too Many Requests</span></a>

Wait in a loop for **at least** 10..30 seconds and retry again.

There are two possible cases for API response 429.

1. API query is full and can not accept new [faceswap/delall](#insightfaceswap-delall-command) requests. 
```json
{
    "error": "Unable to lock Discord after <attempts> attempts",
    "code": 429
}
```
2. The API received an HTTP status 429 from the Discord API when it attempted to POST to the `/interactions` endpoint. Under normal circumstances, this should be a rare occurrence because the API is designed to strictly adhere to Discord rate limits. However, in certain scenarios, Discord may still issue a 429 response.
```json
{
    "error": "Discord /interactions failed with HTTP status 429",
    "errorDetails": "{\"global\":true,\"message\":\"You are being rate limited.\",\"retry_after\":10}",
    "code": 429
}
```
{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  jobid: string, 
  verb: 'faceswap-delall',
  status: 'completed' | 'failed',
  created: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  updated: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  discord: string, // Provided for debugging purposes only, contains the first 3 and the last 3 characters of the original value
  server: string,
  channel: string,
  replyUrl: string,
  replyRef: string,
  messageId: string,
  content: string, // Contains message generated by InsightFaceSwap 
  timestamp: string,
  error: string,
  errorDetails: string,
  code: number
}
```

##### Examples

{% tabs faceswap-delall_example %}

{% tab faceswap-delall_example Curl %}
``` bash
curl -H "Accept: application/json" \
     -H "Authorization: Bearer …" \
     -X DELETE https://api.useapi.net/v1/faceswap/delall \
     -F "channel=<Discord channel id>" 
```
{% endtab %}

{% tab faceswap-delall_example JavaScript %}
``` javascript
const main = async () => {
    const apiUrl = "https://api.useapi.net/v1/faceswap/delall";
    const token = "API token";
    const channel = "Discord channel";
    const data = {
        method: 'DELETE',
        headers: {
            'Authorization': `Bearer ${token}`
        }
    };
    const formData = new FormData();
    formData.append("channel", channel);
    data.body = formData;
    const response = await fetch(apiUrl, data);
    const result = await response.json();
    console.log("response", { response, result });
};
main()
```
{% endtab %}

{% tab faceswap-delall_example Python %}
``` python
import requests

api_url = "https://api.useapi.net/v1/faceswap/delall"
token = "API token"
channel = "Discord channel"

headers = {
    'Authorization': f'Bearer {token}'
}

files = {
    'channel': (None, channel)
}

response = requests.delete(api_url, headers=headers, files=files)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-headshot ===
Document URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-headshot
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-post">POST</code> faceswap/headshot
parent: InsightFaceSwap API v1
nav_order: 950
---
## InsightFaceSwap [/headshot](https://www.patreon.com/posts/introducing-ai-5-101604168) command 
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Use this endpoint to submit the InsightFaceSwap [/headshot](https://www.patreon.com/posts/introducing-ai-5-101604168) command to your [InsightFaceSwap Discord channel](../start-here/setup-faceswap). Results obtained as a callback via optional parameter [`replyUrl`](#request-body) or by querying [faceswap/jobs/?jobid=<code class="language-plaintext highlighter-rouge">jobid</code>](../api-faceswap-v1/get-faceswap-jobid) endpoint.  

It is **important** not to use the InsightFaceSwap account setup for API access for any purposes other than its intended use, such as executing `/headshot` or any other InsightFaceSwap commands _manually_ or in conjunction with _any other_ automation tools. The useapi.net API internally tracks the usage of the InsightFaceSwap account, including the number of currently active executions. Using it for other activities may cause API to function incorrectly.

{: .post }
> **https://api.useapi.net/v1/faceswap/headshot**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
Content-Type: multipart/form-data
# Alternatively you can use application/json
# Content-Type: application/json 
```
- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Request Body
```json
{
    "channel": "Discord channel id",
    "prompt": "Background prompt",
    "replyUrl": "Place your call back URL here",
    "replyRef": "Place your reference id here"
}
```
- `channel` is optional when only one [faceswap/account](../api-faceswap-v1/get-faceswap-account) configured. However, if you have multiple accounts configured, this parameter becomes **required**.

- `prompt` is **required**, please refer to InsightFaceSwap [/headshot](https://www.patreon.com/posts/introducing-ai-5-101604168) for details.

- `replyUrl` is optional, if not provided value from [useapi.net account](../account-management/get-account) will be used.  
  Place here your callback URL. API will call the provided `replyUrl` once job completed or failed.  
  Maximum length 1024 characters.  
  We recommend using sites like [webhook.site](https://webhook.site) to test callback URL functionality.  

 - `replyRef` is optional, place here your reference id which will be stored and returned along with this job response / result.  
  Maximum length 1024 characters.  
  
##### Responses 

{% tabs post_faceswap-headshot_response %}

{% tab post_faceswap-headshot_response <span class="http-status-good">200</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>

Use returned `jobid` to [retrieve InsightFaceSwap job status and results](../api-faceswap-v1/get-faceswap-jobid) or use callback `replyUrl`.

Field `content` contains message generated by InsightFaceSwap.

```json
{
    "jobid": "<jobid>",
    "verb": "faceswap-headshot",
    "status": "started",
    "prompt": "me, a mad king with an evil smile, wearing medieval royal blue attire and a crown. --no green --square",
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:04:53.490Z",
    "discord": "<ABC…secured…xyz>",
    "server": "<Discord server id>",
    "channel": "<Discord channel id>",
    "replyUrl": "https://webhook.site/abc",
    "replyRef": "<your optional reference id>",
    "messageId": "<Discord message id>",
    "content": "<@Discord user id>  Picsi.Ai Headshot Job Submitted [jobid: 8a1f574fdbf79e8cd57e070476d9d5f3] [credits: 4] [prompt: 'a mad king with an evil smile, wearing medieval royal blue attire and a crown. --no green --square'] [time: <time>] [SaveID: 'me'] (796/800 credits remaining)",
    "timestamp": "2023-09-09T02:04:51.926000+00:00",
    "code": 200
}
```
{% endtab %}

{% tab post_faceswap-headshot_response <span class="http-status-bad">400</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" rel="noreferrer" target="_blank"><span class="http-status-bad">400 Bad Request</span></a>

```json
{
    "error": 
      "Required param prompt is missing or empty"
      "Optional param replyRef is too long"
      "Optional param replyUrl is too long"
      "Configuration not found for channel <channel>, to create POST v1/faceswap/account/<channel>"
    "code": 400
}
```
{% endtab %}


{% tab post_faceswap-headshot_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>

```json
{
    "error": "Unauthorized",
    "code": 401
}
```
{% endtab %}

{% tab post_faceswap-headshot_response <span class="http-status-bad">402</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402" rel="noreferrer" target="_blank"><span class="http-status-bad">402 Payment Required</span></a>

```json
{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}
```
{% endtab %}

{% tab post_faceswap-headshot_response <span class="http-status-bad">429</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429" rel="noreferrer" target="_blank"><span class="http-status-bad">429 Too Many Requests</span></a>

Wait in a loop for **at least** 10..30 seconds and retry again.

There are two possible cases for API response 429.

1. API query is full and can not accept new [faceswap/headshot](#insightfaceswap-headshot-command) requests. 
```json
{
    "error": "Unable to lock Discord after <attempts> attempts",
    "code": 429
}
```
2. The API received an HTTP status 429 from the Discord API when it attempted to POST to the `/interactions` endpoint. Under normal circumstances, this should be a rare occurrence because the API is designed to strictly adhere to Discord rate limits. However, in certain scenarios, Discord may still issue a 429 response.
```json
{
    "error": "Discord /interactions failed with HTTP status 429",
    "errorDetails": "{\"global\":true,\"message\":\"You are being rate limited.\",\"retry_after\":10}",
    "code": 429
}
```
{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  jobid: string, 
  verb: 'faceswap-headshot',
  status: 'started' | 'failed',
  prompt: string,
  created: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  updated: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  discord: string, // Provided for debugging purposes only, contains the first 3 and the last 3 characters of the original value
  server: string,
  channel: string,
  replyUrl: string,
  replyRef: string,
  messageId: string,
  content: string, // Contains message generated by InsightFaceSwap 
  timestamp: string,
  error: string,
  errorDetails: string,
  code: number
}
```

##### Examples

{% tabs faceswap-headshot_example %}

{% tab faceswap-headshot_example Curl %}
``` bash
curl -H "Accept: application/json" \
     -H "Authorization: Bearer …" \
     -X POST https://api.useapi.net/v1/faceswap/headshot \
     -F "channel=<Discord channel id>" \
     -F "prompt=<prompt>" 
```
{% endtab %}

{% tab faceswap-headshot_example JavaScript %}
``` javascript
const main = async () => {
    const apiUrl = "https://api.useapi.net/v1/faceswap/headshot";
    const token = "API token";
    const prompt = "prompt";
    const channel = "Discord channel";
    const data = {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${token}`
        }
    };
    const formData = new FormData();
    formData.append("prompt", prompt);
    formData.append("channel", channel);
    data.body = formData;
    const response = await fetch(apiUrl, data);
    const result = await response.json();
    console.log("response", { response, result });
};
main()

```
{% endtab %}

{% tab faceswap-headshot_example Python %}
``` python
import requests

api_url = "https://api.useapi.net/v1/faceswap/headshot"
token = "API token"
prompt = "prompt"
channel = "Discord channel"

headers = {
    'Authorization': f'Bearer {token}'
}

files = {
    'prompt': (None, prompt),
    'channel': (None, channel)
}

response = requests.post(api_url, headers=headers, files=files)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-inswapper ===
Document URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-inswapper
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-post">POST</code> faceswap/inswapper
parent: InsightFaceSwap API v1
nav_order: 900
---
## InsightFaceSwap [Apps/INSwapper](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#appsinswapper) command 
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Use this endpoint to submit the InsightFaceSwap [Apps/INSwapper](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#appsinswapper) command to your [InsightFaceSwap Discord channel](../start-here/setup-faceswap). The result will be returned in the response body and can also be sent as a callback to an optional [`replyUrl`](#request-body). 

If you already have a message in your channel with an attached image, you can use this endpoint to perform a face swap on the image contained in that message. You need `message.id` returned by [messages](https://discord.com/developers/docs/resources/channel#get-channel-messages) GET request https://discord.com/api/v10/channels/channel_id/messages ([article](../articles/discord-api-part-1#finally-retrieve-imagine-commandresults)). 

You can also use field `messageId` returned by [Midjouney API v2](https://useapi.net/docs/api-v2/get-jobs-jobid#responses).

This is a blocking call, you will **not** be able to make another call to the same InsightFaceSwap Discord channel until the current call is completed. The average execution time is approximately 3 to 10 seconds. If you expect high load and need to make multiple concurrent calls, please consider setting up [multiple InsightFaceSwap accounts](https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel).

It is **important** not to use the InsightFaceSwap account setup for API access for any purposes other than its intended use, such as executing `/inswapper` or any other InsightFaceSwap commands _manually_ or in conjunction with _any other_ automation tools. The useapi.net API internally tracks the usage of the InsightFaceSwap account, including the number of currently active executions. Using it for other activities may cause API to function incorrectly.

{: .post }
> **https://api.useapi.net/v1/faceswap/inswapper**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
Content-Type: multipart/form-data
```
- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Request Body
```json
{
    "channel": "Discord channel id",
    "targetMessageId": "Discord message id with attached image"
}
```
- `channel` is optional when only one [faceswap/account](../api-faceswap-v1/get-faceswap-account) configured. However, if you have multiple accounts configured, this parameter becomes **required**.

- `targetMessageId` is **required**, Discord message id with an attached image. The message must be located in the channel specified by the channel param mentioned above.

- `replyUrl` is optional, if not provided value from [useapi.net account](../account-management/get-account) will be used.  
  Place here your callback URL. API will call the provided `replyUrl` once job completed or failed.  
  Maximum length 1024 characters.  
  We recommend using sites like [webhook.site](https://webhook.site) to test callback URL functionality.  

 - `replyRef` is optional, place here your reference id which will be stored and returned along with this job response / result.  
  Maximum length 1024 characters.  
  
##### Responses 

{% tabs post_faceswap-inswapper_response %}

{% tab post_faceswap-inswapper_response <span class="http-status-good">200</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>

Field `content` contains message generated by InsightFaceSwap. Attachments array contains generated image.

```json
{
    "jobid": "<jobid>",
    "verb": "faceswap-inswapper",
    "status": "completed",
    "targetMessageId": "1106423469968976446",
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:04:53.490Z",
    "discord": "<ABC…secured…xyz>",
    "server": "<Discord server id>",
    "channel": "<Discord channel id>",
    "replyUrl": "https://webhook.site/abc",
    "replyRef": "<your optional reference id>",
    "messageId": "<Discord message id>",
    "content": "Picsi.Ai ver.2.0 [SaveID: 'me'] [<@Discord user id>] (90/200 credits used)",
    "attachments": [
      {
        "url": "<generated image url>",
        "proxy_url": "<generated proxy image url>",
        "width": 2048,
        "height": 2048,
        "content_type": "<generated image type>",
        "id": "<Discord image id>",
        "filename": "<generated image name>",
        "size": 7204115
      }
    ],
    "timestamp": "2023-09-09T02:04:51.926000+00:00",
    "code": 200
}
```
{% endtab %}

{% tab post_faceswap-inswapper_response <span class="http-status-bad">400</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" rel="noreferrer" target="_blank"><span class="http-status-bad">400 Bad Request</span></a>

```json
{
    "error": 
      "Required param targetMessageId is missing or empty"
      "Required param targetMessageId (<targetMessageId>) is not valid Discord message id"
      "Optional param replyUrl is too long"
      "Required param channel is missing or empty"
      "Configuration not found for channel <channel>, to create POST v1/faceswap/account/<channel>"
    "code": 400
}
```
{% endtab %}

{% tab post_faceswap-inswapper_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>

```json
{
    "error": "Unauthorized",
    "code": 401
}
```
{% endtab %}

{% tab post_faceswap-inswapper_response <span class="http-status-bad">402</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402" rel="noreferrer" target="_blank"><span class="http-status-bad">402 Payment Required</span></a>

```json
{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}
```
{% endtab %}

{% tab post_faceswap-inswapper_response <span class="http-status-bad">404</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404" rel="noreferrer" target="_blank"><span class="http-status-bad">404 Not Found</span></a>

```json
{
    "error": 
      "Unable to locate message <targetMessageId> is channel <channel>"
      "Unable to locate attachments for message <targetMessageId>"
    "code": 404
}
```
{% endtab %}

{% tab post_faceswap-inswapper_response <span class="http-status-bad">429</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429" rel="noreferrer" target="_blank"><span class="http-status-bad">429 Too Many Requests</span></a>

Wait in a loop for **at least** 10..30 seconds and retry again.

There are two possible cases for API response 429.

1. API query is full and can not accept new [faceswap/inswapper](#insightfaceswap-inswapper-command) requests. 
```json
{
    "error": "Unable to lock Discord after <attempts> attempts",
    "code": 429
}
```
2. The API received an HTTP status 429 from the Discord API when it attempted to POST to the `/interactions` endpoint. Under normal circumstances, this should be a rare occurrence because the API is designed to strictly adhere to Discord rate limits. However, in certain scenarios, Discord may still issue a 429 response.
```json
{
    "error": "Discord /interactions failed with HTTP status 429",
    "errorDetails": "{\"global\":true,\"message\":\"You are being rate limited.\",\"retry_after\":10}",
    "code": 429
}
```
{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  jobid: string, 
  verb: 'faceswap-inswapper',
  status: 'completed' | 'failed',
  targetMessageId: string,
  created: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  updated: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  discord: string, // Provided for debugging purposes only, contains the first 3 and the last 3 characters of the original value
  server: string,
  channel: string,
  replyUrl: string,
  replyRef: string,
  messageId: string,
  content: string, // Contains message generated by InsightFaceSwap 
  attachments: [
      {
          id: string,
          content_type: string,
          filename: string,
          url: string,
          proxy_url: string,
          size: number,
          width: number,
          height: number
      }
  ],  
  timestamp: string,
  error: string,
  errorDetails: string,
  code: number
}
```

##### Examples

{% tabs faceswap-inswapper_example %}

{% tab faceswap-inswapper_example Curl %}
``` bash
curl -H "Accept: application/json" \
     -H "Authorization: Bearer …" \
     -X POST https://api.useapi.net/v1/faceswap/inswapper \
     -F "channel=<Discord channel id>" \
     -F "targetMessageId=<Discord message id>" 
```
{% endtab %}

{% tab faceswap-inswapper_example JavaScript %}
``` javascript
const main = async () => {
    const apiUrl = "https://api.useapi.net/v1/faceswap/inswapper";
    const token = "API token";
    const targetMessageId = "Discord message id";
    const channel = "Discord channel";
    const data = {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${token}`
        }
    };
    const formData = new FormData();
    formData.append("targetMessageId", targetMessageId);
    formData.append("channel", channel);
    data.body = formData;
    const response = await fetch(apiUrl, data);
    const result = await response.json();
    console.log("response", { response, result });
};
main()

```
{% endtab %}

{% tab faceswap-inswapper_example Python %}
``` python
import requests

api_url = "https://api.useapi.net/v1/faceswap/inswapper"
token = "API token"
targetMessageId = "Discord message id"
channel = "Discord channel"

headers = {
    'Authorization': f'Bearer {token}'
}

files = {
    'targetMessageId': (None, targetMessageId),
    'channel': (None, channel)
}

response = requests.post(api_url, headers=headers, files=files)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-listid ===
Document URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-listid
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-post">POST</code> faceswap/listid
parent: InsightFaceSwap API v1
nav_order: 500
---
## InsightFaceSwap [/listid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#listid) command 
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Use this endpoint to submit the InsightFaceSwap [/listid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#listid) command to your [InsightFaceSwap Discord channel](../start-here/setup-faceswap). The result will be returned in the response body and can also be sent as a callback to an optional [`replyUrl`](#request-body). 

This is a blocking call, you will **not** be able to make another call to the same InsightFaceSwap Discord channel until the current call is completed. The average execution time is approximately 3 to 10 seconds. If you expect high load and need to make multiple concurrent calls, please consider setting up [multiple InsightFaceSwap accounts](https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel).

It is **important** not to use the InsightFaceSwap account setup for API access for any purposes other than its intended use, such as executing `/listid` or any other InsightFaceSwap commands _manually_ or in conjunction with _any other_ automation tools. The useapi.net API internally tracks the usage of the InsightFaceSwap account, including the number of currently active executions. Using it for other activities may cause API to function incorrectly.

{: .post }
> **https://api.useapi.net/v1/faceswap/listid**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
Content-Type: multipart/form-data
```
- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Request Body
```json
{
    "channel": "Discord channel id"
}
```
- `channel` is optional when only one [faceswap/account](../api-faceswap-v1/get-faceswap-account) configured. However, if you have multiple accounts configured, this parameter becomes **required**.

- `replyUrl` is optional, if not provided value from [useapi.net account](../account-management/get-account) will be used.  
  Place here your callback URL. API will call the provided `replyUrl` once job completed or failed.  
  Maximum length 1024 characters.  
  We recommend using sites like [webhook.site](https://webhook.site) to test callback URL functionality.  

 - `replyRef` is optional, place here your reference id which will be stored and returned along with this job response / result.  
  Maximum length 1024 characters.  
  
##### Responses 

{% tabs post_faceswap-listid_response %}

{% tab post_faceswap-listid_response <span class="http-status-good">200</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>

Field `content` contains message generated by InsightFaceSwap.

```json
{
    "jobid": "<jobid>",
    "verb": "faceswap-listid",
    "status": "completed",
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:04:53.490Z",
    "discord": "<ABC…secured…xyz>",
    "server": "<Discord server id>",
    "channel": "<Discord channel id>",
    "replyUrl": "https://webhook.site/abc",
    "replyRef": "<your optional reference id>",
    "messageId": "<Discord message id>",
    "content": "{'id-list': ['ttt']}\n{'current-idname': 'ttt'}\n{'subscription': 'Free'}\n{'credits': '0/50'}",
    "timestamp": "2023-09-09T02:04:51.926000+00:00",
    "code": 200
}
```
{% endtab %}

{% tab post_faceswap-listid_response <span class="http-status-bad">400</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" rel="noreferrer" target="_blank"><span class="http-status-bad">400 Bad Request</span></a>

```json
{
    "error": 
      "Optional param replyRef is too long"
      "Optional param replyUrl is too long"
      "Required param channel is missing or empty"
      "Configuration not found for channel <channel>, to create POST v1/faceswap/account/<channel>"
    "code": 400
}
```
{% endtab %}


{% tab post_faceswap-listid_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>

```json
{
    "error": "Unauthorized",
    "code": 401
}
```
{% endtab %}

{% tab post_faceswap-listid_response <span class="http-status-bad">402</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402" rel="noreferrer" target="_blank"><span class="http-status-bad">402 Payment Required</span></a>

```json
{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}
```
{% endtab %}

{% tab post_faceswap-listid_response <span class="http-status-bad">429</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429" rel="noreferrer" target="_blank"><span class="http-status-bad">429 Too Many Requests</span></a>

Wait in a loop for **at least** 10..30 seconds and retry again.

There are two possible cases for API response 429.

1. API query is full and can not accept new [faceswap/listid](#insightfaceswap-listid-command) requests. 
```json
{
    "error": "Unable to lock Discord after <attempts> attempts",
    "code": 429
}
```
2. The API received an HTTP status 429 from the Discord API when it attempted to POST to the `/interactions` endpoint. Under normal circumstances, this should be a rare occurrence because the API is designed to strictly adhere to Discord rate limits. However, in certain scenarios, Discord may still issue a 429 response.
```json
{
    "error": "Discord /interactions failed with HTTP status 429",
    "errorDetails": "{\"global\":true,\"message\":\"You are being rate limited.\",\"retry_after\":10}",
    "code": 429
}
```
{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  jobid: string, 
  verb: 'faceswap-listid',
  status: 'completed' | 'failed',
  created: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  updated: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  discord: string, // Provided for debugging purposes only, contains the first 3 and the last 3 characters of the original value
  server: string,
  channel: string,
  replyUrl: string,
  replyRef: string,
  messageId: string,
  content: string, // Contains message generated by InsightFaceSwap 
  timestamp: string,
  error: string,
  errorDetails: string,
  code: number
}
```

##### Examples

{% tabs faceswap-listid_example %}

{% tab faceswap-listid_example Curl %}
``` bash
curl -H "Accept: application/json" \
     -H "Authorization: Bearer …" \
     -X POST https://api.useapi.net/v1/faceswap/listid \
     -F "channel=<Discord channel id>" 
```
{% endtab %}

{% tab faceswap-listid_example JavaScript %}
``` javascript
const main = async () => {
    const apiUrl = "https://api.useapi.net/v1/faceswap/listid";
    const token = "API token";
    const channel = "Discord channel";
    const data = {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${token}`
        }
    };
    const formData = new FormData();
    formData.append("channel", channel);
    data.body = formData;
    const response = await fetch(apiUrl, data);
    const result = await response.json();
    console.log("response", { response, result });
};
main()
```
{% endtab %}

{% tab faceswap-listid_example Python %}
``` python
import requests

api_url = "https://api.useapi.net/v1/faceswap/listid"
token = "API token"
channel = "Discord channel"

headers = {
    'Authorization': f'Bearer {token}'
}

files = {
    'channel': (None, channel)
}

response = requests.post(api_url, headers=headers, files=files)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-picsi ===
Document URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-picsi
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-post">POST</code> faceswap/picsi
parent: InsightFaceSwap API v1
nav_order: 450
---
## InsightFaceSwap [/picsi](https://www.patreon.com/posts/introducing-ai-5-101604168) command 
{: .no_toc }

<small>February 12, 2024 (November 18, 2024)</small>

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Use this endpoint to submit the InsightFaceSwap [/picsi](https://www.patreon.com/posts/introducing-ai-5-101604168) command to directly generate a Picsi.Ai face morph by attaching a source image and target image/gif/video. The result will be returned in the response body and can also be sent as a callback to an optional [`replyUrl`](#request-body). 

This is a blocking call, you will **not** be able to make another call to the same InsightFaceSwap Discord channel until the current call is completed. The average execution time is approximately 3 to 10 seconds. If you expect high load and need to make multiple concurrent calls, please consider setting up [multiple InsightFaceSwap accounts](https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel).

It is **important** not to use the InsightFaceSwap account setup for API access for any purposes other than its intended use, such as executing `/picsi` or any other InsightFaceSwap commands _manually_ or in conjunction with _any other_ automation tools. The useapi.net API internally tracks the usage of the InsightFaceSwap account, including the number of currently active executions. Using it for other activities may cause API to function incorrectly.

{: .post }
> **https://api.useapi.net/v1/faceswap/picsi**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
Content-Type: multipart/form-data
```
- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Request Body
```json
{
    "channel": "Discord channel id",
    "source_image": "Source image",
    "target_image_gif_or_video": "Target Image/GIF/Video",
    "options": "Optional parameters such as -f (Face Texturizer), -m (Retain Mouth) etc",
    "replyUrl": "Place your call back URL here",
    "replyRef": "Place your reference id here"
}
```
- `channel` is optional, if omitted a randomly selected [configured](https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel) channel with available credits will be used.

- `source_image` is **required**, source image. Must be either a [File](https://developer.mozilla.org/en-US/docs/Web/API/File) or [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) object when included in this [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) POST request.

- `target_image_gif_or_video` is **required**, target image/GIF/Video. Must be either a [File](https://developer.mozilla.org/en-US/docs/Web/API/File) or [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) object when included in this [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) POST request.  
<span class="required-input-field"><b>Important</b></span> Video currently *not* supported.

- `options` is optional, for parameters such as -f (Face Texturizer), -m (Retain Mouth), see [official help](https://discord.com/channels/1095014106576212101/1128550062683865178/1189615783433740349) for details.

  Options supported by **Free** version (this may not be a complete or current list, please refer to [official help](https://discord.com/channels/1095014106576212101/1128550062683865178/1189615783433740349)):
  * `-m` Keeps the mouth area of the target picture unchanged in the morphed result.
  * `--shut` Keeps eyes closed in your morphed results matching the closed eyes of the target face. To be used ONLY when the eyes are already closed in the target picture's face. This will NOT close eyes that are open.
  * `--ch` Corrects mismatches in chin and jawline between source and target faces.
  * `--hl` Addresses issues with bangs or low hairlines in source photos morphing incorrectly on target face.

  Options supported by **Paid** version (this may not be a complete or current list, please refer to [official help](https://discord.com/channels/1095014106576212101/1128550062683865178/1189615783433740349)):
  * `-f` Face Texturizer mode attempts to preserve intricate details of the target face like fine wrinkles, blemishes and freckles. 
  * `-s` Sharpen option adds clarity and definition. 
  *  `-e` Expression Matching synchronizes the expressions between your source face and the target face in the morph. This includes aspects like smiles, frowns, or any other facial expressions, aiming to retain the target face's expression in the resulting morph for enhanced realism.
  * `-e 1...1000` Expression intensity.
  * `-o` or `--oldify` Transforms faces in your images to appear older, offering an intriguing look into the future.
  * `-o 1...1000` Oldify intensity
  * `-y` Youngify is a unique feature that blends adult-like features from a source face onto young or childlike target pictures. It's designed to enhance the blend between adult features and a young-looking target face, but does not transform adults into children or make faces appear younger.
  * `-y 1...1000` Youngify intensity
  * `-a` ARTIFY enriches the morphing experience by enabling your photorealistic source face to blend seamlessly with a pre-stylized artistic target image. 
  * `-x` Xtreme specially designed for creating ultra-detailed, close-up portraits.

- `replyUrl` is optional, if not provided value from [useapi.net account](../account-management/get-account) will be used.  
  Place here your callback URL. API will call the provided `replyUrl` once job completed or failed.  
  Maximum length 1024 characters.  
  We recommend using sites like [webhook.site](https://webhook.site) to test callback URL functionality.  

 - `replyRef` is optional, place here your reference id which will be stored and returned along with this job response / result.  
  Maximum length 1024 characters.  
  
##### Responses 

{% tabs post_faceswap-picsi_response %}

{% tab post_faceswap-picsi_response <span class="http-status-good">200</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>

If field `status` returned as `started` use returned `jobid` to [retrieve InsightFaceSwap job status and results](../api-faceswap-v1/get-faceswap-jobid) or use callback `replyUrl`.

Field `content` contains message generated by InsightFaceSwap. Attachments array contains generated images.

```json
{
    "jobid": "<jobid>",
    "verb": "faceswap-picsi",
    "status": "completed",
    "options": "-m",
    "source_image": { "size": 2438986, "type": "image/png" },
    "target_image_gif_or_video": { "size": 1604758, "type": "image/png" },
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:04:53.490Z",
    "discord": "<ABC…secured…xyz>",
    "server": "<Discord server id>",
    "channel": "<Discord channel id>",
    "replyUrl": "https://webhook.site/abc",
    "replyRef": "<your optional reference id>",
    "messageId": "<Discord message id>",
    "content": "<@Discord user id>",
    "attachments": [
      {
        "url": "<generated image_1 url>",
        "proxy_url": "<generated proxy image_1 url>",
        "width": 2048,
        "height": 2048,
        "content_type": "<generated image_1 type>",
        "id": "<Discord image_1 id>",
        "filename": "<generated image_1 name>",
        "size": 7204115
      },
      {
        "url": "<generated image_N url>",
        "proxy_url": "<generated proxy image_N url>",
        "width": 2048,
        "height": 2048,
        "content_type": "<generated image_N type>",
        "id": "<Discord image id>",
        "filename": "<generated image_N name>",
        "size": 7204115
      }
    ],
    "timestamp": "2023-09-09T02:04:51.926000+00:00",
    "code": 200
}
```
{% endtab %}

{% tab post_faceswap-picsi_response <span class="http-status-bad">400</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" rel="noreferrer" target="_blank"><span class="http-status-bad">400 Bad Request</span></a>

```json
{
    "error": 
      "Required param source_image or target_image_gif_or_video is missing or empty"
      "Param source_image or target_image_gif_or_video is not File or Blob"
      "Optional param replyUrl or replyRef is too long"
      "Configuration not found for channel <channel>, to create POST v1/faceswap/account/<channel>"
    "code": 400
}
```
{% endtab %}

{% tab post_faceswap-picsi_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>

```json
{
    "error": "Unauthorized",
    "code": 401
}
```
{% endtab %}

{% tab post_faceswap-picsi_response <span class="http-status-bad">402</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402" rel="noreferrer" target="_blank"><span class="http-status-bad">402 Payment Required</span></a>

```json
{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}
```
{% endtab %}

{% tab post_faceswap-picsi_response <span class="http-status-bad">412</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/412" rel="noreferrer" target="_blank"><span class="http-status-bad">412 Insufficient credits</span></a>

```json
{
    "error": "Not enough credits: requested 3, available 0",
    "code": 412
}
```
{% endtab %}

{% tab post_faceswap-picsi_response <span class="http-status-bad">429</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429" rel="noreferrer" target="_blank"><span class="http-status-bad">429 Too Many Requests</span></a>

Wait in a loop for **at least** 10..30 seconds and retry again.

There are two possible cases for API response 429.

1. API query is full and can not accept new [faceswap/picsi](#insightfaceswap-picsi-command) requests. 
```json
{
    "error": "Unable to lock Discord after <attempts> attempts",
    "code": 429
}
```
1. The API received an HTTP status 429 from the Discord API when it attempted to POST to the `/interactions` endpoint. Under normal circumstances, this should be a rare occurrence because the API is designed to strictly adhere to Discord rate limits. However, in certain scenarios, Discord may still issue a 429 response.
```json
{
    "error": "Discord /interactions failed with HTTP status 429",
    "errorDetails": "{\"global\":true,\"message\":\"You are being rate limited.\",\"retry_after\":10}",
    "code": 429
}
```
{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  jobid: string, 
  verb: 'faceswap-picsi',
  status: 'started' | 'completed' | 'failed',
  options: string,
  source_image: { size: number, type: string },
  target_image_gif_or_video: { size: number, type: string },
  created: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  updated: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  discord: string, // Provided for debugging purposes only, contains the first 3 and the last 3 characters of the original value
  server: string,
  channel: string,
  replyUrl: string,
  replyRef: string,
  messageId: string,
  content: string, // Contains message generated by InsightFaceSwap 
  attachments: [
      {
          id: string,
          content_type: string,
          filename: string,
          url: string,
          proxy_url: string,
          size: number,
          width: number,
          height: number
      }
  ],  
  timestamp: string,
  error: string,
  errorDetails: string,
  code: number
}
```

##### Examples

{% tabs faceswap-picsi_example %}

{% tab faceswap-picsi_example Curl %}
``` bash
curl -H "Accept: application/json" \
     -H "Authorization: Bearer …" \
     -X POST https://api.useapi.net/v1/faceswap/picsi \
     -F "options=<options>" \ 
     -F 'source_image=@"<Path to the source_image>"' \
     -F 'target_image_gif_or_video=@"<Path to the target_image_gif_or_video>"' 
```
{% endtab %}

{% tab faceswap-picsi_example JavaScript %}
``` javascript
const main = async () => {
    const apiUrl = "https://api.useapi.net/v1/faceswap/picsi";
    const token = "API token";
    const options = "options";
    const channel = "Discord channel";
    const data = {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${token}`
        }
    };
    const formData = new FormData();
    formData.append("options", options);
    formData.append("channel", channel);

    /*
        // Example 1: Fetch image from URL
        const imageUrl = "https://upload.wikimedia.org/wikipedia/commons/7/7d/Mona_Lisa_color_restoration.jpg";
        const responseImage = await fetch(imageUrl);
        formData.append("source_image", await responseImage.blob());
    */
    /* 
        // Example 2: Load image from local file (Blob)
        const fsp = require('fs').promises;
        const imageFileName = "./target_photo.png";
        const blob = new Blob([await fsp.readFile(imageFileName)]);
        formData.append("target_image_gif_or_video", blob);
    */
    /*
        // Example 3: Load from input file html element
        // <input id="target-photo-image-file" type="file"> 
        const imageFile = document.getElementById(`target-photo-image-file`);
        if (imageFile.files[0])
            formData.append("target_image_gif_or_video", imageFile.files[0]);
    */

    data.body = formData;
    const response = await fetch(apiUrl, data);
    const result = await response.json();
    console.log("response", { response, result });
};
main()

```
{% endtab %}

{% tab faceswap-picsi_example Python %}
``` python
import requests

api_url = "https://api.useapi.net/v1/faceswap/picsi"
token = "API token"
options = "options"
channel = "Discord channel"

headers = {
    'Authorization': f'Bearer {token}'
}

files = {
    'options': (None, options),
    'channel': (None, channel)
}

# # Example 1: Fetch image from URL
# image_url = "https://upload.wikimedia.org/wikipedia/commons/7/7d/Mona_Lisa_color_restoration.jpg"
# response_image = requests.get(image_url)
# image_content = response_image.content
# files['source_image'] = ('image.jpg', image_content, 'image/jpeg')

# # Example 2: Load image from local file
# image_file_path = "./target_photo.png"
# with open(image_file_path, 'rb') as image_file:
#     files['target_image_gif_or_video'] = ('target_photo.png', image_file.read(), 'image/png')

response = requests.post(api_url, headers=headers, files=files)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-saveid ===
Document URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-saveid
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-post">POST</code> faceswap/saveid
parent: InsightFaceSwap API v1
nav_order: 600
---
## InsightFaceSwap [/saveid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#saveid-name-upload-id-image) command 
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Use this endpoint to submit the InsightFaceSwap [/saveid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#saveid-name-upload-id-image) command to your [InsightFaceSwap Discord channel](../start-here/setup-faceswap). The result will be returned in the response body and can also be sent as a callback to an optional [`replyUrl`](#request-body). 

This is a blocking call, you will **not** be able to make another call to the same InsightFaceSwap Discord channel until the current call is completed. The average execution time is approximately 3 to 10 seconds. If you expect high load and need to make multiple concurrent calls, please consider setting up [multiple InsightFaceSwap accounts](https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel).

It is **important** not to use the InsightFaceSwap account setup for API access for any purposes other than its intended use, such as executing `/saveid` or any other InsightFaceSwap commands _manually_ or in conjunction with _any other_ automation tools. The useapi.net API internally tracks the usage of the InsightFaceSwap account, including the number of currently active executions. Using it for other activities may cause API to function incorrectly.

{: .post }
> **https://api.useapi.net/v1/faceswap/saveid**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
Content-Type: multipart/form-data
```
- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Request Body
```json
{
    "channel": "Discord channel id",
    "idname": "idname param",
    "image": "Image File or Blob"
}
```
- `channel` is optional when only one [faceswap/account](../api-faceswap-v1/get-faceswap-account) configured. However, if you have multiple accounts configured, this parameter becomes **required**.

- `idname` is **required**, please refer to InsightFaceSwap [/saveid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#saveid-name-upload-id-image) for details.

- `image` is **required**, image to upload and register for subsequent facial replacement and editing. Must be either a [File](https://developer.mozilla.org/en-US/docs/Web/API/File) or [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) object when included in this [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) POST request.

- `replyUrl` is optional, if not provided value from [useapi.net account](../account-management/get-account) will be used.  
  Place here your callback URL. API will call the provided `replyUrl` once job completed or failed.  
  Maximum length 1024 characters.  
  We recommend using sites like [webhook.site](https://webhook.site) to test callback URL functionality.  

 - `replyRef` is optional, place here your reference id which will be stored and returned along with this job response / result.  
  Maximum length 1024 characters.  
  
##### Responses 

{% tabs post_faceswap-saveid_response %}

{% tab post_faceswap-saveid_response <span class="http-status-good">200</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>

Field `content` contains message generated by InsightFaceSwap.

```json
{
    "jobid": "<jobid>",
    "verb": "faceswap-saveid",
    "status": "completed",
    "idname": "me",
    "image": { "size": 1699405, "type": "image/png" },
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:04:53.490Z",
    "discord": "<ABC…secured…xyz>",
    "server": "<Discord server id>",
    "channel": "<Discord channel id>",
    "replyUrl": "https://webhook.site/abc",
    "replyRef": "<your optional reference id>",
    "messageId": "<Discord message id>",
    "content": "idname me created",
    "timestamp": "2023-09-09T02:04:51.926000+00:00",
    "code": 200
}
```
{% endtab %}

{% tab post_faceswap-saveid_response <span class="http-status-bad">400</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" rel="noreferrer" target="_blank"><span class="http-status-bad">400 Bad Request</span></a>

```json
{
    "error": 
      "Required param idname is missing or empty"
      "Required param image is missing or empty"
      "Param image is not File or Blob"
      "Optional param replyRef is too long"
      "Optional param replyUrl is too long"
      "Required param channel is missing or empty"
      "Configuration not found for channel <channel>, to create POST v1/faceswap/account/<channel>"
    "code": 400
}
```
{% endtab %}


{% tab post_faceswap-saveid_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>

```json
{
    "error": "Unauthorized",
    "code": 401
}
```
{% endtab %}

{% tab post_faceswap-saveid_response <span class="http-status-bad">402</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402" rel="noreferrer" target="_blank"><span class="http-status-bad">402 Payment Required</span></a>

```json
{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}
```
{% endtab %}

{% tab post_faceswap-saveid_response <span class="http-status-bad">429</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429" rel="noreferrer" target="_blank"><span class="http-status-bad">429 Too Many Requests</span></a>

Wait in a loop for **at least** 10..30 seconds and retry again.

There are two possible cases for API response 429.

1. API query is full and can not accept new [faceswap/saveid](#insightfaceswap-saveid-command) requests. 
```json
{
    "error": "Unable to lock Discord after <attempts> attempts",
    "code": 429
}
```
2. The API received an HTTP status 429 from the Discord API when it attempted to POST to the `/interactions` endpoint. Under normal circumstances, this should be a rare occurrence because the API is designed to strictly adhere to Discord rate limits. However, in certain scenarios, Discord may still issue a 429 response.
```json
{
    "error": "Discord /interactions failed with HTTP status 429",
    "errorDetails": "{\"global\":true,\"message\":\"You are being rate limited.\",\"retry_after\":10}",
    "code": 429
}
```
{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  jobid: string, 
  verb: 'faceswap-saveid',
  status: 'completed' | 'failed',
  idname: string,
  image: { size: number, type: string },
  created: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  updated: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  discord: string, // Provided for debugging purposes only, contains the first 3 and the last 3 characters of the original value
  server: string,
  channel: string,
  replyUrl: string,
  replyRef: string,
  messageId: string,
  content: string, // Contains message generated by InsightFaceSwap 
  timestamp: string,
  error: string,
  errorDetails: string,
  code: number
}
```

##### Examples

{% tabs faceswap-saveid_example %}

{% tab faceswap-saveid_example Curl %}
``` bash
curl -H "Accept: application/json" \
     -H "Authorization: Bearer …" \
     -X POST https://api.useapi.net/v1/faceswap/saveid \
     -F "channel=<Discord channel id>" \
     -F 'image=@"<Path to the image>"' \
     -F "idname=<idname>" 
```
{% endtab %}

{% tab faceswap-saveid_example JavaScript %}
``` javascript
const main = async () => {
    const apiUrl = "https://api.useapi.net/v1/faceswap/saveid";
    const token = "API token";
    const idname = "idname";
    const channel = "Discord channel";
    const data = {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${token}`
        }
    };
    const formData = new FormData();
    formData.append("idname", idname);
    formData.append("channel", channel);
    /*
        // Example 1: Fetch image from URL
        const imageUrl = "https://upload.wikimedia.org/wikipedia/commons/7/7d/Mona_Lisa_color_restoration.jpg";
        const responseImage = await fetch(imageUrl);
        formData.append("image", await responseImage.blob());
    */
    /* 
        // Example 2: Load image from local file (Blob)
        const fsp = require('fs').promises;
        const imageFileName = "./my_photo.png";
        const blob = new Blob([await fsp.readFile(imageFileName)]);
        formData.append("image", blob);
    */
    /*
        // Example 3: Load from input file html element
        // <input id="my-photo-image-file" type="file"> 
        const imageFile = document.getElementById(`my-photo-image-file`);
        if (imageFile.files[0])
            formData.append("image", imageFile.files[0]);
    */
    data.body = formData;
    const response = await fetch(apiUrl, data);
    const result = await response.json();
    console.log("response", { response, result });
};
main()

```
{% endtab %}

{% tab faceswap-saveid_example Python %}
``` python
import requests

api_url = "https://api.useapi.net/v1/faceswap/saveid"
token = "API token"
idname = "idname"
channel = "Discord channel"

headers = {
    'Authorization': f'Bearer {token}'
}

files = {
    'idname': (None, idname),
    'channel': (None, channel)
}

# # Example 1: Fetch image from URL
# image_url = "https://upload.wikimedia.org/wikipedia/commons/7/7d/Mona_Lisa_color_restoration.jpg"
# response_image = requests.get(image_url)
# image_content = response_image.content
# files['image'] = ('image.jpg', image_content, 'image/jpeg')

# # Example 2: Load image from local file
# image_file_path = "./my_photo.png"
# with open(image_file_path, 'rb') as image_file:
#     files['image'] = ('my_photo.png', image_file.read(), 'image/png')

response = requests.post(api_url, headers=headers, files=files)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-setid ===
Document URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-setid
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-post">POST</code> faceswap/setid
parent: InsightFaceSwap API v1
nav_order: 1000
---
## InsightFaceSwap [/setid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#setid-nameprefer) command 
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Use this endpoint to submit the InsightFaceSwap [/setid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#setid-nameprefer) command to your [InsightFaceSwap Discord channel](../start-here/setup-faceswap). The result will be returned in the response body and can also be sent as a callback to an optional [`replyUrl`](#request-body). 

This is a blocking call, you will **not** be able to make another call to the same InsightFaceSwap Discord channel until the current call is completed. The average execution time is approximately 3 to 10 seconds. If you expect high load and need to make multiple concurrent calls, please consider setting up [multiple InsightFaceSwap accounts](https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel).

It is **important** not to use the InsightFaceSwap account setup for API access for any purposes other than its intended use, such as executing `/setid` or any other InsightFaceSwap commands _manually_ or in conjunction with _any other_ automation tools. The useapi.net API internally tracks the usage of the InsightFaceSwap account, including the number of currently active executions. Using it for other activities may cause API to function incorrectly.

{: .post }
> **https://api.useapi.net/v1/faceswap/setid**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
Content-Type: multipart/form-data
```
- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Request Body
```json
{
    "channel": "Discord channel id",
    "idname": "idname param",
}
```
- `channel` is optional when only one [faceswap/account](../api-faceswap-v1/get-faceswap-account) configured. However, if you have multiple accounts configured, this parameter becomes **required**.

- `idname` is **required**, please refer to InsightFaceSwap [/setid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#setid-nameprefer) for details.

- `replyUrl` is optional, if not provided value from [useapi.net account](../account-management/get-account) will be used.  
  Place here your callback URL. API will call the provided `replyUrl` once job completed or failed.  
  Maximum length 1024 characters.  
  We recommend using sites like [webhook.site](https://webhook.site) to test callback URL functionality.  

 - `replyRef` is optional, place here your reference id which will be stored and returned along with this job response / result.  
  Maximum length 1024 characters.  
  
##### Responses 

{% tabs post_faceswap-setid_response %}

{% tab post_faceswap-setid_response <span class="http-status-good">200</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>

Field `content` contains message generated by InsightFaceSwap.

```json
{
    "jobid": "<jobid>",
    "verb": "faceswap-setid",
    "status": "completed",
    "idname": "me",
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:04:53.490Z",
    "discord": "<ABC…secured…xyz>",
    "server": "<Discord server id>",
    "channel": "<Discord channel id>",
    "replyUrl": "https://webhook.site/abc",
    "replyRef": "<your optional reference id>",
    "messageId": "<Discord message id>",
    "content": "current idname updated",
    "timestamp": "2023-09-09T02:04:51.926000+00:00",
    "code": 200
}
```
{% endtab %}

{% tab post_faceswap-setid_response <span class="http-status-bad">400</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" rel="noreferrer" target="_blank"><span class="http-status-bad">400 Bad Request</span></a>

```json
{
    "error": 
      "Required param idname is missing or empty"
      "Optional param replyRef is too long"
      "Optional param replyUrl is too long"
      "Required param channel is missing or empty"
      "Configuration not found for channel <channel>, to create POST v1/faceswap/account/<channel>"
    "code": 400
}
```
{% endtab %}


{% tab post_faceswap-setid_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>

```json
{
    "error": "Unauthorized",
    "code": 401
}
```
{% endtab %}

{% tab post_faceswap-setid_response <span class="http-status-bad">402</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402" rel="noreferrer" target="_blank"><span class="http-status-bad">402 Payment Required</span></a>

```json
{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}
```
{% endtab %}

{% tab post_faceswap-setid_response <span class="http-status-bad">429</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429" rel="noreferrer" target="_blank"><span class="http-status-bad">429 Too Many Requests</span></a>

Wait in a loop for **at least** 10..30 seconds and retry again.

There are two possible cases for API response 429.

1. API query is full and can not accept new [faceswap/setid](#insightfaceswap-setid-command) requests. 
```json
{
    "error": "Unable to lock Discord after <attempts> attempts",
    "code": 429
}
```
2. The API received an HTTP status 429 from the Discord API when it attempted to POST to the `/interactions` endpoint. Under normal circumstances, this should be a rare occurrence because the API is designed to strictly adhere to Discord rate limits. However, in certain scenarios, Discord may still issue a 429 response.
```json
{
    "error": "Discord /interactions failed with HTTP status 429",
    "errorDetails": "{\"global\":true,\"message\":\"You are being rate limited.\",\"retry_after\":10}",
    "code": 429
}
```
{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  jobid: string, 
  verb: 'faceswap-setid',
  status: 'completed' | 'failed',
  idname: string,
  created: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  updated: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  discord: string, // Provided for debugging purposes only, contains the first 3 and the last 3 characters of the original value
  server: string,
  channel: string,
  replyUrl: string,
  replyRef: string,
  messageId: string,
  content: string, // Contains message generated by InsightFaceSwap 
  timestamp: string,
  error: string,
  errorDetails: string,
  code: number
}
```

##### Examples

{% tabs faceswap-setid_example %}

{% tab faceswap-setid_example Curl %}
``` bash
curl -H "Accept: application/json" \
     -H "Authorization: Bearer …" \
     -X POST https://api.useapi.net/v1/faceswap/setid \
     -F "channel=<Discord channel id>" \
     -F "idname=<idname>" 
```
{% endtab %}

{% tab faceswap-setid_example JavaScript %}
``` javascript
const main = async () => {
    const apiUrl = "https://api.useapi.net/v1/faceswap/setid";
    const token = "API token";
    const channel = "Discord channel";
    const idname = "idname";
    const data = {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${token}`
        }
    };
    const formData = new FormData();
    formData.append("channel", channel);
    formData.append("idname", idname);
    data.body = formData;
    const response = await fetch(apiUrl, data);
    const result = await response.json();
    console.log("response", { response, result });
};
main()
```
{% endtab %}

{% tab faceswap-setid_example Python %}
``` python
import requests

api_url = "https://api.useapi.net/v1/faceswap/setid"
token = "API token"
channel = "Discord channel"
idname = "idname"

headers = {
    'Authorization': f'Bearer {token}'
}

files = {
    'channel': (None, channel),
    'idname': (None, idname)
}

response = requests.post(api_url, headers=headers, files=files)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-swap ===
Document URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-swap
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-post">POST</code> faceswap/swap
parent: InsightFaceSwap API v1
nav_order: 800
---
## Execute InsightFaceSwap [/saveid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#saveid-name-upload-id-image) command immediately following by [/swapid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#swapid-names-upload-image) command.
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---
<span class="required-input-field"><b>As of July 23, 2024 this endpoint is deprecated.</b></span>   
**We suggest using recently added [faceswap/picsi](../api-faceswap-v1/post-faceswap-picsi) instead.**

This endpoint to execute the InsightFaceSwap [/saveid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#saveid-name-upload-id-image) and [/swapid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#swapid-names-upload-image)  command as a single call. The result will be returned in the response body and can also be sent as a callback to an optional [`replyUrl`](#request-body). 

Use this endpoint if you want to swap the face from a source image, identified by `/saveid`, onto a target image designated by `/swapid`, in a single API call.

This is a blocking call, you will **not** be able to make another call to the same InsightFaceSwap Discord channel until the current call is completed. The average execution time is approximately 7 to 20 seconds. If you expect high load and need to make multiple concurrent calls, please consider setting up [multiple InsightFaceSwap accounts](https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel).

It is **important** not to use the InsightFaceSwap account setup for API access for any purposes other than its intended use, such as executing `/swap` or any other InsightFaceSwap commands _manually_ or in conjunction with _any other_ automation tools. The useapi.net API internally tracks the usage of the InsightFaceSwap account, including the number of currently active executions. Using it for other activities may cause API to function incorrectly.

{: .post }
> **https://api.useapi.net/v1/faceswap/swap**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
Content-Type: multipart/form-data
```
- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Request Body
```json
{
    "channel": "Discord channel id",
    "saveid_idname": "idname param to be used for /saveid command",
    "saveid_image": "Source image File or Blob",
    "swapid_idname": "idname param to be used for /swapid command",
    "swapid_image": "Target image File or Blob"
}
```
- `channel` is optional, if omitted a randomly selected [configured](https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel) channel with available credits will be used.

- `saveid_idname` is optional, if omitted it will default to `id`. Please refer to InsightFaceSwap [/saveid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#saveid-name-upload-id-image) for details.

- `saveid_image` is **required**, image to upload and register for subsequent facial replacement and editing. Must be either a [File](https://developer.mozilla.org/en-US/docs/Web/API/File) or [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) object when included in this [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) POST request.

- `swapid_idname` is optional, if omitted it will default to `id`. Please refer to InsightFaceSwap [/swapid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#swapid-names-upload-image) for details.

- `swapid_image` is **required**, target image to be uploaded for replacing the face identified by the `idname` parameter mentioned above. Must be either a [File](https://developer.mozilla.org/en-US/docs/Web/API/File) or [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) object when included in this [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) POST request.


- `replyUrl` is optional, if not provided value from [useapi.net account](../account-management/get-account) will be used.  
  Place here your callback URL. API will call the provided `replyUrl` once job completed or failed.  
  Maximum length 1024 characters.  
  We recommend using sites like [webhook.site](https://webhook.site) to test callback URL functionality.  

 - `replyRef` is optional, place here your reference id which will be stored and returned along with this job response / result.  
  Maximum length 1024 characters.  
  
##### Responses 

{% tabs post_faceswap-swap_response %}

{% tab post_faceswap-swap_response <span class="http-status-good">200</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>

Field `content` contains message generated by InsightFaceSwap. Attachments array contains generated image.

```json
{
    "jobid": "<jobid>",
    "verb": "faceswap-swap",
    "status": "completed",
    "saveid_idname": "id",
    "saveid_image": { "size": 2408432, "type": "image/png" },
    "swapid_idname": "id",
    "swapid_image": { "size": 2273656, "type": "image/png" },
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:04:53.490Z",
    "discord": "<ABC…secured…xyz>",
    "server": "<Discord server id>",
    "channel": "<Discord channel id>",
    "replyUrl": "https://webhook.site/abc",
    "replyRef": "<your optional reference id>",
    "messageId": "<Discord message id>",
    "content": "Picsi.Ai ver.2.0 [SaveID: 'id'] [<@Discord user id>] (80/200 credits used)",
    "attachments": [
      {
        "url": "<generated image url>",
        "proxy_url": "<generated proxy image url>",
        "width": 2048,
        "height": 2048,
        "content_type": "<generated image type>",
        "id": "<Discord image id>",
        "filename": "<generated image name>",
        "size": 7204115
      }
    ],
    "timestamp": "2023-09-09T02:04:51.926000+00:00",
    "code": 200
}
```
{% endtab %}

{% tab post_faceswap-swap_response <span class="http-status-bad">400</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" rel="noreferrer" target="_blank"><span class="http-status-bad">400 Bad Request</span></a>

```json
{
    "error": 
      "Required param saveid_image is missing or empty"
      "Required param swapid_image is missing or empty"
      "Param saveid_image is not File or Blob"
      "Param swapid_image is not File or Blob"
      "Optional param replyRef is too long"
      "Optional param replyUrl is too long"
      "Required param channel is missing or empty"
      "Configuration not found for channel <channel>, to create POST v1/faceswap/account/<channel>"
    "code": 400
}
```
{% endtab %}


{% tab post_faceswap-swap_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>

```json
{
    "error": "Unauthorized",
    "code": 401
}
```
{% endtab %}

{% tab post_faceswap-swap_response <span class="http-status-bad">402</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402" rel="noreferrer" target="_blank"><span class="http-status-bad">402 Payment Required</span></a>

```json
{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}
```
{% endtab %}

{% tab post_faceswap-swap_response <span class="http-status-bad">429</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429" rel="noreferrer" target="_blank"><span class="http-status-bad">429 Too Many Requests</span></a>

Wait in a loop for **at least** 10..30 seconds and retry again.

There are two possible cases for API response 429.

1. API query is full and can not accept new [faceswap/swap](#insightfaceswap-swap-command) requests. 
```json
{
    "error": "Unable to lock Discord after <attempts> attempts",
    "code": 429
}
```
2. The API received an HTTP status 429 from the Discord API when it attempted to POST to the `/interactions` endpoint. Under normal circumstances, this should be a rare occurrence because the API is designed to strictly adhere to Discord rate limits. However, in certain scenarios, Discord may still issue a 429 response.
```json
{
    "error": "Discord /interactions failed with HTTP status 429",
    "errorDetails": "{\"global\":true,\"message\":\"You are being rate limited.\",\"retry_after\":10}",
    "code": 429
}
```
{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  jobid: string, 
  verb: 'faceswap-swap',
  status: 'completed' | 'failed',
  saveid_idname: string,
  saveid_image: { size: number, type: string },
  swapid_idname: string,
  swapid_image: { size: number, type: string },
  created: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  updated: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  discord: string, // Provided for debugging purposes only, contains the first 3 and the last 3 characters of the original value
  server: string,
  channel: string,
  replyUrl: string,
  replyRef: string,
  messageId: string,
  content: string, // Contains message generated by InsightFaceSwap 
  attachments: [
      {
          id: string,
          content_type: string,
          filename: string,
          url: string,
          proxy_url: string,
          size: number,
          width: number,
          height: number
      }
  ],  
  timestamp: string,
  error: string,
  errorDetails: string,
  code: number
}
```

##### Examples

{% tabs faceswap-swap_example %}

{% tab faceswap-swap_example Curl %}
``` bash
curl -H "Accept: application/json" \
     -H "Authorization: Bearer …" \
     -X POST https://api.useapi.net/v1/faceswap/swap \
     -F "channel=<Discord channel id>" \
     -F 'saveid_image=@"<Path to the image>"' \
     -F "saveid_idname=<idname>" \ 
     -F 'swapid_image=@"<Path to the image>"' \
     -F "swapid_idname=<idname>" 
```
{% endtab %}

{% tab faceswap-swap_example JavaScript %}
``` javascript
const main = async () => {
    const apiUrl = "https://api.useapi.net/v1/faceswap/swap";
    const token = "API token";
    const saveid_idname = "saveid_idname";
    const swapid_idname = "swapid_idname";
    const channel = "Discord channel";
    const data = {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${token}`
        }
    };
    const formData = new FormData();
    formData.append("saveid_idname", idname);
    formData.append("swapid_idname", idname);
    formData.append("channel", channel);
    /*
        // Example 1: Fetch image from URL
        const imageUrl = "https://upload.wikimedia.org/wikipedia/commons/7/7d/Mona_Lisa_color_restoration.jpg";
        const responseImage = await fetch(imageUrl);
        formData.append("image", await responseImage.blob());
    */
    /* 
        // Example 2: Load image from local file (Blob)
        const fsp = require('fs').promises;
        const imageFileName = "./target_photo.png";
        const blob = new Blob([await fsp.readFile(imageFileName)]);
        formData.append("image", blob);
    */
    /*
        // Example 3: Load from input file html element
        // <input id="target-photo-image-file" type="file"> 
        const imageFile = document.getElementById(`target-photo-image-file`);
        if (imageFile.files[0])
            formData.append("image", imageFile.files[0]);
    */
    data.body = formData;
    const response = await fetch(apiUrl, data);
    const result = await response.json();
    console.log("response", { response, result });
};
main()

```
{% endtab %}

{% tab faceswap-swap_example Python %}
``` python
import requests

api_url = "https://api.useapi.net/v1/faceswap/swap"
token = "API token"
saveid_idname = "saveid_idname"
swapid_idname = "swapid_idname"
channel = "Discord channel"

headers = {
    'Authorization': f'Bearer {token}'
}

files = {
    'saveid_idname': (None, saveid_idname),
    'swapid_idname': (None, swapid_idname),
    'channel': (None, channel)
}

# # Example 1: Fetch image from URL
# image_url = "https://upload.wikimedia.org/wikipedia/commons/7/7d/Mona_Lisa_color_restoration.jpg"
# response_image = requests.get(image_url)
# image_content = response_image.content
# files['image'] = ('image.jpg', image_content, 'image/jpeg')

# # Example 2: Load image from local file
# image_file_path = "./target_photo.png"
# with open(image_file_path, 'rb') as image_file:
#     files['image'] = ('target_photo.png', image_file.read(), 'image/png')

response = requests.post(api_url, headers=headers, files=files)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-swapid ===
Document URL: https://useapi.net/docs/api-faceswap-v1/post-faceswap-swapid
---
layout: default
title: <code class="language-plaintext highlighter-rouge background-method-post">POST</code> faceswap/swapid
parent: InsightFaceSwap API v1
nav_order: 700
---
## InsightFaceSwap [/swapid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#swapid-names-upload-image) command 
{: .no_toc }

<small>February 12, 2024 (November 18, 2024)</small>

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Use this endpoint to submit the InsightFaceSwap [/swapid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#swapid-names-upload-image) command to your [InsightFaceSwap Discord channel](../start-here/setup-faceswap). The result will be returned in the response body and can also be sent as a callback to an optional [`replyUrl`](#request-body). 

This is a blocking call, you will **not** be able to make another call to the same InsightFaceSwap Discord channel until the current call is completed. The average execution time is approximately 3 to 10 seconds. If you expect high load and need to make multiple concurrent calls, please consider setting up [multiple InsightFaceSwap accounts](https://useapi.net/docs/api-faceswap-v1/post-faceswap-account-channel).

It is **important** not to use the InsightFaceSwap account setup for API access for any purposes other than its intended use, such as executing `/swapid` or any other InsightFaceSwap commands _manually_ or in conjunction with _any other_ automation tools. The useapi.net API internally tracks the usage of the InsightFaceSwap account, including the number of currently active executions. Using it for other activities may cause API to function incorrectly.

{: .post }
> **https://api.useapi.net/v1/faceswap/swapid**

##### Request Headers
``` yaml
Authorization: Bearer {API token}
Content-Type: multipart/form-data
```
- `API token` is **required**, see [Setup useapi.net](../start-here/setup-useapi) for details.   

##### Request Body
```json
{
    "channel": "Discord channel id",
    "idname": "idname param",
    "image": "Image File or Blob"
}
```
- `channel` is optional when only one [faceswap/account](../api-faceswap-v1/get-faceswap-account) configured. However, if you have multiple accounts configured, this parameter becomes **required**.

- `idname` is **required**, please refer to InsightFaceSwap [/swapid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#swapid-names-upload-image) for details.

- `image` is **required**, target image to be uploaded for replacing the face identified by the `idname` parameter mentioned above. Must be either a [File](https://developer.mozilla.org/en-US/docs/Web/API/File) or [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) object when included in this [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) POST request.

- `replyUrl` is optional, if not provided value from [useapi.net account](../account-management/get-account) will be used.  
  Place here your callback URL. API will call the provided `replyUrl` once job completed or failed.  
  Maximum length 1024 characters.  
  We recommend using sites like [webhook.site](https://webhook.site) to test callback URL functionality.  

 - `replyRef` is optional, place here your reference id which will be stored and returned along with this job response / result.  
  Maximum length 1024 characters.  
  
##### Responses 

{% tabs post_faceswap-swapid_response %}

{% tab post_faceswap-swapid_response <span class="http-status-good">200</span> %}

<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200" rel="noreferrer" target="_blank"><span class="http-status-good">200 OK</span></a>

Field `content` contains message generated by InsightFaceSwap. Attachments array contains generated image.

```json
{
    "jobid": "<jobid>",
    "verb": "faceswap-swapid",
    "status": "completed",
    "idname": "me",
    "image": { "size": 1699405, "type": "image/png" },
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:04:53.490Z",
    "discord": "<ABC…secured…xyz>",
    "server": "<Discord server id>",
    "channel": "<Discord channel id>",
    "replyUrl": "https://webhook.site/abc",
    "replyRef": "<your optional reference id>",
    "messageId": "<Discord message id>",
    "content": "Picsi.Ai ver.2.0 [SaveID: 'me'] [<@Discord user id>] (79/200 credits used)",
    "attachments": [
      {
        "url": "<generated image url>",
        "proxy_url": "<generated proxy image url>",
        "width": 2048,
        "height": 2048,
        "content_type": "<generated image type>",
        "id": "<Discord image id>",
        "filename": "<generated image name>",
        "size": 7204115
      }
    ],
    "timestamp": "2023-09-09T02:04:51.926000+00:00",
    "code": 200
}
```
{% endtab %}

{% tab post_faceswap-swapid_response <span class="http-status-bad">400</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" rel="noreferrer" target="_blank"><span class="http-status-bad">400 Bad Request</span></a>

```json
{
    "error": 
      "Required param idname is missing or empty"
      "Required param image is missing or empty"
      "Param image is not File or Blob"
      "Optional param replyRef is too long"
      "Optional param replyUrl is too long"
      "Required param channel is missing or empty"
      "Configuration not found for channel <channel>, to create POST v1/faceswap/account/<channel>"
    "code": 400
}
```
{% endtab %}


{% tab post_faceswap-swapid_response <span class="http-status-bad">401</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401" rel="noreferrer" target="_blank"><span class="http-status-bad">401 Unauthorized</span></a>

```json
{
    "error": "Unauthorized",
    "code": 401
}
```
{% endtab %}

{% tab post_faceswap-swapid_response <span class="http-status-bad">402</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402" rel="noreferrer" target="_blank"><span class="http-status-bad">402 Payment Required</span></a>

```json
{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}
```
{% endtab %}

{% tab post_faceswap-swapid_response <span class="http-status-bad">412</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/412" rel="noreferrer" target="_blank"><span class="http-status-bad">412 Insufficient credits</span></a>

```json
{
    "error": "Not enough credits: requested 3, available 0",
    "code": 412
}
```
{% endtab %}


{% tab post_faceswap-swapid_response <span class="http-status-bad">429</span> %}
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429" rel="noreferrer" target="_blank"><span class="http-status-bad">429 Too Many Requests</span></a>

Wait in a loop for **at least** 10..30 seconds and retry again.

There are two possible cases for API response 429.

1. API query is full and can not accept new [faceswap/swapid](#insightfaceswap-swapid-command) requests. 
```json
{
    "error": "Unable to lock Discord after <attempts> attempts",
    "code": 429
}
```
2. The API received an HTTP status 429 from the Discord API when it attempted to POST to the `/interactions` endpoint. Under normal circumstances, this should be a rare occurrence because the API is designed to strictly adhere to Discord rate limits. However, in certain scenarios, Discord may still issue a 429 response.
```json
{
    "error": "Discord /interactions failed with HTTP status 429",
    "errorDetails": "{\"global\":true,\"message\":\"You are being rate limited.\",\"retry_after\":10}",
    "code": 429
}
```
{% endtab %}

{% endtabs %}

##### Model 
```typescript
{ // TypeScript, all fields are optional
  jobid: string, 
  verb: 'faceswap-swapid',
  status: 'completed' | 'failed',
  idname: string,
  image: { size: number, type: string },
  created: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  updated: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  discord: string, // Provided for debugging purposes only, contains the first 3 and the last 3 characters of the original value
  server: string,
  channel: string,
  replyUrl: string,
  replyRef: string,
  messageId: string,
  content: string, // Contains message generated by InsightFaceSwap 
  attachments: [
      {
          id: string,
          content_type: string,
          filename: string,
          url: string,
          proxy_url: string,
          size: number,
          width: number,
          height: number
      }
  ],  
  timestamp: string,
  error: string,
  errorDetails: string,
  code: number
}
```

##### Examples

{% tabs faceswap-swapid_example %}

{% tab faceswap-swapid_example Curl %}
``` bash
curl -H "Accept: application/json" \
     -H "Authorization: Bearer …" \
     -X POST https://api.useapi.net/v1/faceswap/swapid \
     -F "channel=<Discord channel id>" \
     -F 'image=@"<Path to the image>"' \
     -F "idname=<idname>" 
```
{% endtab %}

{% tab faceswap-swapid_example JavaScript %}
``` javascript
const main = async () => {
    const apiUrl = "https://api.useapi.net/v1/faceswap/swapid";
    const token = "API token";
    const idname = "idname";
    const channel = "Discord channel";
    const data = {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${token}`
        }
    };
    const formData = new FormData();
    formData.append("idname", idname);
    formData.append("channel", channel);
    /*
        // Example 1: Fetch image from URL
        const imageUrl = "https://upload.wikimedia.org/wikipedia/commons/7/7d/Mona_Lisa_color_restoration.jpg";
        const responseImage = await fetch(imageUrl);
        formData.append("image", await responseImage.blob());
    */
    /* 
        // Example 2: Load image from local file (Blob)
        const fsp = require('fs').promises;
        const imageFileName = "./target_photo.png";
        const blob = new Blob([await fsp.readFile(imageFileName)]);
        formData.append("image", blob);
    */
    /*
        // Example 3: Load from input file html element
        // <input id="target-photo-image-file" type="file"> 
        const imageFile = document.getElementById(`target-photo-image-file`);
        if (imageFile.files[0])
            formData.append("image", imageFile.files[0]);
    */
    data.body = formData;
    const response = await fetch(apiUrl, data);
    const result = await response.json();
    console.log("response", { response, result });
};
main()

```
{% endtab %}

{% tab faceswap-swapid_example Python %}
``` python
import requests

api_url = "https://api.useapi.net/v1/faceswap/swapid"
token = "API token"
idname = "idname"
channel = "Discord channel"

headers = {
    'Authorization': f'Bearer {token}'
}

files = {
    'idname': (None, idname),
    'channel': (None, channel)
}

# # Example 1: Fetch image from URL
# image_url = "https://upload.wikimedia.org/wikipedia/commons/7/7d/Mona_Lisa_color_restoration.jpg"
# response_image = requests.get(image_url)
# image_content = response_image.content
# files['image'] = ('image.jpg', image_content, 'image/jpeg')

# # Example 2: Load image from local file
# image_file_path = "./target_photo.png"
# with open(image_file_path, 'rb') as image_file:
#     files['image'] = ('target_photo.png', image_file.read(), 'image/png')

response = requests.post(api_url, headers=headers, files=files)
print(response, response.json())
```
{% endtab %}

{% endtabs %}


=== URL: https://useapi.net/docs/api-faceswap-v1/setup-multiple-faceswap-accounts ===
Document URL: https://useapi.net/docs/api-faceswap-v1/setup-multiple-faceswap-accounts
---
layout: default
title: ⚙️ Setup multiple accounts
parent: InsightFaceSwap API v1
nav_order: 6000
---
## How to use multiple InsightFaceSwap accounts 
{: .no_toc }

Before you start using the API, you **must** [configure](../start-here/setup-faceswap) at least one InsightFaceSwap Discord [faceswap/account](../api-faceswap-v1/get-faceswap-account). You may specify multiple InsightFaceSwap accounts, the API will automatically perform load balancing by randomly selecting an account with available credits before making calls to InsightFaceSwap Discord bot.

To take advantage of saved configurations and account load balancing, please follow these simple steps:
- Gather your InsightFaceSwap account(s) information as outlined at [Setup InsightFaceSwap](../start-here/setup-faceswap).
- Post your configuration(s) using the [faceswap/account/`channel`](../api-faceswap-v1/post-faceswap-account-channel) endpoint.

To see all your currently configured InsightFaceSwap accounts, please use the [faceswap/account](../api-faceswap-v1/get-faceswap-account) endpoint.

Feel free to [reach out to us](../support) if you have any questions or concerns.


=== URL: https://useapi.net/docs/questions-and-answers ===
Document URL: https://useapi.net/docs/questions-and-answers
---
title: Q&A
nav_order: 110000
layout: home
---

# Questions and Answers
{: .no_toc }

<small>4 min read • September 2023 (January 14, 2026)</small>

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

### How to avoid Midjourney bans?  

Using automation is against Discord and Midjourney's Terms of Service, so you need to plan accordingly and have backup account(s) ready. 

* The best practice is to create several new Discord accounts and join the Midjourney Discord server. These accounts should be used exclusively for API work and nothing else. We strongly recommend using a VPN to prevent your personal data/IP addresses from being leaked. You can use the [Opera](https://www.opera.com/download) browser with built-in VPN or the [Brave](https://brave.com/download) browser with [Tor support](https://support.brave.com/hc/en-us/articles/360018121491-What-is-a-Private-Window-with-Tor-Connectivity).

* Brand new/fresh Discord accounts have a significantly higher chance of being banned when running high Midjourney generation loads. Consider purchasing aged Discord accounts (2-3 years old) from marketplaces like [z2u.com](https://www.z2u.com/) for around $1-3 each. Aged accounts appear more legitimate and are less likely to trigger automated bans.

* When creating accounts in bulk, make sure to restart Opera/Brave so that your IP is different every time, since Discord tracks and records the IP addresses used to create new accounts. Make sure to log in to the Discord accounts designated for API use through a VPN. When creating new email and Discord accounts, use names closely resembling real names - something that does not look suspicious.

* Once a Discord account is created, join the Midjourney Discord [server](https://discord.com/invite/midjourney) and follow the [instructions](https://useapi.net/docs/start-here/setup-midjourney) to create your own server and invite the Midjourney bot. If you're planning to use this account, you can proceed with a Midjourney subscription. It's a good idea to create several Discord accounts with the Midjourney setup, as described above early on, this will *"age"* them and make them less suspicious later on when you need to subscribe to Midjourney.

* When paying for a Midjourney subscription use a virtual credit card number (provided by most major credit card companies) or services like [Privacy.com](https://privacy.com). Make sure to use a credit card name and address that resemble an actual address and name. Use a *different name and address* for every new Midjourney subscription. Midjourney has access to all payment details and will cross-check banned accounts' payment information to ban newly created accounts if a match is found.

* If your account gets banned, file a charge dispute with your credit card company. Since Midjourney cannot produce any evidence of you violating the ToS, the bank will fully refund your payment. Our customers have reported a 100% success rate of getting their money back, though it may take some time.

* When using the API, try to simulate real users. Avoid running generations 24/7 by establishing quiet hours (for example, you can use two or three accounts and rotate them every 12/8 hours). Midjourney seems to specifically target accounts with a large number of `--relax` usage, so try to limit those generations to a reasonable number (<300 generations/day). If you heavily rely on `--relax`, execute at least one fast generation for every NN relax generations. 
  
* Do not post public links to Discord/Midjourney CDN attachments, they contain your Discord account number and can be used to trace back to your account.

* Sharing cross-account `--p` codes is not safe. You risk all accounts using the same `--p` codes being banned by Midjourney.

* Do not run multiple requests with the same or similar prompts (e.g., "My test prompt 1", "My test prompt 2", and so on). Midjourney analyzes prompts and will force your Discord account token to expire when this kind of situation is detected. You will have to reset your Discord password manually before you can continue operating.

* Adjust [maxJobs](../docs/api-v2/post-account-midjourney) parameter to be one less than the maximum possible. For example, for the [Pro Plan](https://docs.midjourney.com/docs/plans) with a maximum of 12 concurrent jobs, set `maxJobs` to 11 or even 10.

* If you ever receive a [504](../docs/api-v2/post-jobs-imagine#responses) response code, it means your `maxJobs` is set to a value higher than your account plan supports. Adjust it accordingly.

* Finally, monitor for [596](../docs/api-v2/post-jobs-imagine#responses) response codes and ensure you check your API email. The API will proactively warn you if you have pending moderation messages or if Midjourney issues a CAPTCHA request.

### How to avoid Runway account suspension?

Using automation is against Runway's Terms of Service, so you need to plan accordingly and have backup account(s) ready.

* The best practice is to create several stand-by Runway accounts. These accounts should be used exclusively for API work and nothing else. We strongly recommend using a VPN to prevent your personal data/IP addresses from being leaked. You can use the [Opera](https://www.opera.com/download) browser with a built-in VPN or the [Brave](https://brave.com/download) browser with [Tor support](https://support.brave.com/hc/en-us/articles/360018121491-What-is-a-Private-Window-with-Tor-Connectivity).

* When creating accounts in bulk, make sure to restart Opera/Brave so that your IP is different every time. When creating new emails and Runway accounts, use names that closely resemble real names—something that does not look suspicious.

* Once a new Runway account is created, you will have a few free credits with which you can test the API. After testing, log out and leave the account alone until you are ready to activate the [Unlimited plan](https://runwayml.com/pricing) (the only subscription plan that makes sense to pay for).

* When paying for a Runway subscription, use a virtual credit card number (provided by most major credit card companies) or services like [Privacy.com](https://privacy.com). Make sure to use a credit card name and address that resemble an actual name and address. Use a *different name and address* for every new Runway subscription. Runway has access to all payment details and can cross-check banned accounts' payment information to ban newly created accounts if a match is found.

* If your account gets suspended, file a charge dispute with your credit card company. Since Runway cannot produce any evidence of you violating the ToS, the bank will fully refund your payment. Our customers have reported a 100% success rate of getting their money back, though it may take some time.

* When using the API, try to simulate real users. Avoid running generations 24/7 by establishing quiet hours (for example, you can use two or three accounts and rotate them every 12 to 8 hours). Avoid calling API endpoints too frequently, and consider using the `replyUrl` webhook to retrieve results, as this will ensure the least intrusive operation.

* Finally, monitor your API email—the one you used to subscribe to useapi.net services. The API will proactively warn you if your Runway account has any issues.

### Do you validate a user's text/image prompts to ensure they are passing AI services' safety requirements?

It is common practice for AI services to ban users for violating prompt guidelines (for example, see Midjourney PG13 [requirements](https://docs.midjourney.com/docs/community-guidelines)). Our API does not perform any prompt pre-validations, it will return a [422](../docs/api-v2/post-jobs-imagine#responses) status code if the job is moderated by Midjourney, and similar checks apply for the other AI APIs we offer.

Generally speaking, if you're planning to use the API for a public Telegram bot (which is one of the popular use cases) or in similar scenarios where you do not control the quality of the prompt, it might be a good idea to use a combination of a ban/stop word list along with [OpenAI ChatGPT](https://openai.com/api/pricing) or [Google Gemini](https://ai.google.dev/pricing) to check if the prompts meet safety requirements. [Gemini](https://ai.google.dev/pricing) offers a free tier with some RPM (requests per minute) limitations.

We also offer LLM models, specifically `MiniMax-Text-01`, a fast instructional multimodal model that is free to use and can validate both text and images for safety. Please see [POST minimax/llm](../docs/api-minimax-v1/post-minimax-llm).

### How is your experimental Runway API different from the official Runway API?

Official [Runway API](https://docs.dev.runwayml.com) currently only supports Gen-3 Alpha Turbo. The cost for Gen-3 Alpha Turbo 10-second generation is [$0.50](https://docs.dev.runwayml.com/usage/billing).

Our [experimental Runway API](https://useapi.net/docs/api-runwayml-v1) is a reverse-engineered version of [runwayml.com](https://runwayml.com). It fully supports **all** features of Gen-3 Alpha, Gen-3 Alpha Turbo, Act-One, Video to Video, Super-Slow Motion, Gen-2, the LipSync feature, and [more](https://useapi.net/docs/api-runwayml-v1). When used along with the Runway [Unlimited plan](https://runwayml.com/pricing), it allows you to run several hundred generations each day.

On average, you can expect the following numbers for Gen-3 Alpha Turbo 10-second generation:
- 1 generation is completed within 25 seconds
- 10 generations take about 4 minutes to complete
- 30 generations take about 12 minutes to complete
- 150 generations take about one hour to complete
    
If you generate 200+ videos, the official API will cost you $0.50 per generation, so 200 generations cost about $100. This means the $95 [Unlimited plan](https://runwayml.com/pricing), combined with our $15/month subscription, will pay for itself by the **first day**, most often within the first few hours.

We provide an API for all the features available at [runwayml.com](https://runwayml.com), including Gen-3 Alpha, Act-One, video-to-video (with extend and expand), Frames, and many more. The official Runway API only supports [Gen-3 Alpha Turbo](https://docs.dev.runwayml.com/).

### How is your experimental MiniMax API different from the official MiniMax API?

Official [MiniMax API](https://intl.minimaxi.com/document/video_generation) costs $0.43…$0.65 [link](https://www.minimaxi.com/en/price) per single 6-second-long generation.

Our [experimental MiniMax API](https://useapi.net/docs/api-minimax-v1) is a reverse-engineered version of the MiniMax/HailuoAI websites. It does not cost you anything to generate as many videos as you wish, thanks to a flat monthly [subscription](https://useapi.net/docs/subscription) fee. You can link as many [paid](https://hailuoai.video/subscribe) or free MiniMax/HailuoAI accounts to our API as you wish.

With [Unlimited](https://hailuoai.video/subscribe) Hailuo AI plan or [Standard](https://hailuoai.video/subscribe) plan for first day, you can expect the following numbers:
- 1 generation completed within 2 minutes
- 10 generations take about 20 minutes to complete
- 30 generations take about an hour to complete

If you generate 250+ videos, the official API will cost you $0.43 per generation, so 250 generations total about $107.50. This means the $95 [Unlimited](https://hailuoai.video/subscribe) plan, combined with our $15/month subscription, will pay for itself by the **first day**.

When using free [hailuoai.video](https://hailuoai.video) account, it costs one credit to generate a single image, and you can generate up to four images at once. With a daily free top-up of 100 credits, a free hailuoai.video account can generate 100 images per day – up to 3K images per month.

### Do you support [n8n](https://n8n.io) workflow automation?

Please consider the [n8n-nodes-useapi](https://github.com/lvalics/n8n-nodes-useapi) package by [lvalics](https://github.com/lvalics).

### How POST raw content to [runwayml/assets](https://useapi.net/docs/api-runwayml-v1/post-runwayml-assets) and [minimax/files](https://useapi.net/docs/api-minimax-v1/post-minimax-files) using Make.com and similar nocode tools?

We recommend using module called [0codekit](https://www.make.com/en/integrations/onesaas) to run JavaScript and return a result. 

<details markdown="block">

<summary><small>0codekit JavaScript example</small></summary>

```js
async function fetchFromURLandPOST(imageURL, name) {
  const apiToken = "<Your useapi.net API key>"; // https://useapi.net/docs/start-here/setup-useapi
  // Runway https://useapi.net/docs/api-runwayml-v1/post-runwayml-assets
  const apiUrl = `https://api.useapi.net/v1/runwayml/assets/?name=${name}`;
  // MiniMax https://useapi.net/docs/api-minimax-v1/post-minimax-files
  // const apiUrl = `https://api.useapi.net/v1/minimax/files/`;

  try {
    // Fetch the image from the URL
    const responseImage = await fetch(imageURL);

    if (!responseImage.ok) 
      throw new Error(`Failed to fetch ${imageURL}: ${responseImage.statusText}`);

    // Convert the response to a Blob
    const blob = await responseImage.blob();

    // Prepare headers for the POST request
    const headers = {
      "Authorization": `Bearer ${apiToken}`, 
      "Content-Type": blob.type,
    };

    // Make the POST request with the blob as the body
    const response = await fetch(apiUrl, {
      method: "POST",
      headers: headers,
      body: blob,
    });

    const result = await response.json();
    return { data: result };
  } catch (error) {
    return { error: error.message };
  }
}

// Calling the function
result = await fetchFromURLandPOST("https:\\website.com\image.jpeg", "my_image");
```

</details>