---
title: "API Reference"
description: "Look up the public API surface for nuxt-convex and vue-convex."
canonical_url: "https://nuxt-convex.onmax.me/api-reference"
---
# API Reference

> Look up the public API surface for nuxt-convex and vue-convex.

Use this section for precise lookup: config keys, aliases, composables, components, server helpers and feature entrypoints. In Nuxt, the composables are auto-imported; in Vue, import them from the entrypoint named on each page.

## Composables

Exported from `vue-convex`, and from `#convex` in Nuxt.

- [`useConvexQuery`](https://nuxt-convex.onmax.me/api-reference/use-convex-query)
- [`useConvexQueries`](https://nuxt-convex.onmax.me/api-reference/use-convex-queries)
- [`useConvexMutation`](https://nuxt-convex.onmax.me/api-reference/use-convex-mutation)
- [`useConvexAction`](https://nuxt-convex.onmax.me/api-reference/use-convex-action)
- [`useConvexPaginatedQuery`](https://nuxt-convex.onmax.me/api-reference/use-convex-paginated-query)
- [`useConvexAuth`](https://nuxt-convex.onmax.me/api-reference/use-convex-auth), with `ConvexAuthenticated`, `ConvexUnauthenticated` and `ConvexAuthLoading`
- [`useConvexConnectionState`](https://nuxt-convex.onmax.me/api-reference/use-convex-connection-state)
- [`isConvexError`](https://nuxt-convex.onmax.me/api-reference/is-convex-error)
- [`convexVue`](https://nuxt-convex.onmax.me/api-reference/convex-vue), the Vue plugin

## Advanced entrypoint

Exported from `vue-convex/advanced`, and from `#convex/advanced` in Nuxt.

- [`useConvexController`](https://nuxt-convex.onmax.me/api-reference/use-convex-controller)
- [`useConvexClient`](https://nuxt-convex.onmax.me/api-reference/use-convex-client)
- [`useConvexHttpClient`](https://nuxt-convex.onmax.me/api-reference/use-convex-http-client)

## Storage entrypoint

Exported from `vue-convex/storage`, and from `#convex/storage` in Nuxt with `storage: true`.

- [`useConvexStorage`](https://nuxt-convex.onmax.me/api-reference/use-convex-storage)
- [`useConvexUpload`](https://nuxt-convex.onmax.me/api-reference/use-convex-upload)

## Nuxt only

- [Module configuration](https://nuxt-convex.onmax.me/api-reference/module-configuration)
- [Virtual modules](https://nuxt-convex.onmax.me/api-reference/virtual-modules)
- [Server helpers](https://nuxt-convex.onmax.me/nuxt-module/server-routes): `useConvexServer`, `serverConvexQuery`, `serverConvexMutation`, `serverConvexAction`, `getConvexToken`, `requireConvexAuth`, `toConvexH3Error`, and the `convex:token` hook
- [`ConvexQuery`](https://nuxt-convex.onmax.me/api-reference/convex-query)
- [`ConvexPaginatedQuery`](https://nuxt-convex.onmax.me/api-reference/convex-paginated-query)
- [`useConvexR2Upload`](https://nuxt-convex.onmax.me/api-reference/use-convex-r2-upload)

## How to use this section

- Read the [Nuxt Module](https://nuxt-convex.onmax.me/nuxt-module) guides or the [Vue Guide](https://nuxt-convex.onmax.me/vue-guide) for walkthroughs
- Use this section when you need exact signatures, defaults, or behavior notes


## Sitemap

See the full [sitemap](https://nuxt-convex.onmax.me/sitemap.md) for all pages.
