Skip to main content

Python SDK for Aegis Research API - AI-powered web research as a service

Project description

Aegis Research SDK

Python SDK for the Aegis Research API - AI-powered web research as a service.

Installation

pip install aegis-research

Quick Start

from aegis_research import AegisResearch

# Initialize client
client = AegisResearch(api_key="res_your_api_key")

# Execute research
result = client.research("Best practices for API rate limiting in 2025")

print(result.summary)
for finding in result.key_findings:
    print(f"- {finding}")

Features

  • AI-Powered Research: Get synthesized research results, not just search links
  • Multiple Depth Levels: Choose shallow (1 credit), medium (3 credits), or deep (10 credits) research
  • Caching: Results cached for 24 hours to save credits
  • Source Citations: Every claim backed by sources

Usage

Research

# Basic research
result = client.research("What is quantum computing?")

# Deep research with more sources
result = client.research(
    "Impact of AI on healthcare in 2025",
    depth="deep",  # 10 credits, 10+ sources
    use_cache=False  # Force fresh research
)

# Include specific URLs
result = client.research(
    "Compare FastAPI vs Flask",
    urls=["https://fastapi.tiangolo.com", "https://flask.palletsprojects.com"]
)

Check Credits

status = client.credits()
print(f"Credits remaining: {status.credits_remaining}")
print(f"Tier: {status.tier}")

Research History

history = client.history(limit=10)
for item in history:
    print(f"{item['id']}: {item['topic']}")

Get Previous Result

result = client.get_research("res_abc123")

Response Format

ResearchResult:
    id: str                     # "res_abc123"
    topic: str                  # Original query
    status: str                 # "completed", "cached", "failed"
    summary: str                # Executive summary (2-3 sentences)
    key_findings: List[str]     # Main findings as bullet points
    detailed_analysis: str      # Full analysis
    sources: List[Source]       # Cited sources
    source_count: int           # Number of sources
    depth: str                  # "shallow", "medium", "deep"
    cached: bool                # Whether result was cached
    credits_used: int           # Credits consumed
    duration_ms: int            # Time taken

Depth Levels

Depth Credits Sources Time Use Case
shallow 1 3 ~2 min Quick facts, verification
medium 3 5-7 ~5 min General research, decisions
deep 10 10+ ~15 min Comprehensive investigation

Error Handling

from aegis_research import (
    AegisError,
    AuthenticationError,
    RateLimitError,
    InsufficientCreditsError,
)

try:
    result = client.research("topic")
except AuthenticationError:
    print("Invalid API key")
except RateLimitError as e:
    print(f"Rate limited: {e}")
except InsufficientCreditsError:
    print("Not enough credits")
except AegisError as e:
    print(f"API error: {e}")

Pricing

Tier Price Credits/Month Rate Limit
Free $0 50 5/min
Starter $9/mo 500 20/min
Pro $49/mo 5,000 60/min

Get your API key at aegis.rbnk.uk/research

License

MIT

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

aegis_research-0.1.0.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

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

aegis_research-0.1.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aegis_research-0.1.0.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for aegis_research-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5cf160739332fabcb6201ce96a821f36328d951e42b09000014296a701f7cb35
MD5 9c0f1f71eb04c7871992a20b9bd7a08c
BLAKE2b-256 8a88b231712e9fe4e566db351e3cee30b74ef0cacace7f46c4b11f76f27de785

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aegis_research-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for aegis_research-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6684b3d2f831db2861e388733ae7bb3f53da7df296d155a2f7009e4626ae9df0
MD5 e02f2b5ef2432f1b11cf6b381505f9d1
BLAKE2b-256 5dc183abbb7322fe6f7b61afc70d7cff413a6a149ffe675f56e4a708bca4e2ac

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