Clients and Endpoint Methods

Public API surface

src/odins_eye/__init__.py re-exports:

• OdinsEyeClient
• AsyncOdinsEyeClient
• RetryConfig
• OdinsEyeError
• OdinsEyeAPIError

Synchronous client (OdinsEyeClient)

Initialization

• api_key: optional, sent as x-api-key when provided
• headers: merged into default headers
• timeout: optional httpx.Timeout
• http2: defaults to True
• retry_config: optional RetryConfig
• enable_logging: enables debug logging

Defaults:

• Accept: application/json
• User-Agent: odins-eye-pypi/<package-version>
• timeout=httpx.Timeout(10.0, connect=5.0)
• Base host fixed to https://api.brookmimir.com

Lifecycle

• Context manager supported via __enter__/__exit__
• Call close() for manual cleanup

Asynchronous client (AsyncOdinsEyeClient)

• Mirrors sync method names and semantics
• Uses httpx.AsyncClient
• Supports async context manager (__aenter__/__aexit__)
• Call aclose() for manual cleanup

Endpoint methods

Method	HTTP Verb	Path	Notes
index()	GET	/	Returns status message
document(doc_id)	GET	/document	Sends bmm-doc-id header
query(query)	POST	/query	Validates with QueryRequest
profile()	GET	/profile	User profile
version()	GET	/version	API version
credits()	GET	/credits	Credit balance / status
face_search(image_path, payload=None)	POST	/face/search	Encodes file to Base64
nettest()	GET	/nettest	Lightweight connectivity check