Skip to content

docs: add Research API to README summary#9

Merged
tyler5673 merged 1 commit intomainfrom
docs/readme-research-api
Mar 4, 2026
Merged

docs: add Research API to README summary#9
tyler5673 merged 1 commit intomainfrom
docs/readme-research-api

Conversation

@tyler5673
Copy link
Contributor

Summary

  • Adds Research API to the feature list in the README summary section

Note: this section is speakeasy-generated and will be overwritten on the next regen. The OpenAPI spec description should be updated to include Research API so it persists.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
Copy link

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.

@tyler5673 tyler5673 merged commit 03f5e8a into main Mar 4, 2026
6 checks passed
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.

1 participant