Skip to main content

General Agents client library

Project description

General Agents Python API client

Release Build status License

Documentation

The REST API documentation: https://docs.generalagents.com/

Installation

General Agents Python API client is available as a python package on PyPI:

pip install generalagents

# or with uv
uv add generalagents

Usage

This client includes both an interface for calling the agent, and a simple computer controller. An example execution loop:

import os

from generalagents import Agent
from generalagents.macos import Computer

agent = Agent(model="ace-small", api_key=os.getenv('GENERALAGENTS_API_KEY'))
computer = Computer()

instruction = "Star the generalagents-python github repository"
session = agent.start(instruction)
observation = computer.observe()

for _ in range(50):  # max actions
    action = session.plan(observation)
    if action.kind == "stop":
        break
    observation = computer.execute(action)

Contributing

See the contributing documentation.

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

generalagents-0.1.0.tar.gz (46.5 kB view details)

Uploaded Source

Built Distribution

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

generalagents-0.1.0-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: generalagents-0.1.0.tar.gz
  • Upload date:
  • Size: 46.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for generalagents-0.1.0.tar.gz
Algorithm Hash digest
SHA256 87f5343dad2f8ddeb17f2d4dfbb95b39b7729a8358fe02c479974f8f6a2f30a5
MD5 93c7bb6449e33e4a679413bb9d9cce16
BLAKE2b-256 48102b29535e12711dff22c6cd79bb6fd2aa6fae0e90266ba30e90e1f51ceec4

See more details on using hashes here.

Provenance

The following attestation bundles were made for generalagents-0.1.0.tar.gz:

Publisher: publish-to-pypi.yml on generalagents/generalagents-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 generalagents-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: generalagents-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for generalagents-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 71f51dc276f806eb67d22a429dd64724fe6257fdfac4fc421f8e11b1b4b7c51f
MD5 16331f6f0bcc74ef45bbcf68305ab1ee
BLAKE2b-256 aae0169a0ed189dbae56b1e1526747af8a0faf70ed5230de024ec5a1abe79637

See more details on using hashes here.

Provenance

The following attestation bundles were made for generalagents-0.1.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on generalagents/generalagents-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