Criar instância

POST/v1/instancesdesde M1token admin

Quando usar

Cria a instância e já sobe o worker dela (o estado passa de created a starting e depois qr_pending). O token da instância aparece uma única vez nesta resposta; o servidor guarda só o hash. A resposta leva Cache-Control: no-store.

Autenticação

Exige o token admin. Com um token de instância a resposta é 403 forbidden.

Parâmetros

Corpo (JSON)

Nome	Tipo	Descrição
nameobrigatório	string	Nome livre para identificar a instância.

Exemplo

cURL

curl -s -X POST "$LITEZAP_URL/v1/instances" \
  -H "Authorization: Bearer $LITEZAP_ADMIN_TOKEN" \
  -d '{"name":"atendimento"}'

Node.js

const res = await fetch("http://localhost:8787/v1/instances", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.LITEZAP_ADMIN_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "name": "atendimento"
  }),
});
console.log(res.status, res.status === 204 ? "" : await res.json());

Python

import os
import requests

r = requests.post(
    "http://localhost:8787/v1/instances",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_ADMIN_TOKEN']}"},
    json={
        "name": "atendimento",
    },
    timeout=150,
)
print(r.status_code, r.json() if r.content else "")

Go

package main

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

func main() {
  req, _ := http.NewRequest("POST", "http://localhost:8787/v1/instances", strings.NewReader(`{"name":"atendimento"}`))
  req.Header.Set("Authorization", "Bearer "+os.Getenv("LITEZAP_ADMIN_TOKEN"))
  req.Header.Set("Content-Type", "application/json")
  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()
  out, _ := io.ReadAll(resp.Body)
  fmt.Println(resp.Status, string(out))
}

PHP

<?php
require 'vendor/autoload.php'; // composer require guzzlehttp/guzzle

$client = new GuzzleHttp\Client(['base_uri' => 'http://localhost:8787']);
$res = $client->request('POST', '/v1/instances', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_ADMIN_TOKEN')],
    'json' => [
        'name' => 'atendimento',
    ],
    'http_errors' => false,
]);
echo $res->getStatusCode(), ' ', $res->getBody(), PHP_EOL;

Nos exemplos, LITEZAP_URL é a URL base (ex.: http://localhost:8787) e o token vem deLITEZAP_TOKEN (instância) ou LITEZAP_ADMIN_TOKEN.

Resposta

201 Instância criada.

Campos de InstanceCreated

instance	Instance
instance.id	string
instance.name	string
instance.state	InstanceState
instance.state_reason	string	Ex.: proxy_unreachable, temp_banned:<duração>.
instance.phone	string	Número conectado (depois do pareamento).
instance.tags	string[]	Etiquetas (marco 11).
instance.ip_allowlist	string[]	CIDRs de onde o token da instância é aceito; vazio = qualquer (marco 11).
instance.created_at	string
instance.updated_at	string
token	string	Token da instância (lzi_...). Mostrado só uma vez.

{
  "instance": {
    "id": "inst_7f3a9c2e5b1d4086",
    "name": "atendimento",
    "state": "starting",
    "created_at": "2026-10-17T13:45:00Z",
    "updated_at": "2026-10-17T13:45:00Z"
  },
  "token": "lzi_Q2hhdmUtZGUtZXhlbXBsby1uYW8tdXNl"
}

Erros

Código	HTTP	Retentável	O que fazer
validation_failed	400	não	Corrija o corpo ou os parâmetros; a message diz o campo.
unauthorized	401	não	Envie Authorization: Bearer <token> válido.
forbidden	403	não	Use o token certo (admin, ou o da própria instância).

Todo erro usa o envelope {"error":{"code","message","retryable"}}. Tabela completa em Erros.

Eventos gerados

• instance.status

Equivalente na Z-API: Criar instância (parceiros). Veja Migrar da Z-API.

Outras operações de Instâncias: Listar instâncias · Consultar instância · Editar instância · Apagar instância · Iniciar worker · Parar worker · Reiniciar worker · Desconectar número · Rotacionar token da instância