API Duckumentation

Getting started

To get started with the QR Code Generator API, you need to sign up for an API key. The API key will allow you to authenticate with our API and generate QR codes.

To sign up for an API key, please follow these steps:

1. Go to the sign up page here: Sign-up
2. Fill out the sign-up form with your name, email address, and a password.
3. Click on the "Sign Up" button to create your account.
4. Once you've signed up, you'll receive a confirmation email.
5. Click the link in the email to confirm your account.

That's it! With your API key in hand, you're now ready to start using the QR Code Generator API to generate QR codes. In the next section, we'll provide you with more information on how to use it to generate QR codes.

Endpoints

The following endpoint is available in the QR Code Generator API:

GET api/qr-code

This endpoint allows you to generate a QR code by passing in text or a URL. You can pass in the data as a query parameter, and the API will generate a QR code and return a PNG image file.

https://www.duckface.dev/api/qr-code?token=YOUR_API_KEY&type=text&textcontent=Hello%20world!

Input parameters

POST api/qr-code

This endpoint allows you to generate a QR code by sending a POST request with the data of the QR code in the request body. The API will generate a QR code and return a PNG image file.

Response

The API will respond with an image file of the QR code (PNG by default).

Example request

fetch('https://www.duckface.dev/api/qr-code', {
                  method: 'POST',
                  headers: {
                    'Content-Type': 'application/json',
                    'token': 'YOUR_API_KEY',
                  },
                  body: JSON.stringify({
                    type: 'text',
                    textcontent: 'https://www.example.com',
                  })
                })
                .then(response => response.json())
                .then(data => console.log(data))
                .catch(error => console.error(error));

Rate limits

To ensure fair usage of the QR code API, we have implemented rate limits on the number of requests that can be made within a certain period of time. The rate limits are as follows:

• Free Plan: 50 requests per month
• Paid Plan: 1500 requests per month

If you exceed the rate limit, the API will return a 429 Too Many Requests status code with a message indicating that you have exceeded the rate limit.

If you require a higher rate limit, please contact us Here to discuss custom plans and pricing.

Getting started

To get started with the Website Page Analysis API, all you need to do is sign up for an API key. The API key will allow you to authenticate with our API and access all of its features.

To sign up for an API key, please follow these steps:

1. Go to the sign up page here: Sign-up
2. Fill out the sign-up form with your name, email address, and a password.
3. Click on the "Sign Up" button to create your account.
4. Once you've signed up, you'll receive a confirmation email.
5. Click the link in the email to confirm your account.

That's it! With your API key in hand, you're now ready to start using the Website Page Analysis API to perform SEO checks on your webpages. In the next section, we'll provide you with more information on how to use it to perform SEO checks.

Endpoints

The following endpoints are available in the Website Page Analysis API:

GET api/page-analysis

This endpoint allows you to perform an Analysis on a webpage. You can pass in the URL of the webpage as a query parameter, and the API will perform a comprehensive SEO analysis of the page and return a JSON response with the results.

Input parameters

• token (required): Your unique API Key
• url (required): The URL of the webpage to check.

https://www.duckface.dev/api/page-analysis?token=YOUR_API_KEY&url=https://www.example.com

Output format

The API will return a JSON response with the following fields:

POST api/page-analysis

This endpoint allows you to perform an Analysis on a webpage by sending a POST request with the URL of the webpage in the request body. The API will perform a comprehensive SEO analysis of the page and return a JSON response with the results.

Input parameters

The URL of the webpage should be included in the request body as a JSON object with the following fields:

• token (required): Your unique API Key
• url (required): The URL of the webpage to check.

fetch('https://www.duckface.dev/api/page-analysis', {
                        method: 'POST',
                        headers: {
                          'Content-Type': 'application/json',
                          'token': 'YOUR_API_KEY',
                        },
                        body: JSON.stringify({
                          url: 'https://www.example.com',
                        })
                      })
                      .then(response => response.json())
                      .then(data => console.log(data))
                      .catch(error => console.error(error));
                    

Output format

The API will return a JSON response with the same fields as the GET api/page-analysis endpoint.

That's it! These are the two endpoints available in your Website Page Analysis API. You can use these endpoints to perform comprehensive SEO checks on any webpage and get detailed information on how to optimize your content for better search engine rankings.

Rate limits

To ensure fair usage of the Website Page Analysis, we have implemented rate limits on the number of requests that can be made within a certain period of time. The rate limits are as follows:

• Free Plan: 5 requests per month
• Paid Plan: 150 requests per month

If you exceed the rate limit, the API will return a 429 Too Many Requests status code with a message indicating that you have exceeded the rate limit.

