diff --git a/api-playground/overview.mdx b/api-playground/overview.mdx
index 3d62b9c24..81eaca2ac 100644
--- a/api-playground/overview.mdx
+++ b/api-playground/overview.mdx
@@ -101,6 +101,9 @@ You can customize your API playground by defining the following properties in yo
Whether to show optional parameters in API examples. Defaults to `all`.
+
+ Whether to prefill the API playground with data from schema examples. When enabled, the playground automatically populates request fields with example values from your OpenAPI specification. Defaults to `false`.
+
@@ -114,13 +117,14 @@ You can customize your API playground by defining the following properties in yo
},
"examples": {
"languages": ["curl", "python", "javascript"],
- "defaults": "required"
+ "defaults": "required",
+ "prefill": true
}
}
}
```
-This example configures the API playground to be interactive with example code snippets for cURL, Python, and JavaScript. Only required parameters are shown in the code snippets.
+This example configures the API playground to be interactive with example code snippets for cURL, Python, and JavaScript. Only required parameters are shown in the code snippets, and the playground prefills the request body with example values.
### Custom endpoint pages
diff --git a/organize/settings.mdx b/organize/settings.mdx
index 87fc5435d..ca5022cad 100644
--- a/organize/settings.mdx
+++ b/organize/settings.mdx
@@ -669,6 +669,9 @@ See [Themes](themes) for more information.
Whether to show optional parameters in API examples. Defaults to `all`.
+
+ Whether to prefill the API playground with data from schema examples. When enabled, the playground automatically populates request fields with example values from your OpenAPI specification. Defaults to `false`.
+