Skip to main content

The official Python library for the Vizlook API

Project description

Vizlook

The official Vizlook Python SDK.

Install

pip install vizlook

Usage

from vizlook import Vizlook, AsyncVizlook

vizlook = Vizlook(api_key=os.environ.get("VIZLOOK_API_KEY"))

Performs a video search on the Vizlook system.

response = vizlook.search(
    "how to be productive",
    max_results=5,
    start_published_date="2025-08-19T15:01:36.000Z",
    include_transcription=True,
    include_summary=True,
)

print("response with original API field name: ", response.to_dict())
print("response with snake case field name: ", response.to_dict(use_api_field_name=False))
print("get field value with snake case key from pydantic model: ", response.results)

Generates an answer to a query.

response = vizlook.answer("how to be productive", include_transcription=True)

Streams an answer to a query.

stream = vizlook.stream_answer("how to be productive")
answer = ""

for chunk in stream:
    # response with original API key
    chunk_dict = chunk.to_dict()
    chunk_type = chunk_dict.get("type")

    if chunk_type == "answer-chunk":
        answer += chunk_dict.get("data", "")
    if chunk_type == "data-citations":
        print("Citations: ", chunk_dict.get("data").get("citations"))
    if chunk_type == "data-cost":
        print("Cost: ", chunk_dict.get("data").get("dollarCost"))
    if chunk_type == "error":
        print("Error: ", chunk_dict.get("data").get("errorText"))

print("Answer: ", answer)

Retrieves contents of videos based on specified URLs.

response = vizlook.get_video_contents(
    "https://www.youtube.com/watch?v=QdBokRd2ahw",
    crawl_mode="Always",
    include_transcription=True,
    include_summary=True,
)

Documentation

https://docs.vizlook.com

API

https://docs.vizlook.com/documentation/api-reference/search

Contributing

Feel free to submit pull requests. For larger-scale changes, though, it's best to open an issue first so we can deliberate on your plans.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vizlook-0.1.0.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vizlook-0.1.0-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file vizlook-0.1.0.tar.gz.

File metadata

  • Download URL: vizlook-0.1.0.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.11.6 Darwin/23.3.0

File hashes

Hashes for vizlook-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3d75204bd40fdf1bac59d0cabe7962f33b22769e39df2b9a058ad134d8a4876c
MD5 54d1a8fe8160d02d5ff1f0ac3b61160d
BLAKE2b-256 b84b40d68ea62cc0120f286b981875978e55f90335eb2223133f84343c2219b0

See more details on using hashes here.

File details

Details for the file vizlook-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: vizlook-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.11.6 Darwin/23.3.0

File hashes

Hashes for vizlook-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 de9085d16a84aeb998258d5f22e8368ca8a4bdfc05ff76ff9f11b2019bb312d4
MD5 5ac41087ef4be186bdf7c9b7f7544e8f
BLAKE2b-256 0a9019e56a21c9d13f5f7fd43055a071b144c253c858b57bd163a61bba115997

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page