---
title: "API reference"
description: "Generated TypeScript reference for every public nuxt-backend import path and auto-imported composable."
canonical_url: "https://nuxt-backend.dev/docs/reference/api"
---
# API reference

## Modules

<table>
<thead>
  <tr>
    <th>
      Module
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/aggregate">
        nuxt-backend/aggregate
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/ai">
        nuxt-backend/ai
      </a>
    </td>
    
    <td>
      The rails for selling metered AI features — <code>
        nuxt-backend/ai
      </code>
      
      : wrap any Convex action so it is rate-limited, prepaid-credit-metered (reserve → run → settle — a failed run consumes nothing), and optionally token-streamed to the browser with the text persisted server-side (reload mid-stream and it continues).
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/app">
        nuxt-backend/app
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/auth-config">
        nuxt-backend/auth.config
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/auth">
        nuxt-backend/auth
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/authorization">
        nuxt-backend/authorization
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/billing">
        nuxt-backend/billing
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/convex-config">
        nuxt-backend/convex.config
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/email">
        nuxt-backend/email
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/eslint">
        nuxt-backend/eslint
      </a>
    </td>
    
    <td>
      The ESLint preset for a <code>
        nuxt-backend
      </code>
      
       app: the official Convex lint rules, scoped to the functions directory, with Convex's generated code ignored.
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/functions">
        nuxt-backend/functions
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/http">
        nuxt-backend/http
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/mcp">
        nuxt-backend/mcp
      </a>
    </td>
    
    <td>
      The agent (MCP) surface's Nitro utilities — <code>
        nuxt-backend/mcp
      </code>
      
      , also auto-imported in <code>
        server/
      </code>
      
      : <a href="https://nuxt-backend.dev/docs/reference/api/mcp#usebackendmcp">
        useBackendMcp
      </a>
      
       for the signed-in agent session behind a tool call, <a href="https://nuxt-backend.dev/docs/reference/api/mcp#definebackendmcptool">
        defineBackendMcpTool
      </a>
      
       for your own tools.
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/migrations">
        nuxt-backend/migrations
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/rate-limit">
        nuxt-backend/rate-limit
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/search">
        nuxt-backend/search
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/workflows">
        nuxt-backend/workflows
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/module">
        nuxt-backend
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-agent-consent">
        useAgentConsent
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-aggregate">
        useAggregate
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-ai-stream">
        useAiStream
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-auth">
        useAuth
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-backend-config">
        useBackendConfig
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-billing">
        useBilling
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-credits">
        useCredits
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-email-change">
        useEmailChange
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-email-status">
        useEmailStatus
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-features">
        useFeatures
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-gifts">
        useGifts
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-login-flow">
        useLoginFlow
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-orders">
        useOrders
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-organization">
        useOrganization
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-passkeys">
        usePasskeys
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-sandbox-inbox">
        useSandboxInbox
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-search">
        useSearch
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-sessions">
        useSessions
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-usage">
        useUsage
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="https://nuxt-backend.dev/docs/reference/api/use-workflow">
        useWorkflowStatus
      </a>
    </td>
    
    <td>
      -
    </td>
  </tr>
</tbody>
</table>


## Sitemap

See the full [sitemap](https://nuxt-backend.dev/sitemap.md) for all pages.
