Error pages · Nuxt OG Image · Nuxt SEO

[NuxtSEO](https://nuxtseo.com/ "Home")

- [Modules](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Tools](https://nuxtseo.com/tools)
- [Pro](https://nuxtseo.com/pro)
- [Learn SEO](https://nuxtseo.com/learn-seo/nuxt) [Releases](https://nuxtseo.com/releases)

[1.4K](https://github.com/harlan-zw/nuxt-seo)

[Nuxt SEO on GitHub](https://github.com/harlan-zw/nuxt-seo)

You're viewing **OG Image v5** documentation. For the latest, [switch to v6](https://nuxtseo.com/docs/og-image/getting-started/introduction).

[User Guides](https://nuxtseo.com/docs/og-image/v5/getting-started/introduction)

[API](https://nuxtseo.com/docs/og-image/v5/api/define-og-image)

[Releases](https://nuxtseo.com/docs/og-image/v5/releases/v5)

OG Image

- [Switch to OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)
- [Switch to Nuxt SEO](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Switch to Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)
- [Switch to Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)
- [Switch to Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)
- [Switch to Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [Switch to SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [Switch to Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)
- [Switch to Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [Switch to AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

Search…```k`` /`

v5

- Playgrounds
- [Discord Support](https://discord.com/invite/275MBUBvgP)

### Getting Started

- [Introduction](https://nuxtseo.com/docs/og-image/v5/getting-started/introduction)
- [Installation](https://nuxtseo.com/docs/og-image/v5/getting-started/installation)
- [Troubleshooting](https://nuxtseo.com/docs/og-image/v5/getting-started/troubleshooting)
- [Tutorial: Your first OG Image](https://nuxtseo.com/docs/og-image/v5/getting-started/getting-familar-with-nuxt-og-image)

### Core Concepts

- [Satori Renderer](https://nuxtseo.com/docs/og-image/v5/guides/satori)
- [Chromium Renderer](https://nuxtseo.com/docs/og-image/v5/guides/chromium)
- [Zero Runtime](https://nuxtseo.com/docs/og-image/v5/guides/zero-runtime)
- [Compatibility](https://nuxtseo.com/docs/og-image/v5/guides/compatibility)
- [Route Rules](https://nuxtseo.com/docs/og-image/v5/guides/route-rules)
- [Caching Images](https://nuxtseo.com/docs/og-image/v5/guides/cache)
- [JPEGs](https://nuxtseo.com/docs/og-image/v5/guides/jpegs)
- [Fonts](https://nuxtseo.com/docs/og-image/v5/guides/custom-fonts)
- [Non-English Locales](https://nuxtseo.com/docs/og-image/v5/guides/non-english-locales)
- [Emojis](https://nuxtseo.com/docs/og-image/v5/guides/emojis)
- [Icons and Images](https://nuxtseo.com/docs/og-image/v5/guides/icons-and-images)
- [Styling](https://nuxtseo.com/docs/og-image/v5/guides/styling)
- [Community Templates](https://nuxtseo.com/docs/og-image/v5/guides/community-templates)
- [Error pages](https://nuxtseo.com/docs/og-image/v5/guides/error-pages)

### Integrations

- [Nuxt Content](https://nuxtseo.com/docs/og-image/v5/integrations/content)
- [Nuxt Color Mode](https://nuxtseo.com/docs/og-image/v5/integrations/color-mode)

Core Concepts

# Error pages

[Copy for LLMs](https://nuxtseo.com/docs/og-image/v5/guides/error-pages.md)

Nuxt OG Image supports displaying images for pages with a non-200 status code (for example a 404 page). It supports both errors thrown by Nuxt, as well as custom errors created using `setResponseStatus`.

To define an og image for an error page, call `defineOgImageComponent` in the setup script of your `error.vue` file:

error.vue

```
<script lang="ts" setup>
defineOgImageComponent('NuxtSeo')
</script>
```

You can use this, for example, to display a generic OG Image containing the status code and status message by accessing the error provided by Nuxt:

error.vue

```
<script lang="ts" setup>
import type { NuxtError } from '#app'

const props = defineProps<{
  error: NuxtError
}>()

defineOgImageComponent('NuxtSeo', {
  title: error.statusCode.toString(),
  description: error.statusText
})
</script>
```

## [Limitations](#limitations)

Note that displaying OG Images for error pages is only supported for status codes ranging 400 to 499. Pages with status codes >= 500 won't generate an OG Image.

[Edit this page](https://github.com/nuxt-modules/og-image/blob/v5.1.13/docs/content/3.guides/9.error-pages.md)

[Markdown For LLMs](https://nuxtseo.com/docs/og-image/v5/guides/error-pages.md)

Did this page help you?

[Community Templates Community templates that are included with the module, including NuxtSeo.](https://nuxtseo.com/docs/og-image/v5/guides/community-templates) [defineOgImage() Define an og:image for the current page.](https://nuxtseo.com/docs/og-image/v5/api/define-og-image)

[GitHub](https://github.com/harlan-zw/nuxt-seo) [ Discord](https://discord.com/invite/275MBUBvgP)

### [NuxtSEO](https://nuxtseo.com/ "Home")

- [Getting Started](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [MCP](https://nuxtseo.com/docs/nuxt-seo/guides/mcp)

Modules

- [Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)
- [Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)
- [OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)
- [Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)
- [Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)
- [Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

### [NuxtSEO Pro](https://nuxtseo.com/pro "Home")

- [Getting Started](https://nuxtseo.com/pro)
- [Dashboard](https://nuxtseo.com/pro/dashboard)
- [Pro MCP](https://nuxtseo.com/docs/nuxt-seo-pro/mcp/installation)

### [Learn SEO](https://nuxtseo.com/learn-seo "Learn SEO")

Nuxt

- [Mastering Meta](https://nuxtseo.com/learn-seo/nuxt/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/nuxt/controlling-crawlers)
- [Launch & Listen](https://nuxtseo.com/learn-seo/nuxt/launch-and-listen)
- [Routes & Rendering](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering)
- [Staying Secure](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering/security)

Vue

- [Vue SEO Guide](https://nuxtseo.com/learn-seo/vue)
- [Mastering Meta](https://nuxtseo.com/learn-seo/vue/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/vue/controlling-crawlers)
- [SPA SEO](https://nuxtseo.com/learn-seo/vue/spa)
- [SSR Frameworks](https://nuxtseo.com/learn-seo/vue/ssr-frameworks)
- [SEO Checklist](https://nuxtseo.com/learn-seo/checklist)
- [Pre-Launch Warmup](https://nuxtseo.com/learn-seo/pre-launch-warmup)
- [Backlinks & Authority](https://nuxtseo.com/learn-seo/backlinks)

### [Tools](https://nuxtseo.com/tools "SEO Tools")

- [Social Share Debugger](https://nuxtseo.com/tools/social-share-debugger)
- [Robots.txt Generator](https://nuxtseo.com/tools/robots-txt-generator)
- [Meta Tag Checker](https://nuxtseo.com/tools/meta-tag-checker)
- [HTML to Markdown](https://nuxtseo.com/tools/html-to-markdown)
- [XML Sitemap Validator](https://nuxtseo.com/tools/xml-sitemap-validator)
- [Schema.org Validator](https://nuxtseo.com/tools/schema-validator)
- [Keyword Idea Generator](https://nuxtseo.com/tools/keyword-generator)
- [Keyword Research](https://nuxtseo.com/tools/keyword-research)
- [SERP Analyzer](https://nuxtseo.com/tools/serp-analyzer)
- [Domain Rankings](https://nuxtseo.com/tools/domain-rankings)

Copyright © 2023-2026 Harlan Wilton - [MIT License](https://github.com/harlan-zw/nuxt-seo/blob/main/license) · [mdream](https://mdream.dev)