If you require a higher rate limit, please contact us Here to discuss custom plans and pricing.

Getting started

To get started with the GA4 Prompt Analysis API, you need to sign up for an API key. The API key will allow you to authenticate with our API and generate Request Bodies.

To sign up for an API key, please follow these steps:

1. Go to the sign up page here: Sign-up
2. Fill out the sign-up form with your name, email address, and a password.
3. Click on the "Sign Up" button to create your account.
4. Once you've signed up, you'll receive a confirmation email.
5. Click the link in the email to confirm your account.

That's it! With your API key in hand, you're now ready to start using the GA4 Prompt Analysis API. In the next section, we'll provide you with more information on how to use it to generate request bodies.

Endpoints

The following endpoint is available in the GA4 Prompt Analysis API:

GET api/ga4

This endpoint allows you to generate a GA4 request body by passing in a text prompt. You can pass in the data as a query parameter, and the API will return a json formatted request body ready to send to the GA4 API

https://www.duckface.dev/api/ga4?token=YOUR_API_KEY&prompt=mtd%20transactions

Input parameters

POST api/ga4

This endpoint allows you to generate a GA4 request body by sending a POST request with the prompt in the request body. The API will return a json formatted request body ready to send to the GA4 API

Response

The API will return a json formatted request body.

                        {
                          "dateRanges": [
                            {
                              "endDate": "YYYY-MM-DD", 
                              "startDate": "YYYY-MM-DD"
                            }
                          ], 
                          "dimensions": [
                            {
                              "name": "dimension_1"
                            }, 
                            {
                              "name": "dimension_2"
                            }
                          ], 
                          "metrics": [
                            {
                              "name": "metric_1"
                            }, 
                            {
                              "name": "metric_2"
                            }
                          ]
                        }
                      
                  

Example request

fetch('https://www.duckface.dev/api/ga4', {
                  method: 'POST',
                  headers: {
                    'Content-Type': 'application/json',
                    'token': 'YOUR_API_KEY',
                  },
                  body: JSON.stringify({
                    prompt: 'How many conversions did we make last week?',
                  })
                })
                .then(response => response.json())
                .then(data => console.log(data))
                .catch(error => console.error(error));
              

Supported GA4 API Metrics

Supported GA4 API Dimensions

Rate limits

To ensure fair usage of the GA4 Prompt Analysis API, we have implemented rate limits on the number of requests that can be made within a certain period of time. The rate limits are as follows:

• Free Plan: 50 requests per month
• Paid Plan: 1500 requests per month

If you exceed the rate limit, the API will return a 429 Too Many Requests status code with a message indicating that you have exceeded the rate limit.

If you require a higher rate limit, please contact us Here to discuss custom plans and pricing.

Getting Started

To start using the PDF to WORD Conversion API, you'll need to obtain an API key for authentication. Follow these steps to get your API key:

1. Go to the sign-up page here: Sign-up
2. Fill out the sign-up form with your name, email address, and a password.
3. Click on the "Sign Up" button to create your account.
4. Upon signing up, you'll receive a confirmation email.
5. Click the link in the email to confirm your account.

Once you have your API key, you're ready to start using the PDF to WORD Conversion API to convert your documents. In the next section, we'll provide more information on how to use the API for document conversion.

Endpoints

The PDF to WORD Conversion API provides the following endpoints:

GET /api/pdf-word

This endpoint allows you to convert a PDF document by providing either a URL or base64 data as query parameters. The API will convert the document and return it in DOCX format. Here's an example:

https://www.duckface.dev/api/pdf-word?token=YOUR_API_KEY&file_url=https://www.example.com/document.pdf

POST /api/pdf-word

This endpoint allows you to convert a PDF document by sending a POST request with the document data in the request body. The API will convert the document and return it in DOCX format. Here's how to use it:

Request with PDF URL

If you want to convert a document hosted at a URL:

fetch('https://www.duckface.dev/api/pdf-word', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        'token': 'YOUR_API_KEY',
      },
      body: JSON.stringify({
        file_url: 'https://www.example.com/document.pdf',
      })
    })
    .then(response => response.blob())
    .then(data => {
      // Handle the converted document data
    })
    .catch(error => {
      console.error(error);
    });

Request with File Upload

If you prefer to upload a file directly to the API:

const formData = new FormData();
formData.append('file', yourFile); // Replace 'yourFile' with the actual file object

fetch('https://www.duckface.dev/api/pdf-word', {
  method: 'POST',
  headers: {
    'token': 'YOUR_API_KEY',
  },
  body: formData,
})
.then(response => response.blob())
.then(data => {
  // Handle the converted document data
})
.catch(error => {
  console.error(error);
});

Input Parameters

The PDF to WORD Conversion API accepts the following input parameters:

Rate limits

To ensure fair usage of the PDF to WORD Conversion API, we have implemented rate limits on the number of requests that can be made within a certain period of time. The rate limits are as follows:

• Free Plan: 5 requests per month
• Paid Plan: 150 requests per month

If you exceed the rate limit, the API will return a 429 Too Many Requests status code with a message indicating that you have exceeded the rate limit.

If you require a higher rate limit, please contact us Here to discuss custom plans and pricing.

Getting Started

To start using the PDF to EXCEL Conversion API, you'll need to obtain an API key for authentication. Follow these steps to get your API key:

1. Go to the sign-up page here: Sign-up
2. Fill out the sign-up form with your name, email address, and a password.
3. Click on the "Sign Up" button to create your account.
4. Upon signing up, you'll receive a confirmation email.
5. Click the link in the email to confirm your account.

Once you have your API key, you're ready to start using the PDF to EXCEL Conversion API to convert your documents. In the next section, we'll provide more information on how to use the API for document conversion.

Endpoints

The PDF to EXCEL Conversion API provides the following endpoints:

GET /api/pdf-excel

This endpoint allows you to convert a PDF document by providing either a URL or base64 data as query parameters. The API will convert the document and return it in XLSX format. Here's an example:

https://www.duckface.dev/api/pdf-excel?token=YOUR_API_KEY&file_url=https://www.example.com/document.pdf

POST /api/pdf-excel

This endpoint allows you to convert a PDF document by sending a POST request with the document data in the request body. The API will convert the document and return it in XLSX format. Here's how to use it:

Request with PDF URL

If you want to convert a document hosted at a URL:

fetch('https://www.duckface.dev/api/pdf-excel', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        'token': 'YOUR_API_KEY',
      },
      body: JSON.stringify({
        file_url: 'https://www.example.com/document.pdf',
      })
    })
    .then(response => response.blob())
    .then(data => {
      // Handle the converted document data
    })
    .catch(error => {
      console.error(error);
    });

Request with File Upload

If you prefer to upload a file directly to the API:

const formData = new FormData();
formData.append('file', yourFile); // Replace 'yourFile' with the actual file object

fetch('https://www.duckface.dev/api/pdf-excel', {
  method: 'POST',
  headers: {
    'token': 'YOUR_API_KEY',
  },
  body: formData,
})
.then(response => response.blob())
.then(data => {
  // Handle the converted document data
})
.catch(error => {
  console.error(error);
});

Input Parameters

The PDF to EXCEL Conversion API accepts the following input parameters:

Rate limits

To ensure fair usage of the PDF to EXCEL Conversion API, we have implemented rate limits on the number of requests that can be made within a certain period of time. The rate limits are as follows:

• Free Plan: 5 requests per month
• Paid Plan: 150 requests per month

If you exceed the rate limit, the API will return a 429 Too Many Requests status code with a message indicating that you have exceeded the rate limit.

If you require a higher rate limit, please contact us Here to discuss custom plans and pricing.

Getting Started

To start using the PDF Compressor API, you'll need to obtain an API key for authentication. Follow these steps to get your API key:

1. Go to the sign-up page here: Sign-up
2. Fill out the sign-up form with your name, email address, and a password.
3. Click on the "Sign Up" button to create your account.
4. Upon signing up, you'll receive a confirmation email.
5. Click the link in the email to confirm your account.

Once you have your API key, you're ready to start using the PDF Compressor API to convert your documents. In the next section, we'll provide more information on how to use the API for document conversion.

Endpoints

The PDF Compressor API provides the following endpoints:

GET /api/pdf-compress

This endpoint allows you to convert a PDF document by providing either a URL or base64 data as query parameters. The API will compress the document and return it in PDF format. Here's an example:

https://www.duckface.dev/api/pdf-compress?token=YOUR_API_KEY&file_url=https://www.example.com/document.pdf

POST /api/pdf-compress

This endpoint allows you to convert a PDF document by sending a POST request with the document data in the request body. The API will compress the document and return it in PDF format. Here's how to use it:

Request with PDF URL

If you want to convert a document hosted at a URL:

fetch('https://www.duckface.dev/api/pdf-compress', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        'token': 'YOUR_API_KEY',
      },
      body: JSON.stringify({
        file_url: 'https://www.example.com/document.pdf',
      })
    })
    .then(response => response.blob())
    .then(data => {
      // Handle the compressed document data
    })
    .catch(error => {
      console.error(error);
    });

