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

# Create new AI model (superadmin only)

> Adds a new provider entry to the global AiModel registry. SUPERADMIN-only. vercelUniqueName must be unique across the registry; duplicates return 400.



## OpenAPI

````yaml /api-reference/openapi.yaml post /api/ai-models
openapi: 3.0.3
info:
  title: Tether Relay and Tether API
  version: 1.0.0
  description: >-
    Route-derived OpenAPI contract generated from tether-relay backend sources.
    Regenerate with scripts/sync-openapi-from-backend.mjs.
servers:
  - url: https://your-instance.example.com
    description: Production
  - url: http://localhost:2212
    description: Local API service
security: []
tags:
  - name: AI
  - name: Applications
  - name: Approval
  - name: Auth
  - name: Automations
  - name: Calls
  - name: Campaigns
  - name: Contact Analytics
  - name: Contact Metrics
  - name: Contact Notes
  - name: Contacts
  - name: Conversation Monitor
  - name: Conversations
  - name: Departments
  - name: Email
  - name: Escalation Dashboard
  - name: Event Logs
  - name: Google Sheets
  - name: Marketplace
  - name: Messages
  - name: Notification Sounds
  - name: Notifications
  - name: Org Snapshots
  - name: Organizations
  - name: Outreach
  - name: Outreach Metrics
  - name: Outreach Sources
  - name: Pipelines
  - name: Processes
  - name: Prompts
  - name: Reminders
  - name: Sms
  - name: Templates
  - name: Traces
  - name: Training
  - name: Upload
  - name: User Snapshots
  - name: Users
  - name: Vertical
  - name: Webchats
  - name: Webhook
paths:
  /api/ai-models:
    post:
      tags:
        - AI Models
      summary: Create new AI model (superadmin only)
      description: >-
        Adds a new provider entry to the global AiModel registry.
        SUPERADMIN-only. vercelUniqueName must be unique across the registry;
        duplicates return 400.
      operationId: create_ai_model
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAiModelRequest'
      responses:
        '201':
          description: AI model created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiModelResponse'
        '400':
          description: Missing required fields or duplicate
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiModelsErrorResponse'
        '403':
          description: Only superadmins can create AI models
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiModelsErrorResponse'
        '500':
          description: Failed to create AI model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiModelsErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    CreateAiModelRequest:
      type: object
      properties:
        providerName:
          type: string
          description: >-
            Human-readable provider name shown in the admin UI (e.g.
            `Anthropic`, `OpenAI`).
        vercelUniqueName:
          type: string
          description: >-
            Vercel AI SDK provider identifier (e.g. `anthropic`, `openai`,
            `google`). Must be unique across the registry.
        websiteUrl:
          type: string
          description: Provider marketing/docs URL displayed alongside the provider card.
        modelDetails:
          type: array
          items:
            type: object
          description: 'Per-model metadata: `modelName` and optional description/pricing.'
      required:
        - providerName
        - vercelUniqueName
      additionalProperties: true
      example:
        providerName: Anthropic
        vercelUniqueName: anthropic
        websiteUrl: https://www.anthropic.com
        modelDetails:
          - modelName: claude-sonnet-4-6
            description: Balanced reasoning + speed.
    AiModelResponse:
      type: object
      description: >-
        Single-AiModel success envelope returned by create/update of an
        `AiModel` registry entry.
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          $ref: '#/components/schemas/AiModelDocument'
      required:
        - success
        - data
      additionalProperties: true
      example:
        success: true
        data:
          _id: 5f7b1c2e8a1d4e0012c3b4a5
          providerName: Anthropic
          vercelUniqueName: anthropic
          websiteUrl: https://www.anthropic.com
          modelDetails:
            - modelName: claude-sonnet-4-6
              description: Latest Sonnet release.
            - modelName: claude-haiku-4-5
              description: Fast, cost-efficient Haiku.
    AiModelsErrorResponse:
      type: object
      description: >-
        Error envelope returned by AI Models endpoints. `error` may be present
        on contract-validation failures.
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
        error:
          description: >-
            Optional error detail (string or structured object on validation
            failures).
      required:
        - success
      additionalProperties: true
      example:
        success: false
        message: Organization credentials not found
    AiModelDocument:
      type: object
      description: An `AiModel` registry entry (provider plus its available models).
      properties:
        _id:
          type: string
        providerName:
          type: string
        vercelUniqueName:
          type: string
          description: >-
            Vercel AI SDK provider identifier (e.g. `anthropic`, `openai`,
            `google`).
        websiteUrl:
          type: string
        modelDetails:
          type: array
          items:
            type: object
            additionalProperties: true
          description: >-
            Per-model metadata: `modelName`, optional `description`, pricing,
            etc.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      additionalProperties: true
      example:
        _id: 5f7b1c2e8a1d4e0012c3b4a5
        providerName: Anthropic
        vercelUniqueName: anthropic
        websiteUrl: https://www.anthropic.com
        modelDetails:
          - modelName: claude-sonnet-4-6
            description: Latest Sonnet release.
          - modelName: claude-haiku-4-5
            description: Fast, cost-efficient Haiku.
        createdAt: '2025-09-12T14:22:10.000Z'
        updatedAt: '2026-04-30T09:11:45.000Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````