Skip to content

Conversation

@mfine15
Copy link

@mfine15 mfine15 commented Jan 23, 2026

Summary

Fixes the "Simple search and contents" curl example for the /search endpoint. The example was using "text": true at the top level, which is silently ignored by the API. The text parameter must be wrapped in a contents object.

Before (broken):

{"query": "...", "text": true}

After (working):

{"query": "...", "contents": {"text": true}}

The Python and JavaScript SDK examples work correctly because the SDKs handle this transformation internally.

Review & Testing Checklist for Human

  • Test the curl example against the API and verify it now returns text content in results
  • Confirm the contents wrapper is the correct structure per API implementation

Notes

Part of a docs audit finding behavior mismatches between documentation and actual API behavior. Other issues being addressed in separate PRs.

Link to Devin run: https://app.devin.ai/sessions/616457e78aea475481e0607e4f176b40
Requested by: Michael Fine (@mfine15), PRs requested by Ishan Goswami

The curl example for 'Simple search and contents' was using 'text: true' at the
top level, which is silently ignored by the API. The text parameter must be
wrapped in a 'contents' object for the /search endpoint.

Co-Authored-By: Michael Fine <[email protected]>
@devin-ai-integration
Copy link

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

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.

2 participants