Python client for the AgentScore APIs
Project description
agentscore-py
Python client for the AgentScore APIs.
Install
pip install agentscore-py
Quick Start
from agentscore import AgentScore
client = AgentScore(api_key="as_live_...")
# Look up cached reputation (free)
rep = client.get_reputation("0x1234...")
print(rep["score"]["value"], rep["score"]["grade"])
# Filter to a specific chain
base_rep = client.get_reputation("0x1234...", chain="base")
# Identity gate with policy (paid)
gated = client.assess("0x1234...", policy={
"require_kyc": True,
"require_sanctions_clear": True,
"min_age": 21,
})
if gated["decision"] == "deny":
print(gated["decision_reasons"]) # ["kyc_required"]
print(gated.get("verify_url")) # URL for operator verification
# Check verification level
rep = client.get_reputation("0x1234...")
print(rep.get("verification_level")) # "none" | "wallet_claimed" | "kyc_verified"
Credential-Based Identity
Agents without wallets can use operator credentials for identity:
result = client.assess(operator_token="opc_...")
print(result["decision"]) # "allow" | "deny"
Verification Sessions
Bootstrap identity for first-time agents. The success body carries structured next_steps (with action: "deliver_verify_url_and_poll") and a cross-merchant agent_memory hint. Poll responses carry next_steps.action from the typed NextStepsAction Literal (continue_polling, retry_merchant_request_with_operator_token, use_stored_operator_token, create_new_session, verification_failed, contact_support).
session = client.create_session()
print(session["verify_url"], session["poll_url"], session["poll_secret"])
print(session["next_steps"]["action"]) # "deliver_verify_url_and_poll"
status = client.poll_session(session["session_id"], session["poll_secret"])
if status["status"] == "verified":
print(status["operator_token"]) # "opc_..." — use for future requests
# Optional pre-association: attach the session to a known wallet or refresh KYC
# for an existing operator credential.
client.create_session(address="0x...")
client.create_session(operator_token="opc_...") # KYC refresh
Wallet resolution
assess() responses include resolved_operator and linked_wallets — all same-operator sibling wallets (claimed via SIWE or captured via prior associate_wallet). The list may mix EVM addresses (0x... lowercased) and Solana addresses (base58, case-preserved) for cross-chain operators; merchants doing wallet-signer-match checks should accept a payment signed by any address in the list, regardless of chain. The address parameter on assess() and get_reputation() accepts either format — network is auto-detected from the address shape.
Credential Management
cred = client.create_credential(label="my-agent", ttl_days=7)
print(cred["credential"]) # shown once
credentials = client.list_credentials()
client.revoke_credential(cred["id"])
Report an Agent's Wallet (Cross-Merchant Attribution)
After an agent authenticated via operator_token completes a payment, report the signer wallet so AgentScore can build a cross-merchant credential↔wallet profile. Fire-and-forget — first_seen is informational only. network is the key-derivation family: "evm" for any EVM chain (Base, Tempo, Ethereum, …) or "solana" for Solana.
client.associate_wallet(
operator_token="opc_...",
wallet_address=signer_from_payment, # e.g. EIP-3009 `from` or Tempo MPP DID address
network="evm",
idempotency_key=payment_intent_id, # optional — agent retries of the same payment no-op
)
Async
All methods have async variants prefixed with a:
async with AgentScore(api_key="as_live_...") as client:
rep = await client.aget_reputation("0x1234...")
result = await client.aassess("0x1234...", policy={"require_kyc": True})
# Identity model methods
session = await client.acreate_session()
status = await client.apoll_session(session["session_id"], session["poll_secret"])
cred = await client.acreate_credential(label="my-agent")
await client.alist_credentials()
await client.arevoke_credential(cred["id"])
await client.aassociate_wallet(
operator_token="opc_...",
wallet_address="0x...",
network="evm",
)
Context Manager
with AgentScore(api_key="as_live_...") as client:
rep = client.get_reputation("0x1234...")
Configuration
| Parameter | Default | Description |
|---|---|---|
api_key |
None |
API key from agentscore.sh |
base_url |
https://api.agentscore.sh |
API base URL |
timeout |
10.0 |
Request timeout (seconds) |
user_agent |
None |
Prepended to the default User-Agent as "{user_agent} (agentscore-py/{version})". Use to attribute API calls to your app. |
AgentScoreError.status is a property aliasing .status_code so polyglot codebases can use the same attribute name regardless of which SDK raised the error.
Error Handling
from agentscore import AgentScore, AgentScoreError
try:
rep = client.get_reputation("0xinvalid")
except AgentScoreError as e:
print(e.code, e.status_code, str(e))
AgentScoreError.details carries the rest of the response body — verify_url, linked_wallets, claimed_operator, actual_signer, expected_signer, reasons, agent_memory — so callers can branch on granular denial codes without re-parsing.
Typed error classes
For status-code-specific recovery, the SDK raises typed subclasses of AgentScoreError. All inherit from AgentScoreError so existing except AgentScoreError still catches them.
| Class | Triggered by | What it adds |
|---|---|---|
PaymentRequiredError |
HTTP 402 | The endpoint is not enabled for this account |
TokenExpiredError |
HTTP 401 with error.code = "token_expired" |
Parsed body fields on the instance: verify_url, session_id, poll_secret, poll_url, next_steps, agent_memory — recover without re-parsing details |
InvalidCredentialError |
HTTP 401 with error.code = "invalid_credential" |
Permanent — switch tokens or restart |
QuotaExceededError |
HTTP 429 with error.code = "quota_exceeded" |
Account-level cap reached; don't retry |
RateLimitedError |
HTTP 429 with error.code = "rate_limited" |
Per-second sliding-window cap; retry after Retry-After |
TimeoutError |
httpx.TimeoutException (connect/read/write/pool timeout) |
Distinct from generic network errors. Note: subclasses AgentScoreError, not the builtin TimeoutError — import explicitly from agentscore.errors to disambiguate. |
All non-timeout httpx.HTTPError (ConnectError, ProtocolError, NetworkError, etc.) are wrapped as AgentScoreError(code="network_error", status_code=0).
from agentscore import (
AgentScore, AgentScoreError, TokenExpiredError, QuotaExceededError,
)
from agentscore.errors import TimeoutError as AgentScoreTimeoutError
try:
client.assess("0xabc...", policy={"require_kyc": True})
except TokenExpiredError as e:
print("Verify at:", e.verify_url, "poll with:", e.poll_secret)
except QuotaExceededError as e:
print("Account quota reached — surface to user; don't retry.")
except AgentScoreTimeoutError:
print("Network timeout — retry with backoff.")
except AgentScoreError as e:
print(e.code, e.message)
Quota observability
assess() (and aassess()) responses include an optional quota field captured from X-Quota-Limit / X-Quota-Used / X-Quota-Reset response headers. Use it to monitor approach-to-cap proactively (warn at 80%, alert at 95%) before a 429:
result = client.assess("0xabc...", policy={"require_kyc": True})
quota = result.get("quota")
if quota and quota["limit"] and quota["used"]:
pct = (quota["used"] / quota["limit"]) * 100
if pct > 80:
print(f"AgentScore quota at {pct:.1f}% — resets {quota['reset']}")
quota is absent when the API doesn't emit the headers (Enterprise / unlimited tiers).
Telemetry
telemetry_signer_match(payload) and atelemetry_signer_match(payload) are fire-and-forget POSTs to /v1/telemetry/signer-match so AgentScore can track aggregate signer-binding behavior across merchants. Used internally by agentscore-commerce's gate; available directly for custom integrations that perform their own wallet-signer-match checks.
Documentation
License
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file agentscore_py-2.1.0.tar.gz.
File metadata
- Download URL: agentscore_py-2.1.0.tar.gz
- Upload date:
- Size: 57.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4fc811703ccc463dcd689b90fede67b016ea62d6a344e209d9669cd66ec5463c
|
|
| MD5 |
954fd80786535cddc19c335ab9df8873
|
|
| BLAKE2b-256 |
4baad857b03cd36cbc44cdce45f180fb639762a658bec492767c11aa97936bf1
|
Provenance
The following attestation bundles were made for agentscore_py-2.1.0.tar.gz:
Publisher:
publish.yml on agentscore/python-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
agentscore_py-2.1.0.tar.gz -
Subject digest:
4fc811703ccc463dcd689b90fede67b016ea62d6a344e209d9669cd66ec5463c - Sigstore transparency entry: 1426782254
- Sigstore integration time:
-
Permalink:
agentscore/python-sdk@aa8a810cb39bf55c2eacbe99b168d513fa3c5461 -
Branch / Tag:
refs/tags/v2.1.0 - Owner: https://github.com/agentscore
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@aa8a810cb39bf55c2eacbe99b168d513fa3c5461 -
Trigger Event:
push
-
Statement type:
File details
Details for the file agentscore_py-2.1.0-py3-none-any.whl.
File metadata
- Download URL: agentscore_py-2.1.0-py3-none-any.whl
- Upload date:
- Size: 19.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
11e6fb0c346540d68c11526b01046b6bdbdb0db66ae3a424490587206ce03af1
|
|
| MD5 |
777ccbc713ae58e7857ef121854948af
|
|
| BLAKE2b-256 |
6d85cccf18bbf9752edbc39f5dcc718afcdf4973a8be62067582a3d385085894
|
Provenance
The following attestation bundles were made for agentscore_py-2.1.0-py3-none-any.whl:
Publisher:
publish.yml on agentscore/python-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
agentscore_py-2.1.0-py3-none-any.whl -
Subject digest:
11e6fb0c346540d68c11526b01046b6bdbdb0db66ae3a424490587206ce03af1 - Sigstore transparency entry: 1426782313
- Sigstore integration time:
-
Permalink:
agentscore/python-sdk@aa8a810cb39bf55c2eacbe99b168d513fa3c5461 -
Branch / Tag:
refs/tags/v2.1.0 - Owner: https://github.com/agentscore
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@aa8a810cb39bf55c2eacbe99b168d513fa3c5461 -
Trigger Event:
push
-
Statement type: