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

# Recall from RAG

> **Plans:** `Free` · `Developer` · `Enterprise`

Retrieves relevant memory snippets for a query against Walrus Memory / RAG.

**API credits:** 15 (ai_light).



## OpenAPI

````yaml /openapi/openapi.json post /api/v1/rag/recall
openapi: 3.1.0
info:
  title: Mermail API
  version: 1.0.0
  description: >
    Programmatic Mermail API for scripts, agents, and integrations.


    ## Authentication


    Authorize with an API key from **Settings → API Keys**:


    ```

    x-api-key: sk-proj-…

    ```


    ## Plans


    Each endpoint page shows plan badges (**Public**, **All plans**, or
    **Developer+**). Free can call the core catalog; Developer-gated paths need
    Developer or Enterprise.


    ## Try it


    Every endpoint page includes an interactive playground. Click **Try it**,
    paste your API key into the `x-api-key` field, fill path/query/body fields
    (prefilled from examples), and send a live request to
    `https://console.mermail.app`. You can also copy the generated cURL /
    JavaScript / Python snippet.


    ## Credits


    Credits are workspace API-usage units, not currency amounts.


    | Class | Cost |

    | --- | ---: |

    | read | 1 |

    | write | 2 |

    | email_send | 5 |

    | provision | 10 |

    | ai_light | 15 |

    | ai_heavy | 25 |
  contact:
    name: Mermail
    email: contact@mermail.app
    url: https://mermail.app
servers:
  - url: https://console.mermail.app
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: Public
    description: No authentication
  - name: Usage
    description: Credits and email quotas
  - name: Workspaces
    description: Workspaces, members, storage
  - name: Domains
    description: Custom email domains (Developer+)
  - name: Mailboxes
    description: Agent inboxes
  - name: Emails
    description: Send, list, search, folders
  - name: AI agent
    description: Mailbox agent chat
  - name: Task triage
    description: Task triagers (all plans)
  - name: RAG
    description: Knowledge documents and recall
  - name: Integrations
    description: Composio, Telegram, push
  - name: Affiliate
    description: Affiliate program
paths:
  /api/v1/rag/recall:
    post:
      tags:
        - RAG
      summary: Recall from RAG
      description: >-
        **Plans:** `Free` · `Developer` · `Enterprise`


        Retrieves relevant memory snippets for a query against Walrus Memory /
        RAG.


        **API credits:** 15 (ai_light).
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - ownerAddress
                - query
              properties:
                ownerAddress:
                  type: string
                  pattern: ^0x[0-9a-fA-F]+$
                  description: Sui owner address / object id
                  example: '0xabc123'
                query:
                  type: string
                  minLength: 1
                  maxLength: 4000
                  example: Refund policy for enterprise seats
                limit:
                  type: integer
                  minimum: 1
                  maximum: 10
                  default: 5
                  example: 5
            example:
              ownerAddress: '0xabc123'
              query: Refund policy for enterprise seats
              limit: 5
      responses:
        '200':
          description: Snippets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RagRecallResponse'
              example:
                snippets:
                  - text: Enterprise refunds are prorated within 14 days…
                    blobId: blob_01
                    distance: 0.12
        '401':
          description: Missing, invalid, expired, or revoked API key / token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Unauthorized
        '402':
          description: API credits exhausted for this workspace period
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Invalid request
        '403':
          description: Forbidden — plan gate, wrong workspace, or missing role
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Forbidden
        '429':
          description: Rate limit exceeded (workspace RPM or email send limits)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Too many requests
          headers:
            Retry-After:
              schema:
                type: integer
              description: Seconds until the rate limit window resets
      security:
        - apiKeyAuth: []
components:
  schemas:
    RagRecallResponse:
      type: object
      properties:
        snippets:
          type: array
          items:
            type: object
            properties:
              text:
                type: string
              blobId:
                type: string
              distance:
                type: number
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          example: Unauthorized
        code:
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key (`sk-proj-…`) from Settings → API Keys. Required for sold API
        calls outside the Mermail console.

````