Skip to content

Document v1 Search and Ask - #16

Merged
robbalian merged 3 commits into
mainfrom
agent/v1-search-ask-docs
Jul 27, 2026
Merged

Document v1 Search and Ask#16
robbalian merged 3 commits into
mainfrom
agent/v1-search-ask-docs

Conversation

@robbalian

@robbalianrobbalian commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

What changed

  • Adds a launch-ready Search and Ask guide with curl, Python, and JavaScript examples.
  • Documents the simple authenticated routes: POST /v1/search and POST /v1/ask.
  • Resolves organization context from the API key, with no organization slug in the URL.
  • Adds a standalone OpenAPI description and the guide to the v1 navigation.
  • Documents normalized result fields, errors, and $5 per 1,000 request pricing with no token surcharge.

Why

Customers building agents need a copy/paste path from first request to either raw retrieval or a fast grounded answer. Authentication already identifies their organization, so the public contract should stay minimal.

Validation

  • JSON parsing, navigation, internal-link, placeholder, and diff checks pass.
  • Redocly validates the OpenAPI document.
  • Mintlify preview deploys successfully.

@claude

claudeBot commented Jul 26, 2026

Copy link
Copy Markdown

Claude encountered an error —— View job


I'll analyze this and get back to you.

@mintlify

mintlifyBot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

ProjectStatusPreviewUpdated (UTC)
syncupai🟢 ReadyView PreviewJul 26, 2026, 2:35 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlifyBot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

ProjectStatusPreviewUpdated (UTC)
syncupai🟡 BuildingJul 26, 2026, 2:35 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@claude

claudeBot commented Jul 26, 2026

Copy link
Copy Markdown

Claude encountered an error —— View job


I'll analyze this and get back to you.

@claude

claudeBot commented Jul 27, 2026

Copy link
Copy Markdown

Claude encountered an error —— View job


I'll analyze this and get back to you.

@robbalian
robbalian marked this pull request as ready for review July 27, 2026 20:31
@robbalian
robbalian merged commit 47c026f into mainJul 27, 2026
1 of 2 checks passed
@robbalian
robbalian deleted the agent/v1-search-ask-docs branch July 27, 2026 20:31
Sign up for freeto 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.

1 participant

@robbalian