Skip to content

Add currentPath parameter to assistant API#3787

Closed
mintlify-development[bot] wants to merge 1 commit intomainfrom
add-currentpath-param-1772056843
Closed

Add currentPath parameter to assistant API#3787
mintlify-development[bot] wants to merge 1 commit intomainfrom
add-currentpath-param-1772056843

Conversation

@mintlify-development
Copy link
Contributor

@mintlify-development mintlify-development bot commented Feb 25, 2026

Summary

  • Added currentPath parameter documentation to the assistant API endpoints (v1 and v2) in the OpenAPI spec
  • Updated code examples in the assistant message API pages to demonstrate usage
  • The parameter allows passing the current page path to provide context-aware responses

This 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 currentPath string in the POST /v1/assistant/{domain}/message and POST /v2/assistant/{domain}/message request bodies in discovery-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 currentPath in the useChat example payloads and lists it under optional configuration.

Written by Cursor Bugbot for commit e909ecc. This will update automatically on new commits. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants