DeepFakesWeb API

Integrate deepfake technology directly into your applications with our powerful API

Overview

What you can do with the DeepFakesWeb API

The DeepFakesWeb API provides programmatic access to our powerful face-swapping technology, allowing you to:

Generate deepfake videos by swapping faces in videos
Track the status of processing jobs
Manage your account and credit balance
Access your transaction history

Our API is designed for developers who want to integrate deepfake technology into their applications, services, or workflows. With simple REST endpoints and straightforward authentication, you can get started quickly.

API Documentation

Complete guide to using the DeepFakesWeb API

Authentication

Include your API key in the X-API-Key header with all requests:

X-API-Key: your_api_key_here

You can obtain an API key from the API Keys page after signing up.

Base URL

https://api.deepfakesweb.com/v1/

API Endpoints

GET/credit-balance

Get your current credit balance

Response

{
    "data": {
        "credits": 93
    },
    "message": "Credit balance retrieved successfully"
}

GET/videos

List all your videos

Response

{
    "data": [
        {
            "id": 45,
            "user_id": 10,
            "input_image_url": "https://dfw-dev.s3.us-east-1.amazonaws.com/",
            "input_video_url": "https://dfw-dev.s3.us-east-1.amazonaws.com/",
            "multiple_faces": false,
            "mouth_mask": false,
            "status": "completed",
            "credits_used": 1,
            "created_at": "2025-03-30T02:05:42.702181Z",
            "updated_at": "2025-03-30T02:05:59.426529Z",
            "output_video_url": "https://dfw-dev.s3.us-east-1.amazonaws.com/",
            "ec2_instance_id": "i-0d492c565a1b551ca"
        },
        ...
    ]
}

GET/videos/{id}

Get details of a specific video by ID

Response

{
    "data": {
        "id": 46,
        "user_id": 10,
        "input_image_url": "https://dfw-dev.s3.us-east-1.amazonaws.com/",
        "input_video_url": "https://dfw-dev.s3.us-east-1.amazonaws.com/",
        "multiple_faces": false,
        "mouth_mask": false,
        "status": "processing",
        "credits_used": 1,
        "created_at": "2025-04-01T17:21:35.090458Z",
        "updated_at": "2025-04-01T17:21:51.736972Z",
        "ec2_instance_id": "i-056a2d96c9efd03d1"
    },
    "message": "Video retrieved successfully"
}

POST/videos

Create a new deepfake video

Request

Content-Type: multipart/form-data

Form Data:
image - File (The source face image)
video - File (The target video to apply the face to)
multiple_faces - Boolean (optional, default: false)
mouth_mask - Boolean (optional, default: false)

Response

{
    "data": {
        "id": 46,
        "user_id": 10,
        "input_image_url": "https://dfw-dev.s3.us-east-1.amazonaws.com/",
        "input_video_url": "https://dfw-dev.s3.us-east-1.amazonaws.com/",
        "multiple_faces": false,
        "mouth_mask": false,
        "status": "pending",
        "credits_used": 1,
        "created_at": "2025-04-01T17:21:35.090458Z",
        "updated_at": "2025-04-01T17:21:35.090458Z"
    },
    "message": "Video processing started"
}

DELETE/videos/{id}

Delete a specific video by ID

Response

{
    "data": null,
    "message": "Video deleted successfully"
}

GET/transactions

List your transaction history

Response

{
    "data": [
        {
            "id": 32,
            "user_id": 10,
            "amount": 700,
            "credits_purchased": 100,
            "payment_method": "stripe",
            "payment_status": "completed",
            "payment_id": {
                "String": "cs_test_a1dpEwTkU5E3iD4gqJJDY9ffaltM6ALmy9m9CVKSqvbaaWNXCO3tIngjys",
                "Valid": true
            },
            "billing_email": {
                "String": "",
                "Valid": false
            },
            "promotion_code": {
                "String": "",
                "Valid": false
            },
            "promotion_amount": 0,
            "ga_client_id": {
                "String": "",
                "Valid": false
            },
            "ga_session_id": {
                "String": "",
                "Valid": false
            },
            "created_at": "2025-03-28T03:40:54.00641Z",
            "updated_at": "2025-03-28T03:41:04.203093Z"
        },
        ...
    ]
}

Video Status Values

The status field in video responses can have the following values:

pendingThe video is waiting to be processed

processingThe video is currently being processed

completedProcessing has finished successfully

failedProcessing failed

Error Responses

All API errors return with appropriate HTTP status codes and a JSON response with an error message:

{
    "data": null,
    "message": "Error message describing what went wrong"
}

400Bad Request - Invalid parameters

401Unauthorized - Invalid API key

403Forbidden - Insufficient permissions

404Not Found - Resource not found

422Unprocessable Entity - Invalid request

500Server Error - Something went wrong

Rate Limits

The API is subject to rate limiting to ensure fair usage. Current limits are:

100 requests per minute per API key
10 concurrent video processing jobs per user

If you exceed these limits, you'll receive a 429 Too Many Requests response.

Ready to integrate deepfake technology into your application?

Get started with DeepFakesWeb API today and bring face-swapping capabilities to your users.