All Collections
Working with the API for Photo Editing
Authentication and API key management
Authentication and API key management
Jamie McInally avatar
Written by Jamie McInally
Updated over a week ago

Proper authentication and API key management ensure secure access to our AI photo editing service's API. This article will guide you through the authentication process and provide best practices for managing your API key.

  1. Authentication Process:

    Our API uses API keys for authentication. An API key is a unique identifier for your account and must be included in the header of every API request. The authentication process is as follows:

    • You can get an API key from your account settings (see the 'API documentation and usage guidelines' section below for more details).

    • Include the API key in the header of your API requests using the format: x-api-key: YOUR_API_KEY.

    • Our system will verify the API key and grant access to the requested resources if the key is valid and your account has the necessary permissions.

  2. API Key Management Best Practices:

    Proper management of your API key is essential for maintaining the security and integrity of your account. Consider the following best practices:

    • Keep your API key secure: Treat your API key like a password, and do not share it publicly or with unauthorised individuals. Store it securely, for example, in an encrypted password manager or a secure environment variable.

    • Monitor your API usage: Regularly check your API usage and account activity to identify suspicious or unauthorised access. If you detect any unusual activity, request a new API key immediately and update your applications accordingly.

Following these authentication and API key management best practices can help protect your account and ensure secure access to our AI photo editing service's API. If you have any questions or need any more help, please refer to our help centre articles or contact our customer support team.

Did this answer your question?