Add currentPath parameter to assistant API#3787
Closed
mintlify-development[bot] wants to merge 1 commit intomainfrom
Closed
Add currentPath parameter to assistant API#3787mintlify-development[bot] wants to merge 1 commit intomainfrom
mintlify-development[bot] wants to merge 1 commit intomainfrom
Conversation
Generated-By: mintlify-agent
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
currentPathparameter documentation to the assistant API endpoints (v1 and v2) in the OpenAPI specThis parameter enables the assistant to understand which documentation page the user is viewing, improving response relevance.
Note
Low Risk
Documentation/OpenAPI-only change that adds an optional request field; no runtime logic is modified.
Overview
Documents a new optional
currentPathstring in thePOST /v1/assistant/{domain}/messageandPOST /v2/assistant/{domain}/messagerequest bodies indiscovery-openapi.json, describing it as the user’s current doc page path (max 200 chars) used for added prompt context.Updates the v1/v2 assistant message MDX guides to include
currentPathin theuseChatexample payloads and lists it under optional configuration.Written by Cursor Bugbot for commit e909ecc. This will update automatically on new commits. Configure here.