This API reference is your key to a comprehensive understanding of the Propershot AI API.

The Propershot API allows developers and businesses to integrate advanced AI-powered image enhancement and editing capabilities directly into their workflows. Built upon the cutting-edge algorithms that power Propershot’s main tool, this API offers seamless solutions for image enhancement, sky replacement, wall painting, and more. By providing automated adjustments and creative enhancements to photos, Propershot API helps users achieve professional-quality images with minimal effort.


Conventions

The base URL to send all API requests is https://ai.propershot.com/v1 HTTPS is required for all API requests .

We follow standard REST conventions, with most operations performed via GET and POST requests.

Request and response bodies are encoded as JSON.


Obtain Your API Key to start using our API

To start, you must obtain your API key from Propershot. This key is generated on demand. The API key is a unique identifier that allows the server to verify your identity. Contact us

You can get more information regarding the authentication Here


⚠️ Important Usage Guidelines

Every enhancement request submitted to the system is processed and considered billable. This means sending the same image multiple times will result in multiple billable enhancement requests. For example, sending an image three times for enhancement will count as three separate requests, each billed individually.

Best Practices:

  • Check for Duplicate Requests: Before submitting an image for enhancement, ensure that the image hasn't already been processed. This will help you avoid unnecessary duplicate requests, which will be billed multiple times.

  • Implement Retry Logic:

    • Use retry mechanisms that follow HTTP error code handling best practices. For example, if you receive a 500 Internal Server Error, consider implementing exponential backoff in your retry logic.
    • Set a Retry Limit: Ensure a maximum retry limit is in place to prevent excessive requests, which can lead to unexpected billing.

By adhering to these guidelines, you can avoid redundant or unwanted billable requests and ensure that your usage of the API is both efficient and cost-effective.


Image input Specifications

When adding an image to the request payload, it is essential to adhere to the following guidelines to ensure the image is processed correctly:

  • Maximum Dimensions: The image should not exceed a size of 4K.
  • Maximum Payload Size: The file must be no larger than 15 MB.
  • Supported File Formats: The following formats are accepted: JPG/PNG
    • ⚠️ Working on adding Webp, HEIC, HEIF

Please ensure your images conform to these specifications to avoid processing errors.