> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ezapi.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar instância

> Cria uma nova instância da EZ API e retorna os identificadores necessários para as próximas chamadas.

Cria uma nova instância da EZ API e retorna os identificadores necessários para as próximas chamadas.


## OpenAPI

````yaml POST /instances
openapi: 3.0.3
info:
  title: EZ API
  version: 1.0.0
  description: >-
    Documentação pública reconstruída a partir da collection WA Gateway e
    validada contra os endpoints públicos existentes da EZ API.
servers:
  - url: https://api.ezapi.com.br
    description: Produção
  - url: http://localhost:3000
    description: Desenvolvimento local
security:
  - ClientToken: []
tags:
  - name: Instância
    description: >-
      Crie, conecte, monitore e ajuste o comportamento da sua instância do
      WhatsApp.
  - name: Mensagens
    description: >-
      Envie mensagens assíncronas em texto, mídia, interativos e recursos
      avançados.
  - name: Conversas
    description: Endpoints de conversas.
  - name: Contatos
    description: Endpoints de contatos.
  - name: Privacidade
    description: Endpoints de privacidade.
  - name: Grupos
    description: >-
      Crie grupos, gerencie participantes, convites, foto, descrição e
      permissões.
  - name: Status
    description: Endpoints de status.
  - name: Fila de mensagens
    description: Endpoints de fila de mensagens.
  - name: WhatsApp Business
    description: Endpoints de whatsapp business.
  - name: Webhooks
    description: Configure URLs HTTPS para receber eventos em tempo real da EZ API.
paths:
  /instances:
    post:
      tags:
        - Instância
      summary: Criar instância
      description: >-
        Cria uma nova instância da EZ API e retorna os identificadores
        necessários para as próximas chamadas.
      operationId: instance_create
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Nome de exibição da instância.
                  example: Minha Instância
                deliveryCallbackUrl:
                  type: string
                  format: uri
                  description: Webhook chamado no evento de entrega.
                  example: https://example.com/webhooks/delivery
                receivedCallbackUrl:
                  type: string
                  format: uri
                  description: Webhook chamado no evento de recebimento.
                  example: https://example.com/webhooks/received
                disconnectedCallbackUrl:
                  type: string
                  format: uri
                  description: Webhook chamado no evento de desconexão.
                  example: https://example.com/webhooks/disconnected
                connectedCallbackUrl:
                  type: string
                  format: uri
                  description: Webhook chamado no evento de conexão.
                  example: https://example.com/webhooks/connected
                messageStatusCallbackUrl:
                  type: string
                  format: uri
                  description: Webhook chamado quando o status da mensagem muda.
                  example: https://example.com/webhooks/status
                antiBanEnabled:
                  type: boolean
                  description: Ativa ou desativa o AntiBan já na criação.
                  example: false
            examples:
              criar-instancia:
                summary: Criar instância
                value:
                  name: Minha Instância
                  receivedCallbackUrl: https://webhook.site/seu-id
                  deliveryCallbackUrl: https://webhook.site/seu-id
                  disconnectedCallbackUrl: https://webhook.site/seu-id
                  connectedCallbackUrl: https://webhook.site/seu-id
                  antiBanEnabled: false
      responses:
        '201':
          description: Resposta de sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  instanceId:
                    type: string
                    example: abc1234567890
                  instanceToken:
                    type: string
                    example: tok_a1b2c3d4e5f6...
                  status:
                    type: string
                    example: pending
                required:
                  - instanceId
                  - instanceToken
                  - status
                example:
                  instanceId: abc1234567890
                  instanceToken: tok_a1b2c3d4e5f6...
                  status: pending
              example:
                instanceId: abc1234567890
                instanceToken: tok_a1b2c3d4e5f6...
                status: pending
        '400':
          description: Requisição inválida
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Bad Request
                message: name is required
        '401':
          description: Client-Token inválido ou ausente
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Unauthorized
                message: Missing or invalid Client-Token
        '500':
          description: Erro interno ao persistir a instância
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Internal Server Error
                message: Failed to persist instance in panel database
      security:
        - ClientToken: []
components:
  securitySchemes:
    ClientToken:
      type: apiKey
      in: header
      name: Client-Token

````