Update from code changes: document Deep Research API#1006
Open
mintlify[bot] wants to merge 3 commits into
Open
Update from code changes: document Deep Research API#1006mintlify[bot] wants to merge 3 commits into
mintlify[bot] wants to merge 3 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
🤖 Documentation Bot✅ All checks passed! No issues found. |
Contributor
Author
|
Update from code changes updated this PR. Updated the Deep Research page for markdown reports with chart snapshots, thread linking, list-by-thread, and live-refresh endpoints. Source PRs
|
Contributor
🤖 Documentation Bot✅ All checks passed! No issues found. |
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
1 participant
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
Adds a Deep Research reference page under the AI guides, covering the durable background investigation API, its lifecycle, effort tiers, permissions, credential handling, markdown report shape with chart snapshots, and a full start-poll-report example.
Changes
guides/ai-agents/deep-research.mdx— new page describing what Deep Research is, when to use it, the four effort tiers and their budgets, permissions (create:AiDeepResearchscope, Developer/Admin only), credential lifecycle, the markdown report outline with warehouse and inline chart snapshots, all API endpoints (start with optional thread/prompt linkage, read, list by thread, events with cursor pagination, cancel, per-chart live refresh), and a bash example.guides/ai-overview.mdx— mention Deep Research in the capabilities-at-a-glance and "if you want to…" tables.docs.json— add the new page to the AI agents nav group.Context
Reflects the new Deep Research API from these upstream PRs:
Update history
threadUuid/promptUuidlinkage on run start, added theGET .../ai-deep-research?threadUuid=list-by-thread endpoint, added thePOST .../charts/{chartKey}/refreshlive-refresh endpoint, and updated the example to printresultMarkdown(covers feat(ai): additive viz renderer and query-results plumbing for deep research lightdash#25730, #25731, #25732, #25734, #25754).