AI Search API Python Client

A Python client library for the AI Search API that provides semantic search, contextual awareness, and intelligent AI-powered results.
This package makes it easy for developers to integrate the AI Search API into Python projects.

👉 To start, get your free API key from the AI Search API dashboard.

Features

• 🔍 AI-Powered Semantic Search: Natural language search powered by embeddings
• 🎯 Context Awareness: Include history for smarter results
• ⚡ Simple API Client: Clean Python interface with error handling
• 🛡️ Type Safety: Strong type hints
• 🔄 Flexible Output: Get text or markdown results
• 💰 Usage Tracking: Monitor your API credit balance anytime

Installation

Install from PyPI:

pip install aisearchapi-client

Or install from source:

git clone https://github.com/aisearchapi/aisearchapi-python.git
cd aisearchapi-python
pip install -e .

Quick Start

Get Your API Key

1. Sign up at aisearchapi.io.
2. Log in to the dashboard.
3. Copy your API key.

Use this key when creating a client:

from aisearchapi_client import AISearchAPIClient

client = AISearchAPIClient(api_key="your-api-key-here")

Basic Usage Example

from aisearchapi_client import AISearchAPIClient

client = AISearchAPIClient(api_key="your-api-key-here")

result = client.search(
    prompt="What is machine learning and how does it work?",
    response_type="markdown"
)

print("Answer:", result.answer)
print("Sources:", result.sources)
print(f"Total time: {result.total_time}ms")

balance = client.balance()
print(f"Available credits: {balance.available_credits}")
client.close()

Advanced Usage

Contextual Search

from aisearchapi_client import AISearchAPIClient, ChatMessage

with AISearchAPIClient(api_key="your-api-key-here") as client:
    result = client.search(
        prompt="What are the main advantages and disadvantages?",
        context=[
            ChatMessage(role="user", content="I am researching solar energy for my home"),
            ChatMessage(role="user", content="I live in a sunny climate with high electricity costs")
        ],
        response_type="text"
    )
    print("Contextual Answer:", result.answer)

Custom Configuration

client = AISearchAPIClient(
    api_key="your-api-key-here",
    base_url="https://api.aisearchapi.io",
    timeout=60
)

API Reference

Full API reference is available in the official documentation.

Error Handling

from aisearchapi_client import AISearchAPIClient, AISearchAPIError

try:
    with AISearchAPIClient(api_key="your-api-key") as client:
        result = client.search(prompt="Your query")
        print(result.answer)
except AISearchAPIError as e:
    print(f"API Error [{e.status_code}]: {e.description}")

Environment Variables

export AI_SEARCH_API_KEY="your-api-key-here"

Then use in Python:

import os
from aisearchapi_client import AISearchAPIClient

api_key = os.getenv("AI_SEARCH_API_KEY")
client = AISearchAPIClient(api_key=api_key)

Development

git clone https://github.com/aisearchapi/aisearchapi-python.git
cd aisearchapi-python
python -m venv venv
source venv/bin/activate
pip install -e ".[dev,test]"
pytest

License

MIT License - see the LICENSE file.

Support

• Get API Key: AI Search API Dashboard
• Documentation: docs.aisearchapi.io
• Homepage: aisearchapi.io
• Issues: GitHub Issues