Quickstart

pip install --upgrade openperplex

from openperplex import OpenperplexSync

api_key = "your_api_key"
client_sync = OpenperplexSync(api_key)

from openperplex import OpenperplexAsync

api_key = "your_api_key"
client_async = OpenperplexAsync(api_key)

result = client_sync.search(
    query="What are the latest developments in AI?",
    model="o3-mini-high",
    date_context="2024-08-25",
    location="us",
    response_language="en",
    answer_type="text",
    search_type="general",
    return_citations=False,
    return_sources=False,
    return_images=False,
    recency_filter="anytime"
)

print(result)

# Streaming search
for chunk in client_sync.search_stream(
    query="Explain quantum computing",
    model="o3-mini-high",
    date_context="2024-08-25",
    location="us",    
    response_language="en",
    answer_type="text",
    search_type="general",
    return_citations=False,
    return_sources=False,
    return_images=False,
    recency_filter="anytime"
):
    print(result)

import asyncio

async def search_async():
    # Non-streaming search
    result = await client_async.search(
        query="What are the latest developments in AI?",
        model='o3-mini-high',
        date_context="2024-08-25",
        location="us",
        response_language="en",
        answer_type="text",
        search_type="general",
        return_citations=False,
        return_sources=False,
        return_images=False,
        recency_filter="anytime"
    )
    print(result)

    # Streaming search
    async for chunk in client_async.search_stream(
        query="Explain quantum computing",
        model='o3-mini-high',
        date_context="2024-08-25",
        location="us",
        response_language="en",
        answer_type="text",
        search_type="general",
        return_citations=False,
        return_sources=False,
        return_images=False,
        recency_filter="anytime"
    ):
        print(chunk)

asyncio.run(search_async())

# Non-streaming custom search
result = client_sync.custom_search(
    system_prompt="You are a helpful assistant.",
    user_prompt="Explain the theory of relativity",
    model='o3-mini-high',
    location="us",
    search_type="general",
    return_images=False,
    return_sources=False,
    temperature=0.2,
    top_p=0.9,
    recency_filter="anytime"
)
print(result)

# Streaming custom search
for chunk in client_sync.custom_search_stream(
    system_prompt="You are a helpful assistant.",
    user_prompt="Explain the theory of relativity",
    model='o3-mini-high',
    location="us",
    search_type="general",
    return_images=False,
    return_sources=False,
    temperature=0.2,
    top_p=0.9,
    recency_filter="anytime"
):
    print(chunk)

#sync
result = client_sync.get_website_text("https://www.example.com")
print("TEXT : ",result.get("text"))


#async
result = await client_async.get_website_text("https://www.example.com")
print("TEXT : ",result.get("text"))

#sync
result = client_sync.get_website_markdown("https://www.example.com")
print(result.markdown)

#async
result = await client_async.get_website_markdown("https://www.example.com")
print(result.markdown)

#sync
result = client_sync.get_website_screenshot("https://www.example.com")
print(f"Screenshot available at: {result['url']}")

#async
result = await client_async.get_website_screenshot("https://www.example.com")
print(f"Screenshot available at: {result['url']}")

#sync
response = client_sync.query_from_url(
    url="https://www.example.com/article",
    query="What is the main topic of this article?",
    model='o3-mini-high',
    response_language="it",
    answer_type="text", # default is "text" if not specified

)
print(response)

#async
response = await client_async.query_from_url(
    url="https://www.example.com/article",
    query="What is the main topic of this article?",
    model='o3-mini-high',
    response_language="it",
    answer_type="text" # default is "text" if not specified
)
print(response)