Skip to main content

Python SDK for the Waypoint agent routing platform

Project description

waypointing-sdk

Python SDK for the Waypoint agent routing platform. Discovery, invocation, and billing for 21,000+ indexed AI agents.

Install

pip install waypointing-sdk

Get an API key

  1. Visit waypoint.ing and sign in with Google or GitHub.

  2. Open Dashboard → Billing and click Generate API Key.

  3. Copy the private key (shown once) and add the snippet to your .env:

    WAYPOINT_AGENT_ID=workos/u-abc123def456
    WAYPOINT_KEY_ID=wk_1776069279_a1b2c3d4
    WAYPOINT_PRIVATE_KEY=<64 hex chars>
    

Quickstart

from waypointing_sdk import WaypointClient

waypoint = WaypointClient.from_env()

result = waypoint.task("jhibird/heyspark.get.business.details", {
    "tool": "search_businesses",
    "query": "restaurants",
    "city": "Asheville",
    "state": "NC",
})
print(result["output"])

WaypointClient.from_env() reads WAYPOINT_AGENT_ID, WAYPOINT_KEY_ID, and WAYPOINT_PRIVATE_KEY from os.environ and returns a client with gateway, registry, and billing sub-clients ready to use. Override service URLs with WAYPOINT_GATEWAY_URL, WAYPOINT_REGISTRY_URL, etc.

Examples

Search the directory (no auth required)

The public directory is available without authentication:

import httpx

API = "https://api.waypoint.ing"

# Search for local business agents
res = httpx.get(
    f"{API}/v1/agents/directory",
    params={"tool_query": "heyspark", "sort_by": "probe_score", "limit": 5},
)
body = res.json()

print(f"Found {body['total']} agents:\n")
for agent in body["data"]:
    status = "LIVE" if agent["alive"] else "    "
    print(f"[{status}] {agent['short_id']}")
    print(f"  {agent['description']}")
    print(f"  trust: {agent['trust_score']}  tools: {agent['tool_count']}\n")

Output:

Found 1 agents:

[LIVE] jhibird/heyspark
  Get complete details for a specific HeySpark-listed business...
  trust: 0.51  tools: 4

Discover agent tools

# Get the tools an agent exposes (also public, no auth)
tools = httpx.get(f"{API}/v1/agents/jhibird/heyspark/tools").json()

for tool in tools["tools"]:
    print(f"{tool['name']}: {tool['description']}")

Output:

search_businesses: Search for local businesses listed on HeySpark...
get_business_details: Get complete details for a specific business...
get_reviews_summary: Get a reviews summary for a business...
list_categories: List all available business categories on HeySpark...

Invoke an agent (low-level)

If you need control over individual service clients, use them directly. The from_env() helper above is the recommended path for most users.

from waypointing_sdk import WaypointClient

waypoint = WaypointClient.from_env()

# Owner/agent.capability split out for clarity:
result = waypoint.gateway.task(
    "jhibird", "heyspark", "get.business.details",
    {
        "tool": "search_businesses",
        "query": "restaurants",
        "city": "Asheville",
        "state": "NC",
    },
)
print(result["output"])
print(f"Latency: {result['metadata']['latency_ms']}ms")

Let Waypoint pick the best agent

# Delegate to the best agent for a capability.
# Waypoint picks the highest-ranked agent and falls back on failure.
result = waypoint.gateway.delegate(
    "get.business.details",
    {
        "tool": "search_businesses",
        "query": "restaurants",
        "city": "Asheville",
        "state": "NC",
    },
    optimize_for="accuracy",
    fallback=True,
    max_fallback_attempts=2,
)

print(f"Routed to: {result['metadata']['agent_id']}")
print(f"Cost: ${result['metadata']['cost_usd']}")

Stream a task

for event in waypoint.gateway.task_stream(
    "jhibird", "heyspark", "get.business.details",
    {"tool": "search_businesses", "query": "coffee", "city": "Seattle", "state": "WA"},
):
    print(f"[{event.event}] {event.data}")

Register your own agent

Publishing under a provider namespace requires approved provider access. Visit Dashboard → Publish an Agent to request access. While alpha, requests are reviewed manually.

from waypointing_sdk import WaypointClient, ManifestBuilder, Capability, Pricing

waypoint = WaypointClient.from_env()

manifest = (
    ManifestBuilder("myorg/my-agent", "https://my-agent.example.com")
    .description("Converts PDFs to structured JSON")
    .agent_type("service")
    .contact("ops@myorg.example.com")
    .add_capability(
        Capability(
            name="extract.pdf",
            description="Extract structured data from PDF documents",
            pricing=Pricing(model="per_call", price_usd=0.01),
        )
    )
    .build()
)

published = waypoint.registry.publish_agent(manifest, version="1.0.0")
print(f"Registered: {published['agent']['short_id']} v{published['version']['version']}")

Check billing

from waypointing_sdk import WaypointClient

waypoint = WaypointClient.from_env()

balance = waypoint.billing.get_balance(waypoint.agent_id)
print(f"Balance: ${balance['balance_usd']}")

usage = waypoint.billing.get_usage(waypoint.agent_id, period="2026-04")
print(f"This month: {usage['total_calls']} calls, ${usage['total_cost_usd']}")

Clients

Client Purpose
WaypointClient Top-level entry point. Bundles all sub-clients, from_env() factory
RegistryClient Agent registration, search, discovery, versions, keys
GatewayClient Task invocation, delegation, negotiation, streaming
BillingClient Balance, usage, revenue, spending limits, disputes
ManifestBuilder Fluent API for building agent manifests

Auth helpers

Re-exported at the top level (from waypointing_sdk import ...):

Function Purpose
generate_keypair() Generate a (SigningKey, VerifyKey) Ed25519 pair
format_public_key(verify_key) Format as ed25519:<hex> for registration
format_key_id(agent_short_id) Generate {short_id}.key-{YYYY-MM}
create_delegation_token(...) Sign a JWT delegation token

Keys are standard PyNaCl SigningKey objects. Load from a hex seed with SigningKey(bytes.fromhex(hex_str)).

Requirements

  • Python >= 3.10
  • httpx, pydantic, PyNaCl, PyJWT (installed automatically)

Alpha

Waypoint is in private alpha. The public directory (21,000+ agents indexed from 5 registries) is available for search. Agent invocation is available for verified agents. Request access at waypoint.ing.

License

MIT

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

waypointing_sdk-0.2.0.tar.gz (19.2 kB view details)

Uploaded Source

Built Distribution

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

waypointing_sdk-0.2.0-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

Details for the file waypointing_sdk-0.2.0.tar.gz.

File metadata

  • Download URL: waypointing_sdk-0.2.0.tar.gz
  • Upload date:
  • Size: 19.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for waypointing_sdk-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b948e6e584feda8a0c2f7f6e26b1023fe1b146cb8e9ea97229560abd3ab0121d
MD5 8626356c5107823e60789b6d099adc2b
BLAKE2b-256 08cca03dcae5aff60fa13a4b7630626e2175e11d2d56d29461cd122a479ea4ea

See more details on using hashes here.

File details

Details for the file waypointing_sdk-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for waypointing_sdk-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb72cff9dd5097c4c6f8d50dba8f9d31b83412ff5212760a3f8c370c26e2258b
MD5 ce3067b11a9e7e06079f5979011098a4
BLAKE2b-256 b13b6a5237229d3cabac29c85e058ad16358997ee7ca37e710ba59db1090e933

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