Request with File Upload

If you prefer to upload a file directly to the API:

const formData = new FormData();
formData.append('file', yourFile); // Replace 'yourFile' with the actual file object

fetch('https://www.duckface.dev/api/pdf-compress', {
  method: 'POST',
  headers: {
    'token': 'YOUR_API_KEY',
  },
  body: formData,
})
.then(response => response.blob())
.then(data => {
  // Handle the converted document data
})
.catch(error => {
  console.error(error);
});

Input Parameters

The PDF to WORD Conversion API accepts the following input parameters:

Rate limits

To ensure fair usage of the PDF Compressor API, we have implemented rate limits on the number of requests that can be made within a certain period of time. The rate limits are as follows:

• Free Plan: 5 requests per month
• Paid Plan: 150 requests per month

If you exceed the rate limit, the API will return a 429 Too Many Requests status code with a message indicating that you have exceeded the rate limit.

If you require a higher rate limit, please contact us Here to discuss custom plans and pricing.

Getting Started

To start using the PDF Merger API, you'll need to obtain an API key for authentication. Follow these steps to get your API key:

1. Go to the sign-up page here: Sign-up
2. Fill out the sign-up form with your name, email address, and a password.
3. Click on the "Sign Up" button to create your account.
4. Upon signing up, you'll receive a confirmation email.
5. Click the link in the email to confirm your account.

Once you have your API key, you're ready to start using the PDF Merger API to merge your documents. In the next section, we'll provide more information on how to use the API for document merging.

Endpoints

The PDF Merger API provides the following endpoints:

GET /api/pdf-merge

This endpoint allows you to merge PDF documents by providing either URLs or base64 data as query parameters. The API will merge the documents and return a single PDF file. Here's an example:

https://www.duckface.dev/api/pdf-merger?token=YOUR_API_KEY&file_urls=https://www.example.com/document1.pdf,https://www.example.com/document2.pdf

POST /api/pdf-merger

This endpoint allows you to merge PDF documents by sending a POST request with the document data in the request body. The API will merge the documents and return a single PDF file. Here's how to use it:

Request with PDF URLs

If you want to merge documents hosted at URLs:

fetch('https://www.duckface.dev/api/pdf-merger', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'token': 'YOUR_API_KEY',
    },
    body: JSON.stringify({
      file_urls: ['https://www.example.com/document1.pdf', 'https://www.example.com/document2.pdf'],
    })
  })
  .then(response => response.blob())
  .then(data => {
    // Handle the merged document data
  })
  .catch(error => {
    console.error(error);
  });

Request with File Uploads

If you prefer to upload files directly to the API:

const formData = new FormData();
  formData.append('files', file1); // Replace 'file1' with the actual file object
  formData.append('files', file2); // Replace 'file2' with the actual file object
  
  fetch('https://www.duckface.dev/api/pdf-merger', {
    method: 'POST',
    headers: {
      'token': 'YOUR_API_KEY',
    },
    body: formData,
  })
  .then(response => response.blob())
  .then(data => {
    // Handle the merged document data
  })
  .catch(error => {
    console.error(error);
  });

Input Parameters

The PDF Merger API accepts the following input parameters:

Rate limits

To ensure fair usage of the PDF Merger API, we have implemented rate limits on the number of requests that can be made within a certain period of time. The rate limits are as follows:

• Free Plan: 5 requests per month
• Paid Plan: 150 requests per month

If you exceed the rate limit, the API will return a 429 Too Many Requests status code with a message indicating that you have exceeded the rate limit.

If you require a higher rate limit, please contact us Here to discuss custom plans and pricing.

Getting Started

To start using the Image to Text Extraction API, you'll need to obtain an API key for authentication. Follow these steps to get your API key:

1. Go to the sign-up page here: Sign-up
2. Fill out the sign-up form with your name, email address, and a password.
3. Click on the "Sign Up" button to create your account.
4. Upon signing up, you'll receive a confirmation email.
5. Click the link in the email to confirm your account.

Once you have your API key, you're ready to start using the Image to Text Extraction API to extract text from your images. In the next section, we'll provide more information on how to use the API for text extraction.

Endpoints

The Image to Text Extraction API provides the following endpoints:

GET /api/extract

This endpoint allows you to extract text from an image by providing either a URL or base64 data as query parameters. The API will process the image and return the extracted text. Here's an example:

https://www.duckface.dev/api/image-text?token=YOUR_API_KEY&image_url=https://www.example.com/image.jpg

POST /api/image-text

