Skip to content

Updated 404 documentation with new error response body structure #1207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Updated 404 documentation with new error response body structure #1207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b2ed90
Update settings/custom-404-page.mdx
mintlify[bot] Sep 18, 2025
9078790
Update docs.json
mintlify[bot] Sep 18, 2025
c0008a6
Update docs.json
mintlify[bot] Sep 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@
"pages",
"navigation",
"themes",
"settings/custom-domain"
"settings/custom-domain",
"settings/custom-404-page"
]
},
{
Expand Down Expand Up @@ -151,7 +152,6 @@
"guides/changelogs",
"guides/hidden-pages",
"settings/broken-links",
"settings/custom-404-page",
"guides/monorepo",
{
"group": "Custom Subdirectory",
Expand Down
19 changes: 19 additions & 0 deletions settings/custom-404-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,22 @@
<ResponseField name="description" type="string">
Custom description for the 404 error page. Supports Markdown formatting.
</ResponseField>

## API Error Response

When a 404 error occurs in API requests, the response now includes additional error details in the response body:

```json
{
"errorType": "",

Check warning on line 49 in settings/custom-404-page.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/custom-404-page.mdx#L49 

Did you really mean 'errorType'?
"errorMessage": ""

Check warning on line 50 in settings/custom-404-page.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/custom-404-page.mdx#L50 

Did you really mean 'errorMessage'?
}
```

<ResponseField name="errorType" type="string">
The type of error that occurred. This field helps categorize the specific kind of 404 error.
</ResponseField>

<ResponseField name="errorMessage" type="string">
A descriptive message explaining the error. This provides more context about why the resource was not found.
</ResponseField>