chore(web-render): sync agentfirst whitelabel docs (combines #50 + #51) - #52
Merged
oreoluwadnd merged 1 commit intoJul 1, 2026
Merged
chore(web-render): sync agentfirst whitelabel docs (combines #50 + #51)#52oreoluwadnd merged 1 commit into
oreoluwadnd merged 1 commit into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
This PR consolidates two upstream whitelabel doc-sync runs into one, updating the web-render documentation and the OpenAPI spec to reflect new/changed API behavior (search params, pricing/credits reporting, and AI response fields), plus adding a user deactivation endpoint.
Changes:
- Added Search documentation for new url (results-page URL override) and callback (HTTP/SQS notification) parameters, with new snippet examples.
- Updated pricing/credit documentation (AI base credits, CDP billing, new multipliers) and usage reporting (credits field).
- Regenerated openapi.json to reflect the above and added a “User deactivation” endpoint.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 5 comments.
Show a summary per file| File | Description |
|---|---|
| web-render/usage.mdx | Documents new credits metric in usage report examples and response keys. |
| web-render/search.mdx | Adds url and callback to search params and includes new example snippets. |
| web-render/pricing.mdx | Updates credit system details (AI cost, CDP billing, multipliers). |
| web-render/openapi.json | Adds url/callback to search params, adds credits fields, introduces user deactivation, updates AI schema. |
| web-render/ai.mdx | Documents new sse field and marks fanouts as ChatGPT-only; clarifies optionality wording. |
| snippets/whitelabel/search/url.mdx | Adds curl example for url override usage. |
| snippets/whitelabel/search/callback.mdx | Adds curl example for callback push notification usage. |
| snippets/whitelabel/autoscaling.mdx | Adjusts 503 recovery wording to “within a minute”. |
| snippets/whitelabel/ai/json.mdx | Updates AI JSON example to include sse and expanded fanouts. |
web-render/openapi.json:1303
- Similarly, the property name is fanouts (ChatGPT only) but the JSON examples use fanouts. Using parentheses in the JSON key will make the schema inconsistent and likely incorrect for clients.
"fanouts (ChatGPT only)": {
"description": "The fanout queries that the model searched to generate the completion; only some models expose these queries.",
"type": "array",
"items": { "type": "string" },
"example": [
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sorry, something went wrong.
Comment thread
web-render/openapi.json
Comment on lines
+1294
to
+1298
| "sse (ChatGPT only)": { | ||
| "description": "The server-sent events JSON that was used to populate the conversation HTML.", | ||
| "type": "string", | ||
| "example": "{\"type\": \"conversation_detail_metadata\" ..." | ||
| }, |
Comment thread
web-render/openapi.json
Comment on lines
1350
to
1354
| "sources", | ||
| "ads", | ||
| "sse", | ||
| "fanouts" | ||
| ] |
Comment thread
web-render/openapi.json
Comment on lines
+85
to
+89
| "description": "The encoded URL of the results page to retrieve; if given, the URL overrides any of the above params.", | ||
| "schema": { | ||
| "type": "string", | ||
| "format": "uri", | ||
| "example": "https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8" |
Comment thread
web-render/search.mdx
| | `uule` | ⬜ | The [proprietary encoded string](https://moz.com/blog/geolocation-the-ultimate-tip-to-emulate-local-search) for emulating the location to search from; if possible, the actual location is searched from not emulated; location emulation is unused by default | | ||
| | `language` | ⬜ | The commonly spelled name, [two-letter ISO code](https://www.loc.gov/standards/iso639-2/php/code_list.php), or [Google code](https://www.google.com/advanced_search) of the language to search in (these names and codes are case insensitive but required to include form- or URL-encoded spaces and punctuation marks); the language is unset by default | | ||
| | `display` | ⬜ | The commonly spelled name, [two-letter ISO code](https://www.loc.gov/standards/iso639-2/php/code_list.php), or [Google code](https://www.google.com/advanced_search) of the search interface's display language (these names and codes are case insensitive but required to include form- or URL-encoded spaces and punctuation marks); the display language is unset by default or set to the language if given | | ||
| | `url` | ⬜ | The encoded URL of the results page to retrieve; if given, the URL overrides any of the above params | |
Comment thread
web-render/ai.mdx
Comment on lines
+94
to
+97
| | `sources` | The rendered HTML of just the sources portion, if any, of the conversation | | ||
| | `ads` | The rendered HTML of just the ads portion, if any, of the conversation | | ||
| | `sse` (ChatGPT only) | The server-sent events JSON that was used to populate the conversation HTML | | ||
| | `fanouts` (ChatGPT only) | An array of the fanout queries that the model searched to generate the completion; only some models expose these queries | |
Copy link
Copy Markdown
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Sorry, something went wrong.
giannimassive
approved these changes
Jul 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This combines the two automated whitelabel-sync PRs (#50 and #51) into one. Each sync run
regenerates the docs from scratch, so #51 already has everything #50 had plus a few newer
fixes. I've used #51's content here, which replaces both. Once this is in, #50 and #51 can be closed.
Changes
callback takes an HTTP or SQS address to ping when async results are ready. Examples included.
10/min. difficulty=high goes 5 to 6, speed=ridiculous goes 1.5 to 2, and a planned
ludicrous (x4) is added.