This endpoint allows you to extract text from an image by sending a POST request with the image data in the request body. The API will process the image and return the extracted text. Here's how to use it:

Request with Image URL

If you want to extract text from an image hosted at a URL:

fetch('https://www.duckface.dev/api/image-text', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        'token': 'YOUR_API_KEY',
      },
      body: JSON.stringify({
        image_url: 'https://www.example.com/image.jpg',
      })
    })
    .then(response => response.json())
    .then(data => {
      // Handle the extracted text data
    })
    .catch(error => {
      console.error(error);
    });

Request with File Upload

If you prefer to upload an image file directly to the API:

const formData = new FormData();
formData.append('file', yourImage); // Replace 'yourImage' with the actual image file

fetch('https://www.duckface.dev/api/image-text', {
  method: 'POST',
  headers: {
    'token': 'YOUR_API_KEY',
  },
  body: formData,
})
.then(response => response.json())
.then(data => {
  // Handle the extracted text data
})
.catch(error => {
  console.error(error);
});

Input Parameters

The Image to Text Extraction API accepts the following input parameters:

Rate limits

To ensure fair usage of the Image to Text Extraction API, we have implemented rate limits on the number of requests that can be made within a certain period of time. The rate limits are as follows:

• Free Plan: 5 requests per month
• Paid Plan: 150 requests per month

If you exceed the rate limit, the API will return a 429 Too Many Requests status code with a message indicating that you have exceeded the rate limit.

If you require a higher rate limit, please contact us Here to discuss custom plans and pricing.

Getting Started

To begin using the Image Resizer API, you'll need an API key for authentication. Follow these steps to obtain your API key:

1. Go to the sign-up page here: Sign-up
2. Complete the sign-up form with your name, email address, and password.
3. Click on the "Sign Up" button to create your account.
4. Upon signing up, you'll receive a confirmation email.
5. Click the link in the email to confirm your account.

With your API key, you're ready to start using the Image Resizer API. In the next section, you'll find more information on how to use the API for image resizing.

Endpoints

The Image Resizer API provides the following endpoints:

GET /api/resize

This endpoint allows you to resize an image by providing either a URL or base64 data, along with the required parameters 'width' and 'height'. The API will resize the image and return it. Here's an example:

https://www.example.com/api/resize?token=YOUR_API_KEY&image_url=https://www.example.com/image.png&width=300&height=200

POST /api/resize

This endpoint enables you to resize an image by sending a POST request with the image data in the request body, along with the required parameters 'width' and 'height'. Here's how to use it:

Request with Image URL

If you want to resize an image hosted at a URL:

fetch('https://www.example.com/api/resize', {
        method: 'POST',
        headers: {
            'Content-Type': 'application/json',
            'token': 'YOUR_API_KEY',
        },
        body: JSON.stringify({
            image_url: 'https://www.example.com/image.png',
            width: 300,
            height: 200
        })
    })
    .then(response => response.blob())
    .then(data => {
        // Handle the resized image data
    })
    .catch(error => {
        console.error(error);
    });

Request with File Upload

If you prefer to upload a file directly to the API:

const formData = new FormData();
    formData.append('file', yourFile); // Replace 'yourFile' with the actual file object
    formData.append('width', 300); // Replace '300' with the desired width
    formData.append('height', 200); // Replace '200' with the desired height
    
    fetch('https://www.example.com/api/resize', {
            method: 'POST',
            headers: {
                'token': 'YOUR_API_KEY',
            },
            body: formData,
        })
        .then(response => response.blob())
        .then(data => {
            // Handle the resized image data
        })
        .catch(error => {
            console.error(error);
        });

Input Parameters

The Image Resizer API accepts the following input parameters:

File Size Limit

The maximum file size limit for image conversion is set at 15 MB. Ensure that the image you provide for conversion does not exceed this limit. If the file size exceeds the limit, the API will return an error.

Rate Limits

To ensure fair usage of the Image Resizer API, rate limits have been implemented based on your subscription plan:

• Free Plan: 20 requests per month
• Premium Plan: 1500 requests per month

If you exceed the rate limit, the API will return a 429 Too Many Requests status code with a message indicating that you've reached the limit.

If you require a higher rate limit, please contact us here to discuss custom plans and pricing.

Getting Started

To start using the Background Remover API, you'll need to obtain an API key for authentication. Follow these steps to get your API key:

1. Go to the sign-up page here: Sign-up
2. Fill out the sign-up form with your name, email address, and a password.
3. Click on the "Sign Up" button to create your account.
4. Upon signing up, you'll receive a confirmation email.
5. Click the link in the email to confirm your account.

