mirror of
https://github.com/hanzoai/next.js.git
synced 2026-09-24 17:00:51 +00:00
6f4352993d
## Description Unify the note format according to the [contribution guide](https://nextjs.org/docs/community/contribution-guide#notes). In addition, add missing bullet points to useful links. ### Improving Documentation - [x] Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - [x] Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide --------- Co-authored-by: Delba de Oliveira <[email protected]>
33 lines
1.4 KiB
Plaintext
33 lines
1.4 KiB
Plaintext
---
|
|
title: Addressing "API Routes Response Size Limited to 4MB" Error in Next.js
|
|
description: This document explains the "API Routes Response Size Limited to 4MB" error in Next.js and guides developers on how to modify response size limits.
|
|
---
|
|
|
|
## Why This Error Occurred
|
|
|
|
The "API Routes Response Size Limited to 4MB" error arises when your API Route is trying to send a response larger than the allowed size of `4MB`. API Routes in Next.js are designed to deliver quick responses and are not built to support the transmission of large amounts of data.
|
|
|
|
## Possible Ways to Fix It
|
|
|
|
If you are not utilizing Next.js in a serverless environment, and you're fully aware of the performance implications, you can disable this limit in your API Route. Here is how you can set `responseLimit` to `false`:
|
|
|
|
```js filename="pages/api/example.js"
|
|
export const config = {
|
|
api: {
|
|
responseLimit: false,
|
|
},
|
|
}
|
|
```
|
|
|
|
Alternatively, `responseLimit` can also accept a numeric value (in bytes) or any string format supported by the `bytes` module. This can be a value like `1000`, `'500kb'`, or `'3mb'`. This value will set the maximum response size before a warning is displayed. For example, to set the limit to 8MB:
|
|
|
|
```js filename="pages/api/example.js"
|
|
export const config = {
|
|
api: {
|
|
responseLimit: '8mb',
|
|
},
|
|
}
|
|
```
|
|
|
|
> **Note**: Increasing the response limit can have significant impacts on performance and should only be done after careful consideration.
|