openmail-sh Feedback API

openapi: 3.2.0
info:
  title: OpenMail Feedback API
  description: Email infrastructure API for AI agents. Create inboxes, send and receive email, and get real-time notifications via webhooks.
  version: 1.0.0
  license:
    name: Proprietary
servers:
- url: https://api.openmail.sh
security:
- bearerAuth: []
tags:
- name: Feedback
  description: Reporting bugs, friction, and feature requests to the OpenMail team
paths:
  /v1/feedback:
    post:
      operationId: createFeedback
      summary: Report feedback
      tags:
      - Feedback
      description: Report a bug, a point of friction, or a feature request directly to the OpenMail team. If an API call fails unexpectedly, a response looks wrong, or you notice something that would make OpenMail work better for you, send it here — one call, no confirmation needed, and the team reads every report. Works even while an inbox or pod is suspended. Include what you were trying to do and what you observed; attach the endpoint, error code, and request id in `context` when the report concerns a specific failed call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
              - type
              - message
              properties:
                type:
                  type: string
                  enum:
                  - bug
                  - friction
                  - feature_request
                  description: '`bug` for something broken or a response that looks wrong, `friction` for something that works but was confusing or harder than it should be, `feature_request` for a capability OpenMail lacks.'
                message:
                  type: string
                  minLength: 1
                  maxLength: 5000
                  description: What you were trying to do, what you expected, and what actually happened. Plain text.
                context:
                  type: object
                  additionalProperties: false
                  description: Optional details of the specific API call the report concerns.
                  properties:
                    endpoint:
                      type: string
                      maxLength: 255
                      description: The API path involved, e.g. `/v1/inboxes/{id}/send`.
                    errorCode:
                      type: string
                      maxLength: 255
                      description: The `error` field of the response you received, if any.
                    requestId:
                      type: string
                      maxLength: 255
                      description: The request id from the response, if you have one.
      responses:
        '201':
          description: Feedback recorded
          content:
            application/json:
              schema:
                description: Feedback recorded
                type: object
                additionalProperties: false
                properties:
                  id:
                    type: string
                    description: Id of the recorded report
                  status:
                    type: string
                    enum:
                    - received
        '429':
          description: Feedback rate limit reached for your account (`feedback_rate_limited`) — the daily cap resets at midnight UTC
          content:
            application/json:
              schema:
                description: Feedback rate limit reached for your account (`feedback_rate_limited`) — the daily cap resets at midnight UTC
                allOf:
                - $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      additionalProperties: true
      properties:
        error:
          type: string
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key