Skip to content

docs: add Research API to README summary #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tyler5673 merged 1 commit into from
Mar 4, 2026
Merged

docs: add Research API to README summary #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Returns the HTML or Markdown of a target webpage
Multi-step reasoning with comprehensive research capabilities
Comprehensive API for You.com services:
- **Agents API**: Execute queries using Express, Advanced, and Custom AI agents
- **Research API**: In-depth, multi-step research with citations and sources

@claude claude Bot Mar 4, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line is inside the `` Speakeasy-generated block and will be overwritten on the next SDK regeneration (e.g., next time the generate-sdk workflow runs against the upstream specs).

The persistent fix is to update the info.description in one of the upstream OpenAPI source specs (listed in .speakeasy/workflow.yaml) — likely openapi_base.yaml — to include the Research API bullet, or to add an overlay action in overlays/python_overlay.yaml:

- target: $["info"]["description"]
  update: "Unified API for Express, Advanced, and Custom Agents from You.com\nGet the best search results from web and news sources\nReturns the HTML or Markdown of a target webpage\nMulti-step reasoning with comprehensive research capabilities\nComprehensive API for You.com services:\n- **Agents API**: Execute queries using Express, Advanced, and Custom AI agents\n- **Research API**: In-depth, multi-step research with citations and sources\n- **Search API**: Get search results from web and news sources\n- **Contents API**: Retrieve and process web page content"

That way .speakeasy/out.openapi.yaml carries the bullet forward, and every future regen preserves it.

The PR description already calls this out — worth tracking it as a follow-up issue if you're intentionally deferring.

- **Search API**: Get search results from web and news sources
- **Contents API**: Retrieve and process web page content
<!-- End Summary [summary] -->
Expand Down
Loading