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

# Post phoneprovision



## OpenAPI

````yaml /openapi.json post /phone/provision
openapi: 3.1.1
info:
  title: Anima API
  version: 0.1.0
  description: >-
    The Anima API provides programmatic access to unified infrastructure for AI
    agents: create and manage agents; send and receive email; place phone calls
    and send/receive SMS and voice; store and retrieve vault credentials; manage
    agent identity; and configure webhooks for real-time events. Authenticate
    using a Bearer token or an API key passed via the X-API-Key header.
  contact:
    name: Anima Labs
    url: https://useanima.sh
    email: support@useanima.sh
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.useanima.sh/v1
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
paths:
  /phone/provision:
    post:
      operationId: phone.provision
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                agentId:
                  anyOf:
                    - type: string
                      pattern: ^[0-9a-z]+$
                    - type: string
                      pattern: ^[cC][^\s-]{8,}$
                  description: Agent to assign the provisioned phone number to
                countryCode:
                  default: US
                  type: string
                  pattern: ^[A-Za-z]{2}$
                  description: ISO 3166-1 alpha-2 country code for number selection
                numberType:
                  enum:
                    - local
                    - mobile
                    - national
                    - toll_free
                    - shared_cost
                  type: string
                  description: >-
                    Phone number type to provision (treated as local when
                    omitted)
                areaCode:
                  type: string
                  description: Preferred area code for the phone number
                capabilities:
                  type: array
                  items:
                    enum:
                      - sms
                      - mms
                      - voice
                    type: string
                    description: Communication capability type
                  description: Required capabilities for the phone number
              required:
                - agentId
              description: Request body for provisioning a new phone number for an agent
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique identifier for the provisioned phone record
                  phoneNumber:
                    type: string
                    description: E.164 formatted phone number that was provisioned
                  providerId:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: Opaque carrier-side identifier for the number
                  capabilities:
                    type: object
                    properties:
                      sms:
                        type: boolean
                        description: Whether SMS messaging is enabled
                      mms:
                        type: boolean
                        description: Whether MMS messaging is enabled
                      voice:
                        type: boolean
                        description: Whether voice calls are enabled
                    required:
                      - sms
                      - mms
                      - voice
                    description: Active communication capabilities for this number
                  tenDlcStatus:
                    enum:
                      - PENDING
                      - REGISTERED
                      - REJECTED
                      - NOT_REQUIRED
                      - UNREGISTERED
                    type: string
                    description: 10DLC campaign registration status for A2P SMS compliance
                  isPrimary:
                    type: boolean
                    description: Whether this is the primary phone number for the agent
                  createdAt:
                    type: string
                    format: date-time
                    description: ISO 8601 timestamp when the number was provisioned
                required:
                  - id
                  - phoneNumber
                  - providerId
                  - capabilities
                  - tenDlcStatus
                  - isPrimary
                  - createdAt
                description: >-
                  Provisioned phone number resource with provider and compliance
                  details
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token obtained from authentication. Pass as: Authorization:
        Bearer <token>
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for programmatic access. Pass as: X-API-Key: <your-key>'

````

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