> ## 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 a new prompt

> Creates a new Prompt document owned by the calling user and organization. The body becomes the live prompt content; subsequent edits create versions, not new prompts.



## OpenAPI

````yaml /api-reference/openapi.yaml post /api/prompts/create
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/prompts/create:
    post:
      tags:
        - Prompts
      summary: Create a new prompt
      description: >-
        Creates a new Prompt document owned by the calling user and
        organization. The body becomes the live prompt content; subsequent edits
        create versions, not new prompts.
      operationId: post_prompts_create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromptCreateRequest'
      responses:
        '200':
          description: Prompt created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptCreateResponse'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    PromptCreateRequest:
      type: object
      properties:
        name:
          type: string
          description: Human-readable prompt name shown in pickers and lists.
        prompt:
          type: string
          description: XML prompt body driving the AI agent.
        responseTime:
          type: number
          description: >-
            Target reply latency in seconds; the engine throttles streaming to
            roughly this duration.
        description:
          type: string
          description: >-
            Short summary of the prompt's purpose; surfaced in summary lists and
            pickers.
        isHidden:
          type: boolean
          description: Hidden prompts are excluded from non-admin lists and approval flows.
        temperature:
          type: number
          description: Sampling temperature (0-1). Lower = more deterministic.
      required:
        - name
      additionalProperties: true
      example:
        name: Leasing follow-up assistant
        prompt: >-
          <prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after
          their last reply.</goal></prompt>
        description: Follow up with leads 24h after their last response.
        temperature: 0.7
        responseTime: 45
        isHidden: false
    PromptCreateResponse:
      type: object
      description: Returned by `POST /api/prompts/create`.
      properties:
        message:
          type: string
        prompt:
          $ref: '#/components/schemas/PromptDocument'
      required:
        - message
        - prompt
      additionalProperties: true
      example:
        message: Prompt created successfully
        prompt:
          _id: 64d2f9c5e8a1d4e001a0b1c2
          name: Maple Court — Tour confirm
          description: Confirms a tour booking and proposes alternates.
          prompt: >-
            <prompt><role>Leasing assistant</role><goal>Confirm
            tour.</goal></prompt>
          temperature: 0.3
          responseTime: 30
          isHidden: false
          voiceAI:
            enabled: false
          createdBy: 64a1b2c3d4e5f60012345679
          organizationId: 64a1b2c3d4e5f60012345678
          createdAt: '2026-05-20T15:04:01.135Z'
          updatedAt: '2026-05-20T15:04:01.135Z'
    PromptErrorResponse:
      type: object
      description: Generic error envelope returned by Prompt endpoints.
      properties:
        error:
          type: string
        details:
          type: string
      required:
        - error
      additionalProperties: true
      example:
        error: Prompt not found
        details: No prompt with id 5f7b1c2e8a1d4e0012c3b4a5 belongs to this user.
    PromptDocument:
      type: object
      description: >-
        Prompt document as stored in the Prompt collection. Returned shape
        varies slightly per endpoint (some list/summary endpoints project a
        subset of fields).
      properties:
        _id:
          type: string
        name:
          type: string
        prompt:
          type: string
          description: >-
            Prompt body. Omitted (i.e. stripped) for non-admin callers when
            `isHidden` is true.
        description:
          type: string
        temperature:
          type: number
        responseTime:
          type: number
        isHidden:
          type: boolean
        tools:
          type: array
          items:
            type: object
            additionalProperties: true
        toolConfigs:
          type: object
          additionalProperties: true
        organizationId:
          type: string
        userId:
          type: string
        copiedFrom:
          type: string
          nullable: true
        copiedFromName:
          type: string
          nullable: true
        copiedFromOrg:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      additionalProperties: true
      example:
        _id: 5f7b1c2e8a1d4e0012c3b4a5
        name: Leasing follow-up assistant
        prompt: >-
          <prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after
          their last reply.</goal></prompt>
        description: Follow up with leads 24h after their last response.
        temperature: 0.7
        responseTime: 45
        isHidden: false
        tools:
          - name: book_tour
        toolConfigs:
          book_tour:
            requireApproval: true
        organizationId: 64a1b2c3d4e5f60012345678
        userId: 64a1b2c3d4e5f60012345679
        createdAt: '2026-03-12T14:22:10.000Z'
        updatedAt: '2026-04-22T10:14:00.000Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````