Create a new instance

curl --request POST \
  --url http://localhost:8080/instance/create \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "name": "<string>",
  "proxy": {
    "address": "<string>",
    "password": "<string>",
    "port": "<string>",
    "username": "<string>"
  },
  "token": "<string>"
}
'

import requests

url = "http://localhost:8080/instance/create"

payload = {
    "name": "<string>",
    "proxy": {
        "address": "<string>",
        "password": "<string>",
        "port": "<string>",
        "username": "<string>"
    },
    "token": "<string>"
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    proxy: {
      address: '<string>',
      password: '<string>',
      port: '<string>',
      username: '<string>'
    },
    token: '<string>'
  })
};

fetch('http://localhost:8080/instance/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/instance/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'proxy' => [
        'address' => '<string>',
        'password' => '<string>',
        'port' => '<string>',
        'username' => '<string>'
    ],
    'token' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/instance/create"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"proxy\": {\n    \"address\": \"<string>\",\n    \"password\": \"<string>\",\n    \"port\": \"<string>\",\n    \"username\": \"<string>\"\n  },\n  \"token\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:8080/instance/create")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"proxy\": {\n    \"address\": \"<string>\",\n    \"password\": \"<string>\",\n    \"port\": \"<string>\",\n    \"username\": \"<string>\"\n  },\n  \"token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/instance/create")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"proxy\": {\n    \"address\": \"<string>\",\n    \"password\": \"<string>\",\n    \"port\": \"<string>\",\n    \"username\": \"<string>\"\n  },\n  \"token\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "test",
    "token": "f0e1d2c3-b4a5-6789-0abc-def123456789",
    "webhook": "",
    "rabbitmqEnable": "",
    "websocketEnable": "",
    "natsEnable": "",
    "jid": "",
    "qrcode": "",
    "connected": false,
    "expiration": 0,
    "disconnect_reason": "",
    "events": "",
    "os_name": "Evolution GO",
    "proxy": "",
    "client_name": "evolution",
    "createdAt": "2026-01-15T10:30:00.000000-03:00",
    "alwaysOnline": false,
    "rejectCall": false,
    "msgRejectCall": "",
    "readMessages": false,
    "ignoreGroups": false,
    "ignoreStatus": false
  },
  "message": "success"
}

{
  "success": false,
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request data. Instance information is required."
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "path": "/instance/create",
    "method": "POST"
  }
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "path": "/instance/create",
    "method": "POST"
  }
}

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient permissions to create instance"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "path": "/instance/create",
    "method": "POST"
  }
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "path": "/instance/create",
    "method": "POST"
  }
}

{
  "success": false,
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "An unexpected error occurred"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "path": "/instance/create",
    "method": "POST"
  }
}