FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Add image upload support (`/image` API) for Google Lens by adarshdigievo · Pull Request #38 · serpapi/serpapi-python · GitHub

/ serpapi-python Public

Add image upload support (/image API) for Google Lens - #38

Merged
adarshdigievo merged 2 commits into
masterfrom
feat/image-upload
Aug 14, 2026
ConversationCommits (2)ChecksFiles changed
Merged

Add image upload support (/image API) for Google Lens#38
adarshdigievo merged 2 commits into
masterfrom
feat/image-upload

Conversation

adarshdigievo commented Aug 7, 2026

Copy link
Copy Markdown
Member

Summary

This PR adds image-upload support for Google Lens, using the new /image POST endpoint.

Changes

  • Added serpapi.upload_image(image, **kwargs).
  • Uploads images with multipart POST /image using:
    • image as the file field.
    • api_key and any additional supplied arguments as form data.
  • The image argument supports:
    • String filesystem paths
    • os.PathLike/pathlib.Path
    • Open binary files
    • BytesIO
      This means users can pass an image path or an open image binary file to upload_image()
  • Added README examples for both Lens workflows:
    • client.search(engine="google_lens", url=...)
    • upload_image(...) followed by client.search(..., image_id=...)

Live Tests

Image uploads were verified using the live tests below:

Usage Code Search ID Result
Public URL results = client.search(engine="google_lens", url="https://raw.githubusercontent.com/serpapi/serpapi-python/master/docs/_static/serpapi-python.png") 6a756f57ad9ecfd6f1ff2edc JSON result
String path upload = client.upload_image(IMAGE_PATH); results = client.search(engine="google_lens", image_id=upload["image_id"]) 6a756f5a55cfe1c665a6b616 JSON result
pathlib.Path image = Path(IMAGE_PATH); upload = client.upload_image(image); results = client.search(engine="google_lens", image_id=upload["image_id"]) 6a756f5d4c437f4d4996fb65 JSON result
Open binary file with open(IMAGE_PATH, "rb") as image: upload = client.upload_image(image); results = client.search(engine="google_lens", image_id=upload["image_id"]) 6a756f60f0114a9bff17f8d0 JSON result
BytesIO image = BytesIO(Path(IMAGE_PATH).read_bytes()); upload = client.upload_image(image); results = client.search(engine="google_lens", image_id=upload["image_id"]) 6a756f63bb48ad0e678bc1b7 JSON result

adarshdigievo requested a lite review from Copilot August 7, 2026 05:59
Copilot AI reviewed Aug 7, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Pull request overview

Adds first-class image upload support to serpapi-python for Google Lens workflows via SerpApi’s /image POST endpoint, enabling users to upload local images and then perform Lens searches using the returned image_id.

Changes:

  • Added Client.upload_image(image, **kwargs) (and module-level serpapi.upload_image) to upload images as multipart form data.
  • Updated HTTP API-key injection logic to avoid injecting into query params when api_key is already provided in form data.
  • Added unit tests and documentation/examples covering URL-based Lens search and upload-then-search workflows.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tests/test_image_upload.py Adds unit coverage for multipart upload behavior, input types, and Google Lens URL vs image_id usage.
serpapi/http.py Adjusts API-key injection to support endpoints that authenticate via form data.
serpapi/core.py Implements Client.upload_image(...) and exposes module-level upload_image.
README.md Documents Google Lens usage via URL and via uploaded image_id.
docs/index.rst Exposes upload_image in Sphinx API reference for both module function and Client method.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

adarshdigievo requested review from ilyazub and jvmvik August 7, 2026 06:06
tanysheng requested changes Aug 10, 2026
View reviewed changes

tanysheng left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thank you @adarshdigievo 👍, mostly looks good!

Comment thread tests/test_image_upload.py Outdated
Comment on lines +89 to +108
def test_google_lens_search_supports_url_and_uploaded_image_id():
client = serpapi.Client(api_key="test-api-key")
client.session.request = Mock(
side_effect=[
json_response(b'{"image_id": "uploaded-image-123"}'),
json_response(b'{"search_metadata": {"status": "Success"}}'),
json_response(b'{"search_metadata": {"status": "Success"}}'),
]
)

upload = client.upload_image(BytesIO(b"fake-image-data"))
client.search(engine="google_lens", image_id=upload["image_id"])
client.search(engine="google_lens", url="https://example.com/image.png")

upload_search = client.session.request.call_args_list[1][1]["params"]
url_search = client.session.request.call_args_list[2][1]["params"]
assert upload_search["image_id"] == "uploaded-image-123"
assert "url" not in upload_search
assert url_search["url"] == "https://example.com/image.png"
assert "image_id" not in url_search

tanysheng Aug 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Don't think this tests much. It just asserts the params we passed in, which is self-fulfilling. I think we can remove it.

adarshdigievo Aug 10, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@tanysheng Thanks for the review. I removed the test.

tanysheng approved these changes Aug 13, 2026
View reviewed changes

tanysheng left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thank you @adarshdigievo! LGTM 👍

adarshdigievo merged commit 586978e into master Aug 14, 2026
6 of 7 checks passed
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
tanysheng tanysheng approved these changes
ilyazub Awaiting requested review from ilyazub
jvmvik Awaiting requested review from jvmvik

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL