Undress API (1.2.2)

API for undressing images with different styles.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL https://deepstrip.com/
Languages
Servers
Mock server
https://deepstrip.redocly.app/_mock/openapi/
https://deepstrip.com/api/v1/

Create an undress job

Request

Bodyapplication/jsonrequired
source_imagestringrequired

Base64 encoded source image in jpeg format.

maskstring

Base64 encoded mask image in png format. Contains two colors: white for undressing regions, black for the rest.

automaskboolean

If set to true, mask will be automatically generated.

stylestringrequired

The style to apply for undressing.

Enum"standard""premium""premium_v2""nurse""bdsm""underwear_white""underwear_black""underwear_pink"
curl -i -X POST \
  https://deepstrip.redocly.app/_mock/openapi/undress \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "source_image": "string",
    "mask": "string",
    "automask": true,
    "style": "standard"
  }'

Responses

Job created successfully.

Bodyapplication/json
idstring

Identifier for the job.

Response
application/json
{
  "id": "string"
}

Analyze a video for face swap processing

Request

Bodyapplication/jsonrequired
video_urlstringrequired

HTTPS URL of the video to analyze.

previewboolean

Whether to create a preview (shorter) version.

versionstring

Version of the face swap model.

Enum"v1""v2"
curl -i -X POST \
  https://deepstrip.redocly.app/_mock/openapi/face_swap_videos/analyze \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "video_url": "string",
    "preview": true,
    "version": "v1"
  }'

Responses

Analysis completed successfully.

Bodyapplication/json
pricenumber

Calculated price for the face swap video.

versionstring

Version that will be used.

Enum"v1""v2"
previewboolean

Whether this is a preview version.

Response
application/json
{
  "price": 0,
  "version": "v1",
  "preview": true
}

Create a face swap video job

Request

Body
required
video_urlstring

HTTPS URL of the video to process.

face_urlstring

HTTPS URL of the face image.

previewboolean

Whether to create a preview version.

versionstring

Version of the face swap model.

Enum"v1""v2"
curl -i -X POST \
  https://deepstrip.redocly.app/_mock/openapi/face_swap_videos \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "video_url": "string",
    "face_url": "string",
    "preview": true,
    "version": "v1"
  }'

Responses

Job created successfully.

Bodyapplication/json
idstring

Identifier for the face swap video job.

statusstring

Initial status of the job.

messagestring

Additional information about the job.

Response
application/json
{
  "id": "string",
  "status": "string",
  "message": "string"
}

Get the status of a face swap video job

Request

Path
idstringrequired

Identifier of the face swap video job.

curl -i -X GET \
  'https://deepstrip.redocly.app/_mock/openapi/face_swap_videos/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Current status of the face swap video job.

Bodyapplication/json
idstring

Identifier for the face swap video job.

statusstring

Status of the face swap video job.

Enum"initial""sent""processing""completed""failed"
progressnumber

Progress percentage of the processing.

stepstring

Current processing step.

Enum"queued""downloading""fps""analysing""working""sound""reencoding_step_1""reencoding_step_2""postprocessing""uploading"
result_urlstring

URL of the processed video, if completed.

error_detailsobject

Error information if the job failed.

Response
application/json
{
  "id": "string",
  "status": "initial",
  "progress": 0,
  "step": "queued",
  "result_url": "string",
  "error_details": {}
}

Get the result of an undress job

Request

Path
idstringrequired

Identifier of the undress job.

curl -i -X GET \
  'https://deepstrip.redocly.app/_mock/openapi/undress/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Status or result of the undress job.

Bodyapplication/json
statusstring

Status of the undress job.

Enum"pending""completed""failed"
imagestring

URL of the generated image, if the job is completed.

Response
application/json
{
  "status": "pending",
  "image": "string"
}

Create a face swap job

Request

Bodyapplication/jsonrequired
imagestringrequired

Base64 encoded image.

facestringrequired

Base64 encoded face image.

versionstring

Version of the face swap model.

Enum"v1""v2"
curl -i -X POST \
  https://deepstrip.redocly.app/_mock/openapi/face_swaps \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "image": "string",
    "face": "string",
    "version": "v1"
  }'

Responses

Job created successfully.

Bodyapplication/json
idstring

Identifier for the job.

Response
application/json
{
  "id": "string"
}

Get the result of a face swap job

Request

Path
idstringrequired

Identifier of the face swap job.

curl -i -X GET \
  'https://deepstrip.redocly.app/_mock/openapi/face_swaps/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Status or result of the face swap job.

Bodyapplication/json
statusstring

Status of the face swap job.

Enum"pending""completed""failed"
imagestring

URL of the generated image, if the job is completed.

Response
application/json
{
  "status": "pending",
  "image": "string"
}