Skip to main content

Core components for agent based systems

Project description

uAgents-Core

Core definitions and functionalities for building agents that interact with the Fetch.ai ecosystem and Agentverse marketplace.

Installation

pip install uagents-core

Quick Start

Register a Chat Agent with Agentverse

from uagents_core.utils.registration import (
    AgentverseRequestError,
    RegistrationRequestCredentials,
    register_chat_agent,
)

credentials = RegistrationRequestCredentials(
    agent_seed_phrase="my-agent-seed-phrase",
    agentverse_api_key="your-agentverse-api-key",
)

try:
    register_chat_agent(
        name="My Agent",
        endpoint="https://your-agent-endpoint.com/webhook",
        active=True,
        credentials=credentials,
        readme="# My Agent\nHandles customer questions.",
        metadata={
            "categories": ["support"],
            "is_public": "True",
        },
    )
    print("Agent registered successfully!")
except AgentverseRequestError as error:
    print(f"Registration failed: {error}")
    # Access the underlying HTTP/network exception:
    print(f"Caused by: {error.from_exc}")

Key Features

Permanent Registration

Registrations via the v2 API are permanent - no need for periodic refresh:

  • Agentverse handles Almanac synchronization automatically
  • No 48-hour expiration like v1
  • Register once when agent is created

Agent Identity

Create and manage agent identities:

from uagents_core.identity import Identity

# Create from seed (deterministic)
identity = Identity.from_seed("my-seed-phrase", 0)

# Get agent address
print(identity.address)  # agent1q...

# Sign messages
signature = identity.sign(b"message")

Configuration

from uagents_core.config import AgentverseConfig

config = AgentverseConfig()
print(config.agents_api)    # https://agentverse.ai/v2/agents
print(config.identity_api)  # https://agentverse.ai/v2/identity
print(config.almanac_api)   # https://agentverse.ai/v1/almanac

Available Functions

Registration

Function Error Behavior Purpose
register_chat_agent() Raises AgentverseRequestError Register a chat agent (recommended)
register_agent() Raises AgentverseRequestError Register with custom protocols
register_in_agentverse() Returns False on failure Low-level registration (error-safe)
update_agent_status() Returns False on failure Update agent active/inactive status
register_batch_in_agentverse() Returns False on failure Batch registration (deprecated)

Important: register_chat_agent() and register_agent() raise AgentverseRequestError on failure. Always wrap calls in a try/except block to handle network errors, authentication failures, and server errors gracefully.

Error Handling

All HTTP and network errors are wrapped in AgentverseRequestError, which provides:

  • A human-readable error message (e.g., "HTTP error: 401 Unauthorized")
  • The original exception via the from_exc attribute for inspection
from uagents_core.utils.registration import AgentverseRequestError

try:
    register_chat_agent(...)
except AgentverseRequestError as error:
    print(f"What went wrong: {error}")
    print(f"Original exception: {error.from_exc}")

    # Common failure patterns:
    # - "Connection error ..."     → Network/DNS issue
    # - "Operation timed out."     → Request exceeded 10s timeout
    # - "HTTP error: 401 ..."      → Invalid or expired API key
    # - "HTTP error: 409 ..."      → Agent address already claimed
    # - "Unexpected server error." → HTTP 500, retry after delay

Models

Model Purpose
RegistrationRequestCredentials API key and agent seed phrase
AgentverseRegistrationRequest Full agent registration data
AgentverseRequestError Registration failure exception
RegistrationRequest Agent registration data (internal)
AgentProfile Agent profile (description, readme, avatar)
AgentverseConnectRequest Connection credentials (internal)
Identity Agent identity and signing

av CLI

After install, the av command is available for inspecting and troubleshooting Agentverse agents (same as python -m uagents_core.agentverse).

Command Purpose
av agent <identifier> Troubleshooting: address resolution, almanac vs marketplace checks, and optional connectivity. <identifier> is a bech32 address, handle, or domain. Use -p / --show-profile, --all, or --raw to also print JSON (merged Profile, or full records with --raw).
av resolve <identifier> Resolve an identifier to an agent address and show registration details.

Common flags (av agent): --all enables profile JSON, full readme, and endpoint checks; --raw prints full almanac and marketplace records instead of the merged profile; -p, -r, and -c toggle profile output, full readme, and connectivity individually.

av agent agent1q...
av agent agent1q... -p -r
av agent agent1q... --all --raw
av resolve agent1q...
av resolve my-agent-handle

Upgrading

See UPGRADING.md for migration guides between versions.

Related Packages

  • uagents - Full agent framework with decorators and runtime
  • uagents-adapter - Adapters for LangChain, CrewAI, MCP

License

Apache 2.0 - See LICENSE for details.

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

uagents_core-0.4.5a3.tar.gz (42.5 kB view details)

Uploaded Source

Built Distribution

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

uagents_core-0.4.5a3-py3-none-any.whl (56.3 kB view details)

Uploaded Python 3

File details

Details for the file uagents_core-0.4.5a3.tar.gz.

File metadata

  • Download URL: uagents_core-0.4.5a3.tar.gz
  • Upload date:
  • Size: 42.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.4 CPython/3.11.15 Linux/6.17.0-1010-azure

File hashes

Hashes for uagents_core-0.4.5a3.tar.gz
Algorithm Hash digest
SHA256 827e48a8f7a267fa396ad8d534b3d240e7e02ac671a4bc7ced5855573105be91
MD5 462889c6eafc81034dfe75e21bf7948a
BLAKE2b-256 1c9ba261cce52195388fc7bb6591150c52f0ee38dd5e5bb64c57b61c2c3312a9

See more details on using hashes here.

File details

Details for the file uagents_core-0.4.5a3-py3-none-any.whl.

File metadata

  • Download URL: uagents_core-0.4.5a3-py3-none-any.whl
  • Upload date:
  • Size: 56.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.4 CPython/3.11.15 Linux/6.17.0-1010-azure

File hashes

Hashes for uagents_core-0.4.5a3-py3-none-any.whl
Algorithm Hash digest
SHA256 501e6898f126c30d357549287fddab48a2b08c76873e32cdc6b24a8b3e202ec6
MD5 14da54566f5f13aa9debee7997a04730
BLAKE2b-256 b826aa2fb6475cdabc1346f81289ed08c550ec0feb559cbaffff5be4f928ad37

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