With your API key in hand, you're ready to start using the Background Remover API to remove the background from your images. In the next section, we'll provide you with more information on how to use the API for background removal.

Endpoints

The Background Remover API provides the following endpoints:

GET /api/background-remover

This endpoint enables you to effortlessly remove the background from an image by submitting either a URL or base64 data as query parameters. The API will process the image, effectively removing the background, and return the result without a background in a PNG image format. Here's an example:

https://www.duckface.dev/api/background-remover?token=YOUR_API_KEY&image_url=https://www.example.com/image.png

POST /api/background-remover

This endpoint allows you to remove the background of an image by sending a POST request with the image data in the request body. The API will process the image and return it with the background removed. Here's how to use it:

Request with Image URL

If you want to remove the background of an image hosted at a URL:

fetch('https://www.duckface.dev/api/background-remover', {
      method: 'POST',
      headers: {
          'Content-Type': 'application/json',
          'token': 'YOUR_API_KEY',
      },
      body: JSON.stringify({
        image_url: 'https://www.example.com/image.png',
      })
  })
  .then(response => response.blob())
  .then(data => {
      // Handle the image with the background removed
  })
  .catch(error => {
      console.error(error);
  });

Request with File Upload

If you prefer to upload a file directly to the API:

const formData = new FormData();
formData.append('file', yourFile); // Replace 'yourFile' with the actual file object

fetch('https://www.duckface.dev/api/background-remover', {
  method: 'POST',
  headers: {
    'token': 'YOUR_API_KEY',
  },
  body: formData,
})
.then(response => response.blob())
.then(data => {
  // Handle the image with the background removed
})
.catch(error => {
  console.error(error);
});

Input Parameters

The Background Remover API accepts the following input parameters:

Rate limits

To ensure fair usage of the Background Remover API, we have implemented rate limits on the number of requests that can be made within a certain period of time. The rate limits are as follows:

• Free Plan: 20 requests per month
• Paid Plan: 1500 requests per month

If you exceed the rate limit, the API will return a 429 Too Many Requests status code with a message indicating that you have exceeded the rate limit.

If you require a higher rate limit, please contact us Here to discuss custom plans and pricing.

Getting Started

To start using the Image Compression API, you'll need to obtain an API key for authentication. Follow these steps to get your API key:

1. Go to the sign-up page here: Sign-up
2. Fill out the sign-up form with your name, email address, and a password.
3. Click on the "Sign Up" button to create your account.
4. Upon signing up, you'll receive a confirmation email.
5. Click the link in the email to confirm your account.

With your API key in hand, you're ready to start using the Image Compression API to optimize your images. In the next section, we'll provide you with more information on how to use the API for image compression.

Endpoints

The Image Compression API provides the following endpoints:

GET /api/compress

This endpoint allows you to convert an image by providing either a URL or base64 data as query parameters. The API will convert the image and return it in WEBP format. Here's an example:

https://www.duckface.dev/api/compress?token=YOUR_API_KEY&format=png&image_url=https://www.example.com/image.png

POST /api/compress

This endpoint allows you to compress an image by sending a POST request with the image data in the request body. The API will compress the image and return it in PNG or JPG format, depending on the original format. Here's how to use it:

Request with Image URL

If you want to compress an image hosted at a URL:

fetch('https://www.duckface.dev/api/compress', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'token': 'YOUR_API_KEY',
    },
    body: JSON.stringify({
      image_url: 'https://www.example.com/image.png',
      format: 'png',
    })
  })
  .then(response => response.blob())
  .then(data => {
    // Handle the compressed image data
  })
  .catch(error => {
    console.error(error);
  });

Request with File Upload

If you prefer to upload a file directly to the API:

const formData = new FormData();
  formData.append('file', yourFile); // Replace 'yourFile' with the actual file object
  formData.append('format', png / jpg); // Replace 'format' with the actual file format

fetch('https://www.duckface.dev/api/compress', {
        method: 'POST',
        headers: {
            'token': 'YOUR_API_KEY',
        },
        body: formData,
    })
    .then(response => response.blob())
    .then(data => {
        // Handle the compressed image data
    })
    .catch(error => {
        console.error(error);
    });

Input Parameters

The Image Compression API accepts the following input parameters:

Rate limits

To ensure fair usage of the Image Compression API, we have implemented rate limits on the number of requests that can be made within a certain period of time. The rate limits are as follows:

• Free Plan: 20 requests per month
• Paid Plan: 1500 requests per month

If you exceed the rate limit, the API will return a 429 Too Many Requests status code with a message indicating that you have exceeded the rate limit.

