openapi: 3.2.0
info:
  title: AutoGPT Agent Server Auth Email API
  summary: AutoGPT Agent Server
  description: This server is used to execute agents that are created by the AutoGPT system.
  version: '0.1'
tags:
- name: auth-email
paths:
  /api/auth/email/send:
    post:
      tags:
      - auth-email
      summary: Send a Better Auth transactional email via the backend mailer
      operationId: sendAuthTransactionalEmail
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthEmailRequest'
        required: true
      responses:
        '204':
          description: Successful Response
        '400':
          description: url does not point at a trusted frontend origin
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
        '403':
          description: Service token is missing the required scope
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '503':
          description: Service-token verification is not configured
      security:
      - HTTPBearerJWT: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    AuthEmailRequest:
      properties:
        type:
          type: string
          enum:
          - reset_password
          - verify_email
          - change_email
          title: Type
        to:
          type: string
          format: email
          title: To
        url:
          type: string
          title: Url
      type: object
      required:
      - type
      - to
      - url
      title: AuthEmailRequest
  responses:
    HTTP401NotAuthenticatedError:
      description: Authentication required
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
  securitySchemes:
    APIKeyAuthenticator-X-Postmark-Webhook-Token:
      type: apiKey
      in: header
      name: X-Postmark-Webhook-Token
    HTTPBearer:
      type: http
      scheme: bearer
    HTTPBearerJWT:
      type: http
      scheme: bearer
      bearerFormat: jwt