> ## 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.

# Criar número (PILOT_STATUS)

> Cria um número WhatsApp não-oficial (PILOT_STATUS) e retorna o QR code + pairing code para parear. Por padrão, vincula o número à API key chamadora (defina linkToApiKey:false para não vincular). Efeito real: provisiona uma instância.



## OpenAPI

````yaml openapi.pt.json POST /v1/numbers
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/numbers:
    post:
      tags:
        - Numbers
      summary: Criar número (PILOT_STATUS)
      description: >-
        Cria um número WhatsApp não-oficial (PILOT_STATUS) e retorna o QR code +
        pairing code para parear. Por padrão, vincula o número à API key
        chamadora (defina linkToApiKey:false para não vincular). Efeito real:
        provisiona uma instância.
      operationId: post_numbers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Nome de exibição do número.
                  example: Suporte
                number:
                  type: string
                  description: Número de telefone (mínimo 10 dígitos, opcional +).
                  example: '5511999999999'
                linkToApiKey:
                  type: boolean
                  description: Vincular o novo número à API key chamadora (padrão true).
                  example: 'true'
              required:
                - name
                - number
            example:
              name: Suporte
              number: '5511999999999'
      responses:
        '201':
          description: Criar número
          content:
            application/json:
              example:
                instance:
                  id: num_01HZX...
                  number: '5511999999999'
                  name: Suporte
                  provider: PILOT_STATUS
                  status: CONNECTING
                  isFullyConnected: false
                qrcodeBase64: data:image/png;base64,iVBORw0KGgo...
                pairingCode: ABCD-1234
                linkedApiKeyId: key_01HZX...
        '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
        '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)

````