Skip to main content

Athena Intelligence Python Library

Project description

Athena Intelligence Python Library

fern shield pypi

The Athena Intelligence Python Library provides convenient access to the Athena Intelligence API from applications written in Python.

The library includes type definitions for all request and response fields, and offers both synchronous and asynchronous clients powered by httpx.

Installation

Add this dependency to your project's build file:

pip install athenaintel
# or
poetry add athenaintel

Usage

Simply import Athena and start making calls to our API.

from athena import GeneralAgentConfig, GeneralAgentRequest, InputMessage
from athena.client import Athena

client = Athena(
  api_key="YOUR_API_KEY" # Defaults to ATHENA_API_KEY
)

response = client.agents.general.invoke(
    request=GeneralAgentRequest(
        config=GeneralAgentConfig(enabled_tools=[]),
        messages=[
            InputMessage(
                role="user",
                content="Summarize what Athena Intelligence does in one paragraph.",
            )
        ],
    )
)

print(response.messages[-1].content)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API.

import asyncio

from athena import GeneralAgentConfig, GeneralAgentRequest, InputMessage
from athena.client import AsyncAthena

client = AsyncAthena(
  api_key="YOUR_API_KEY" # Defaults to ATHENA_API_KEY
)

async def main() -> None:
    response = await client.agents.general.invoke(
      request=GeneralAgentRequest(
          config=GeneralAgentConfig(enabled_tools=[]),
          messages=[
              InputMessage(
                  role="user",
                  content="Summarize what Athena Intelligence does in one paragraph.",
              )
          ],
      )
    )
    print("Received message", response)

asyncio.run(main())

Long-running workflows

For long-running AOP executions, start the execution asynchronously and check the thread status with the returned thread ID:

from athena import AopExecuteRequestIn
from athena.client import Athena

client = Athena(api_key="...")

execution = client.aop.execute_async(
    request=AopExecuteRequestIn(
        asset_id="YOUR_AOP_ASSET_ID",
        user_inputs={"company": "Athena Intelligence"},
    )
)

status = client.threads.get_status(execution.thread_id)

Athena Module

All of the models are nested within the Athena module. Let IntelliSense guide you!

Exception Handling

All errors thrown by the SDK will be subclasses of ApiError.

from athena.core import ApiError

try:
  client.users.me()
except ApiError as e: # Handle all API errors
  print(e.status_code)
  print(e.body)

Advanced

Timeouts

By default, requests time out after 60 seconds. You can configure this with a timeout option at the client or request level.

from athena.client import Athena

client = Athena(
    # All timeouts are 20 seconds
    timeout=20.0,
)

# Override timeout for a specific method
client.users.me(request_options={"timeout_in_seconds": 20})

Custom HTTP client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx

from athena.client import Athena

client = Athena(
    http_client=httpx.Client(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Beta Status

This SDK is in Preview, and there may be breaking changes between versions without a major version update.

To ensure a reproducible environment (and minimize risk of breaking changes), we recommend pinning a specific package version.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

athenaintel-0.1.1628.tar.gz (94.9 kB view details)

Uploaded Source

Built Distribution

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

athenaintel-0.1.1628-py3-none-any.whl (191.9 kB view details)

Uploaded Python 3

File details

Details for the file athenaintel-0.1.1628.tar.gz.

File metadata

  • Download URL: athenaintel-0.1.1628.tar.gz
  • Upload date:
  • Size: 94.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for athenaintel-0.1.1628.tar.gz
Algorithm Hash digest
SHA256 c54b0f24f03837b5b9a8fe2236ce31117a1ffe376a5974a3f5b3f1306bf3383d
MD5 b64264b927da33fbeb18a856f2d9de7d
BLAKE2b-256 f3a8383e8185f47dfb3b65bc2a0469a12d37a6c1d43e40c814cc7d2285e331fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for athenaintel-0.1.1628.tar.gz:

Publisher: ci.yml on Athena-Intel/athena-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file athenaintel-0.1.1628-py3-none-any.whl.

File metadata

  • Download URL: athenaintel-0.1.1628-py3-none-any.whl
  • Upload date:
  • Size: 191.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for athenaintel-0.1.1628-py3-none-any.whl
Algorithm Hash digest
SHA256 26c60adf342c979eea45c97c251d45f83b9621d0cffaaaf6d3ba9d96e82abf94
MD5 f165f129e13bb44632a83608bf78c58f
BLAKE2b-256 3c44534cf55c237d43a621f659470c2ee5020a9fd4342393d6c0364afdc0a8f3

See more details on using hashes here.

Provenance

The following attestation bundles were made for athenaintel-0.1.1628-py3-none-any.whl:

Publisher: ci.yml on Athena-Intel/athena-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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