Document context parameter for assistant API #2416
Merged
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.
Added documentation for the new optional
contextparameter in the assistant message API. This parameter allows passing code snippets or text selections to provide additional context to the assistant.Files changed
api/assistant/create-assistant-message.mdx- Added example usage and documentation for thecontextparameterGenerated from feat: add context payloads to assistant messages @dks333
Note
Adds docs and example for an optional
contextpayload (code/text selections) in the assistant message APIuseChatintegration.api/assistant/create-assistant-message.mdx):body.contexttouseChatconfiguration with a code snippet example (type,value,elementId).body.contextstructure and supported types (code,textSelection) and optionalelementId.Written by Cursor Bugbot for commit 070119f. This will update automatically on new commits. Configure here.