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



## OpenAPI

````yaml /openapi.json post /identities
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: []
tags:
  - name: Agents
    description: Create and manage AI agents with email and phone capabilities
  - name: Inboxes
    description: Manage email inboxes and their configurations
  - name: Messages
    description: Send, receive, and search email messages
  - name: Webhooks
    description: Register and manage webhook subscriptions for real-time events
  - name: Organizations
    description: Manage organizations and team settings
  - name: Domains
    description: Configure and verify custom email domains
  - name: Phone
    description: Manage phone numbers and SMS/voice capabilities
  - name: Invoices
    description: Track invoices, match receipts, and reconcile payments
  - name: Billing
    description: View usage, tiers, and billing information
  - name: Security
    description: Configure security policies and access controls
  - name: Vault
    description: Store and retrieve encrypted secrets
  - name: API Keys
    description: Create and manage API keys for programmatic access
paths:
  /identities:
    post:
      operationId: provision.create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 2
                  maxLength: 100
                  description: Human-readable name for the agent (e.g. 'shopping-agent')
                slug:
                  type: string
                  minLength: 2
                  maxLength: 64
                  pattern: ^[a-z0-9-]+$
                  description: URL-safe identifier. Auto-derived from name if omitted
                capabilities:
                  type: array
                  items:
                    enum:
                      - email
                      - phone
                      - vault
                    type: string
                  minItems: 1
                  description: Capabilities to provision. Email is always included.
                email:
                  type: string
                  format: email
                  description: Custom email address. Defaults to {slug}@agents.useanima.sh
                phone:
                  type: object
                  properties:
                    countryCode:
                      default: US
                      type: string
                      minLength: 2
                      maxLength: 2
                      description: ISO 3166-1 alpha-2
                    areaCode:
                      type: string
                      description: Preferred area code
                  description: >-
                    Phone provisioning options (only used if 'phone' is in
                    capabilities)
                metadata:
                  default: {}
                  type: object
                  additionalProperties: {}
                  description: Arbitrary key-value metadata
              required:
                - name
                - capabilities
              description: Provision a complete agent identity in a single call
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Agent ID
                  name:
                    type: string
                  slug:
                    type: string
                  apiKey:
                    type: string
                    description: Agent API key — only returned on creation
                  email:
                    anyOf:
                      - type: object
                        properties:
                          id:
                            type: string
                          email:
                            type: string
                          domain:
                            type: string
                          isPrimary:
                            type: boolean
                        required:
                          - id
                          - email
                          - domain
                          - isPrimary
                      - type: 'null'
                    description: Email identity (always provisioned)
                  phone:
                    anyOf:
                      - type: object
                        properties:
                          id:
                            type: string
                          phoneNumber:
                            type: string
                          provider:
                            type: string
                          capabilities:
                            type: object
                            properties:
                              sms:
                                type: boolean
                              mms:
                                type: boolean
                              voice:
                                type: boolean
                            required:
                              - sms
                              - mms
                              - voice
                          isPrimary:
                            type: boolean
                        required:
                          - id
                          - phoneNumber
                          - provider
                          - capabilities
                          - isPrimary
                      - type: 'null'
                    description: Phone identity (if requested)
                  vault:
                    anyOf:
                      - type: object
                        properties:
                          id:
                            type: string
                          status:
                            type: string
                        required:
                          - id
                          - status
                      - type: 'null'
                    description: Vault identity (if requested)
                  failures:
                    type: array
                    items:
                      type: object
                      properties:
                        capability:
                          enum:
                            - email
                            - phone
                            - vault
                          type: string
                        error:
                          type: string
                      required:
                        - capability
                        - error
                    description: >-
                      Capabilities that failed to provision. Empty on full
                      success.
                  createdAt:
                    type: string
                    format: date-time
                required:
                  - id
                  - name
                  - slug
                  - apiKey
                  - email
                  - phone
                  - vault
                  - failures
                  - createdAt
                description: Provisioned agent identity with all requested capabilities
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>'

````