To use a Personal project type, you’ll need to run EvolutionAPI on your own infrastructure. This guide explains how to register your self-hosted server with EvolutionAPI Cloud.

Prerequisites

Before registering your server, make sure you have:

  • A running EvolutionAPI instance (version 2.2.1 or higher)
  • Access to your server’s admin panel or configuration
  • Your server’s API token

Server Registration

To register your server, click on the button ”+ Server” in top right corner:

Configuration Fields

  • URL Server:
    URL Server where the EvolutionAPI is running.

  • Token:
    This is your access key required for secure communication with the EvolutionAPI instance. Ensure this is kept private.

  • Version:
    Select the EvolutionAPI version to run.

    ⚠️ Only versions 2.2.1 or higher are supported for V2 servers

Setup Instructions

  1. Deploy the API Server:
    Install and configure EvolutionAPI on your server or VM according to the official deployment documentation.

  2. Retrieve the Token:
    Obtain the API token from your EvolutionAPI admin panel or the configuration file.

  3. Configure the Version:
    Select the desired API version. For stability and support, versions 2.2.1+ are recommended.

  4. Testing the Setup:
    Verify the API connection by sending a test request using the following command:

    curl -X GET "<your-server-url>/health" -H "Authorization: Bearer <your-token>"
    

Verification

After entering your server details:

  1. The system will verify the connection to your server
  2. If successful, your server will be registered and available for use in Personal projects
  3. You can then create Personal projects that use your self-hosted instances
Need help setting up EvolutionAPI on your server? Check our deployment documentation.

Creating a project personal

Now you can create a project personal