All Collections
Working with the API for Photo Editing
API documentation and usage guidelines
API documentation and usage guidelines
Jamie McInally avatar
Written by Jamie McInally
Updated over a week ago

Our AI photo editing service also offers a powerful API, allowing you to integrate our suite of tools directly into your existing applications or workflows. This article will overview our API documentation and offer some general usage guidelines to help you get started.

  1. API Documentation:

    Our comprehensive API documentation provides all the information you need to integrate and use our AI photo editing service successfully. The documentation includes the following:

    • API endpoint URLs

    • Supported request methods (GET, POST, etc.)

    • Required and optional request parameters

    • Expected response formats and data types

    • Error codes and messages

    • Code examples in various programming languages (Python, JavaScript, etc.)

    Our API documentation can be found here

  2. API Key:

    You'll need an API key to use our API, which acts as a unique identifier for your account and ensures secure access to our service. To generate an API key, follow these steps:

    • Sign in to your account on our website (

    • Navigate to the 'API' section in your account settings.

    • Click the 'Inspect' button to view your API key.

    • Copy and store the generated API key securely, as you'll need it for all your API requests.

    Note: Treat your API key like a password; do not share it publicly or with unauthorised individuals.

  3. Usage Guidelines:

    When using our API, please keep the following guidelines in mind:

    • Please ensure your requests comply with our API documentation, including the required parameters and data types.

    • Please always include your API key in the header of your authentication requests.

    • Be mindful of the rate limits for our API, which may vary depending on your subscription plan. Exceeding the rate limits may result in a temporary suspension of your API access.

    • Before deploying it to production, test your API integration in a development or staging environment.

Following our API documentation and adhering to these usage guidelines, you can seamlessly integrate our AI photo editing tools into your existing applications or workflows. If you need more help or have questions, please refer to our help centre articles or contact our customer support team.

Did this answer your question?