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

# Conectar via token (QR / pairing)

> Gera o QR code + pairing code para o número associado ao token e marca a instância como CONNECTING. Endpoint público por token (página /connect/<token>); não exige API key. 409 se já OPEN. Efeito real: inicia a conexão. 402 PLAN_NUMBER_LIMIT_REACHED quando o workspace que emitiu o link está no plano Grátis, a cota dele já está cheia e este número nunca conectou.



## OpenAPI

````yaml openapi.pt.json POST /v1/remote-pairing/{token}/connect
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/remote-pairing/{token}/connect:
    post:
      tags:
        - Remote Pairing
      summary: Conectar via token (QR / pairing)
      description: >-
        Gera o QR code + pairing code para o número associado ao token e marca a
        instância como CONNECTING. Endpoint público por token (página
        /connect/<token>); não exige API key. 409 se já OPEN. Efeito real:
        inicia a conexão. 402 PLAN_NUMBER_LIMIT_REACHED quando o workspace que
        emitiu o link está no plano Grátis, a cota dele já está cheia e este
        número nunca conectou.
      operationId: post_remote-pairing_token_connect
      parameters:
        - name: token
          in: path
          required: true
          description: Token de pareamento remoto.
          schema:
            type: string
          example: rp_01HZX...
      responses:
        '200':
          description: Conectar via token
          content:
            application/json:
              example:
                qrcodeBase64: data:image/png;base64,iVBORw0KGgo...
                pairingCode: ABCD-1234
        '400':
          description: Payload ou parâmetros inválidos
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '402':
          description: >-
            Só no plano Grátis: o workspace que emitiu o link está no plano
            Grátis, a cota de números dele já está cheia e este número nunca
            conectou, então o pareamento é recusado e nenhum QR code é gerado.
            Quem está com o link não tem como resolver: o workspace precisa
            comprar um número extra de forma explícita ou subir de plano.
            Reparear um número que já tinha conectado nunca é recusado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - PLAN_NUMBER_LIMIT_REACHED
                  code:
                    type: string
                    enum:
                      - PLAN_NUMBER_LIMIT_REACHED
                  message:
                    type: string
                    description: Frase bilíngue, `English | Português`.
                  plan:
                    type: string
                    enum:
                      - FREE
                  maxNumbers:
                    type: integer
                  currentNumberCount:
                    type: integer
              example:
                error: PLAN_NUMBER_LIMIT_REACHED
                code: PLAN_NUMBER_LIMIT_REACHED
                message: >-
                  This workspace's Free plan has no room for another number. Buy
                  an extra number or upgrade the plan to connect this one. | O
                  plano Grátis deste workspace não comporta mais um número.
                  Compre um número extra ou faça upgrade do plano para conectar
                  este.
                plan: FREE
                maxNumbers: 1
                currentNumberCount: 1
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.