If you require a higher rate limit, please contact us Here to discuss custom plans and pricing.

Getting Started

To start using the Image to WEBP Converter API, you'll need to obtain an API key for authentication. Follow these steps to get your API key:

1. Go to the sign-up page here: Sign-up
2. Fill out the sign-up form with your name, email address, and a password.
3. Click on the "Sign Up" button to create your account.
4. Upon signing up, you'll receive a confirmation email.
5. Click the link in the email to confirm your account.

With your API key in hand, you're ready to start using the WEBP API to convert your images. In the next section, we'll provide you with more information on how to use the API for image conversion.

Endpoints

The Image to WEBP Converter API provides the following endpoints:

GET /api/webp

This endpoint allows you to convert an image by providing either a URL or base64 data as query parameters. The API will convert the image and return it in WEBP format. Here's an example:

https://www.duckface.dev/api/webp?token=YOUR_API_KEY&image_url=https://www.example.com/image.png

POST /api/webp

This endpoint enables you to convert an image by sending a POST request with the image data in the request body. The API will convert the image and return it in WEBP format. You can either provide the image as a URL or as a file upload. Here's how to use it:

Request with Image URL

If you want to convert an image hosted at a URL:

fetch('https://www.duckface.dev/api/webp', {
        method: 'POST',
        headers: {
            'Content-Type': 'application/json',
            'token': 'YOUR_API_KEY',
        },
        body: JSON.stringify({
            image_url: 'https://www.example.com/image.png',
            quality: '80',
        })
    })
    .then(response => response.blob())
    .then(data => {
        // Handle the converted WEBP image data
    })
    .catch(error => {
        console.error(error);
    });

Request with File Upload

If you prefer to upload a file directly to the API:

const formData = new FormData();
formData.append('file', yourFile); // Replace 'yourFile' with the actual file object

fetch('https://www.duckface.dev/api/webp', {
        method: 'POST',
        headers: {
            'token': 'YOUR_API_KEY',
        },
        body: formData,
    })
    .then(response => response.blob())
    .then(data => {
        // Handle the converted WEBP image data
    })
    .catch(error => {
        console.error(error);
    });

Input Parameters

The Image to WEBP Converter API accepts the following input parameters:

File Size Limit

The maximum file size limit for image conversion is set at 15 MB. Ensure that the image you provide for conversion does not exceed this limit. If the file size exceeds the limit, the API will return an error.

Benefits of Using WEBP Images

WEBP images offer several advantages over traditional formats like JPEG and PNG:

• Smaller File Sizes: WEBP images are typically smaller, leading to faster page load times and reduced bandwidth usage.
• Better Compression: Advanced compression algorithms in WEBP often result in smaller file sizes than JPEG and PNG.
• Improved Image Quality: Despite smaller file sizes, WEBP images can maintain excellent quality, especially for detailed images.
• Transparency Support: Like PNG, WEBP supports transparency for images with transparent backgrounds.

Overall, WEBP offers several advantages, making it a suitable choice for web and mobile applications where fast loading times and efficient image delivery are critical.

Rate Limits

To ensure fair usage of the Image to WEBP Converter API, rate limits have been implemented based on your subscription plan:

• Free Plan: 20 requests per month
• Premium Plan: 1500 requests per month

If you exceed the rate limit, the API will return a 429 Too Many Requests status code with a message indicating that you've reached the limit.

If you require a higher rate limit, please contact us here to discuss custom plans and pricing.

Getting Started

To start using the Image to PNG Converter API, you'll need to obtain an API key for authentication. Follow these steps to get your API key:

1. Go to the sign-up page here: Sign-up
2. Fill out the sign-up form with your name, email address, and a password.
3. Click on the "Sign Up" button to create your account.
4. Upon signing up, you'll receive a confirmation email.
5. Click the link in the email to confirm your account.

With your API key in hand, you're ready to start using the PNG API to convert your images. In the next section, we'll provide you with more information on how to use the API for image conversion.

Endpoints

The Image to PNG Converter API provides the following endpoints:

GET /api/png

This endpoint allows you to convert an image by providing either a URL or base64 data as query parameters. The API will convert the image and return it in PNG format. Here's an example:

https://www.duckface.dev/api/png?token=YOUR_API_KEY&image_url=https://www.example.com/image.jpg

POST /api/png

This endpoint enables you to convert an image by sending a POST request with the image data in the request body. The API will convert the image and return it in PNG format. You can either provide the image as a URL or as a file upload. Here's how to use it:

Request with Image URL

If you want to convert an image hosted at a URL:

