---
title: "Connect an instance (get QR code)"
method: POST
path: "/instance/{id}/connect"
tags: ["Instance"]
---

# Connect an instance (get QR code)

`POST /instance/{id}/connect`

Initiates connection for an instance. Returns a base64-encoded QR code PNG if not yet connected, or a connected status message.

## Path parameters

- `id` string, required

## Response `200`

OK

- DtoConnectInstanceResponse
  - `alwaysOnline` boolean
  - `base64` string
  - `connected` boolean
  - `groupsIgnore` boolean
  - `id` string
  - `message` string
  - `msgCall` string
  - `pairingCode` string
  - `proxyHost` string
  - `proxyPassword` string
  - `proxyPort` string
  - `proxyProtocol` string
  - `proxyUsername` string
  - `readMessages` boolean
  - `readStatus` boolean
  - `rejectCall` boolean
  - `remoteJID` string
  - `syncFullHistory` boolean
  - `syncRecentHistory` boolean
  - `webhook` ModelsInstanceWebhook
    - `base64` boolean
    - `byEvents` boolean
    - `enabled` boolean
    - `events` string[]
    - `headers` object
    - `url` string

## Other responses

- `404` — Not Found
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/verbeux-ai/apis/whatsmiau-api.md) · [All operations](https://skmtc.net/verbeux-ai/apis/whatsmiau-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verbeux-ai/whatsmiau-api/versions/5af3cb49985a/schema)