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

# Create number (PILOT_STATUS)

> Creates an unofficial WhatsApp number (PILOT_STATUS) and returns the QR code + pairing code to pair it. By default links the number to the calling API key (set linkToApiKey:false to skip). Real side effect: provisions an instance.



## OpenAPI

````yaml openapi.json POST /v1/numbers
openapi: 3.1.0
info:
  title: Pilot Status API
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    Public REST API for Pilot Status. Authenticate with the `x-api-key: ps_...`
    header (or `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: Create number (PILOT_STATUS)
      description: >-
        Creates an unofficial WhatsApp number (PILOT_STATUS) and returns the QR
        code + pairing code to pair it. By default links the number to the
        calling API key (set linkToApiKey:false to skip). Real side effect:
        provisions an instance.
      operationId: post_numbers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Display name for the number.
                  example: Suporte
                number:
                  type: string
                  description: Phone number (min 10 digits, optional +).
                  example: '5511999999999'
                linkToApiKey:
                  type: boolean
                  description: Link the new number to the calling API key (default true).
                  example: 'true'
              required:
                - name
                - number
            example:
              name: Suporte
              number: '5511999999999'
      responses:
        '201':
          description: Create number
          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: Invalid payload or parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Missing or invalid `x-api-key` / `x-api-key-id` header
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '429':
          description: Rate limit exceeded
          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: Your ps_ API key
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: API key id (alternative to x-api-key)

````