fetch('https://www.duckface.dev/api/png', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'token': 'YOUR_API_KEY',
    },
    body: JSON.stringify({
        image_url: 'https://www.example.com/image.jpg',
    })
})
.then(response => response.blob())
.then(data => {
    // Handle the converted PNG image data
})
.catch(error => {
    console.error(error);
});

Request with File Upload

If you prefer to upload a file directly to the API:

const formData = new FormData();
formData.append('file', yourFile); // Replace 'yourFile' with the actual file object

fetch('https://www.duckface.dev/api/png', {
        method: 'POST',
        headers: {
            'token': 'YOUR_API_KEY',
        },
        body: formData,
    })
    .then(response => response.blob())
    .then(data => {
        // Handle the converted PNG image data
    })
    .catch(error => {
        console.error(error);
    });

Input Parameters

The Image to PNG Converter API accepts the following input parameters:

File Size Limit

The maximum file size limit for image conversion is set at 15 MB. Ensure that the image you provide for conversion does not exceed this limit. If the file size exceeds the limit, the API will return an error.

Benefits of Using PNG Images

PNG images offer several advantages:

• Lossless Compression: PNG images retain their quality and support transparency, making them ideal for graphics and images with sharp edges.
• Transparency Support: PNG images support alpha channels for precise transparency control.

Overall, PNG is a suitable choice for images where maintaining quality and transparency is crucial.

Rate Limits

To ensure fair usage of the Image to PNG Converter API, rate limits have been implemented based on your subscription plan:

• Free Plan: 20 requests per month
• Premium Plan: 1500 requests per month

If you exceed the rate limit, the API will return a 429 Too Many Requests status code with a message indicating that you've reached the limit.

If you require a higher rate limit, please contact us here to discuss custom plans and pricing.

Getting Started

To start using the Image to JPG Converter API, you'll need to obtain an API key for authentication. Follow these steps to get your API key:

1. Go to the sign-up page here: Sign-up
2. Fill out the sign-up form with your name, email address, and a password.
3. Click on the "Sign Up" button to create your account.
4. Upon signing up, you'll receive a confirmation email.
5. Click the link in the email to confirm your account.

With your API key in hand, you're ready to start using the JPG API to convert your images. In the next section, we'll provide you with more information on how to use the API for image conversion.

Endpoints

The Image to JPG Converter API provides the following endpoints:

GET /api/jpg

This endpoint allows you to convert an image by providing either a URL or base64 data as query parameters. The API will convert the image and return it in JPG format. Here's an example:

https://www.duckface.dev/api/jpg?token=YOUR_API_KEY&image_url=https://www.example.com/image.png

POST /api/jpg

This endpoint enables you to convert an image by sending a POST request with the image data in the request body. The API will convert the image and return it in JPG format. You can either provide the image as a URL or as a file upload. Here's how to use it:

Request with Image URL

If you want to convert an image hosted at a URL:

fetch('https://www.duckface.dev/api/jpg', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'token': 'YOUR_API_KEY',
    },
    body: JSON.stringify({
        image: 'https://www.example.com/image.png',
    })
})
.then(response => response.blob())
.then(data => {
    // Handle the converted JPG image data
})
.catch(error => {
    console.error(error);
});

Request with File Upload

If you prefer to upload a file directly to the API:

const formData = new FormData();
formData.append('file', yourFile); // Replace 'yourFile' with the actual file object

fetch('https://www.duckface.dev/api/jpg', {
        method: 'POST',
        headers: {
            'token': 'YOUR_API_KEY',
        },
        body: formData,
    })
    .then(response => response.blob())
    .then(data => {
        // Handle the converted JPG image data
    })
    .catch(error => {
        console.error(error);
    });

Input Parameters

The Image to JPG Converter API accepts the following input parameters:

File Size Limit

The maximum file size limit for image conversion is set at 15 MB. Ensure that the image you provide for conversion does not exceed this limit. If the file size exceeds the limit, the API will return an error.

Benefits of Using JPG Images

JPG images offer widespread compatibility and reasonable compression:

• Compatibility: JPG images are widely supported across various devices and platforms.
• Compression: JPG images provide a good balance between image quality and file size, making them suitable for web and print applications.

Overall, JPG is a versatile format for images used in various contexts.

Rate Limits

To ensure fair usage of the Image to JPG Converter API, rate limits have been implemented based on your subscription plan:

• Free Plan: 20 requests per month
• Premium Plan: 1500 requests per month

If you exceed the rate limit, the API will return a 429 Too Many Requests status code with a message indicating that you've reached the limit.

If you require a higher rate limit, please contact us here to discuss custom plans and pricing.