PixPerfectAI

Back to Dashboard

Quick Start Guide

Getting Started with PixPerfectAI API

Welcome to the PixPerfectAI API! This quick start guide will help you integrate our powerful image enhancement capabilities into your applications in just a few minutes.

Step 1: Sign up and get your API key

If you haven't already, create an account on our platform and subscribe to a plan that fits your needs. Once you've signed up, you can generate your API key from the API Keys section of your dashboard.

Step 2: Make your first API request

The basic endpoint for image enhancement is:

POST https://api.pixperfectai.com/v1/generate

Here's a simple example using fetch in JavaScript:

const apiKey = 'YOUR_API_KEY';
const imageFile = /* your image file */;
const prompt = 'Enhance this product image with professional lighting';

const formData = new FormData();
formData.append('prompt', prompt);
formData.append('image', imageFile);

fetch('https://api.pixperfectai.com/v1/generate', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`
  },
  body: formData
})
.then(response => response.json())
.then(data => {
  // data.imageUrl contains the URL to your enhanced image
  console.log(data.imageUrl);
})
.catch(error => console.error('Error:', error));

Step 3: Integrate with your application

You can integrate the API with various platforms:

  • E-commerce platforms: Automatically enhance product images on upload
  • Mobile apps: Provide image enhancement features to your users
  • Content management systems: Integrate with your CMS workflow
  • Batch processing: Enhance your entire product catalog

Step 4: Monitor your usage

You can monitor your API usage and remaining credits from your dashboard. If you need more credits, you can upgrade your plan or purchase additional credits.

Using the API with different programming languages

Need help?

If you need any assistance, check out our documentation or contact our support team at support@pixperfectai.com.