Skip to main content

JarvisClaw AI SDK — Chat, Images, Video, Search, Prediction Market. Supports API Key and x402 Agent payments.

Project description

JarvisClaw Python SDK

AI API SDK with per-capability clients, smart routing, and x402 machine payments.

Install

pip install jarvisclaw            # Sync client
pip install jarvisclaw[agent]     # + x402 EVM (Base chain) support
pip install jarvisclaw[solana]    # + Solana USDC support
pip install jarvisclaw[async]     # + asyncio (httpx) support
pip install jarvisclaw[all]       # Everything

Authentication

from jarvisclaw import ChatClient

# Option 1: API Key
client = ChatClient(api_key="sk-your-key")

# Option 2: x402 wallet (EVM / Base chain)
client = ChatClient(private_key="0x<hex-private-key>")

# Option 3: x402 wallet (Solana) — auto-detected from bs58 format
client = ChatClient(private_key="<base58-solana-keypair>")

# Option 4: Environment variables (JARVISCLAW_API_KEY or JARVISCLAW_WALLET_KEY)
client = ChatClient()

ChatClient

Method Returns Blocking
complete(message) str Yes
completion(messages) ChatResponse Yes
stream(message) Generator[str] Yields chunks
from jarvisclaw import ChatClient

chat = ChatClient(private_key="0x...")

# ─── complete() — simple one-liner ───
response = chat.complete("What is quantum computing?")
print(response)  # str

# With options
response = chat.complete("Explain gravity", model="openai/gpt-5.4", system="Be concise")

# ─── completion() — full control ───
resp = chat.completion([
    {"role": "system", "content": "You are a tutor."},
    {"role": "user", "content": "Explain gravity."}
], model="auto", temperature=0.5)
print(resp.content)       # str
print(resp.model)         # "openai/gpt-5.4-nano"
print(resp.usage)         # {"prompt_tokens": 12, "completion_tokens": 45, ...}

# ─── stream() — yields text chunks ───
for chunk in chat.stream("Tell me a joke"):
    print(chunk, end="", flush=True)

# With system prompt
for chunk in chat.stream("Explain AI", system="You are a professor"):
    print(chunk, end="")

ChatClient async (asyncio)

import asyncio
from jarvisclaw.aio import ChatClient

async def main():
    async with ChatClient(private_key="0x...") as chat:
        # Simple
        text = await chat.complete("Hello!")
        print(text)

        # Concurrent to multiple models
        results = await asyncio.gather(
            chat.complete("Hi", model="openai/gpt-5.4"),
            chat.complete("Hi", model="anthropic/claude-sonnet-4.6"),
            chat.complete("Hi", model="google/gemini-2.5-flash"),
        )
        for r in results:
            print(r)

        # Async streaming
        async for chunk in chat.stream("Tell me a story"):
            print(chunk, end="")

asyncio.run(main())

ImageClient

Method Returns Blocking
generate(prompt) ImageResponse Yes (default)
generate(prompt, wait=False) ImageResponse (with raw job data) No
status(job_id) ImageResponse No (single check)
wait(job_id) ImageResponse Yes (polls until done)
edit(image, prompt) ImageResponse Yes
from jarvisclaw import ImageClient

image = ImageClient(private_key="0x...")

# ─── generate() — blocking (default) ───
result = image.generate("A cat in space", size="1024x1024")
print(result.url)            # "https://api.jarvisclaw.ai/media/images/..."
print(result.revised_prompt) # model's revised prompt (if any)

# With specific model
result = image.generate("Neon city", model="openai/gpt-image-1", size="1792x1024")

# ─── generate(wait=False) — non-blocking ───
job = image.generate("A futuristic city", wait=False)
print(job.raw["id"])     # "e061906e-04d7-4281-b487-54907344c7c0"
print(job.raw["status"]) # "queued"

# ─── status(job_id) — single check, non-blocking ───
result = image.status(job.raw["id"])
print(result.raw.get("status"))  # "in_progress" or "completed"
if result.url:
    print(result.url)  # only set when completed

# ─── wait(job_id) — block until done ───
result = image.wait(job.raw["id"])
print(result.url)  # guaranteed to have URL (or raises on failure)

# ─── edit() — always blocking ───
result = image.edit(open("photo.png", "rb"), "Remove the background")
print(result.url)

ImageClient async (asyncio)

import asyncio
from jarvisclaw.aio import ImageClient

async def main():
    async with ImageClient(private_key="0x...") as image:
        # Blocking
        result = await image.generate("A cat")
        print(result.url)

        # Non-blocking
        job = await image.generate("A dog", wait=False)
        # ... do other async work ...
        result = await image.status(job.raw["id"])

        # Concurrent generation
        results = await asyncio.gather(
            image.generate("A sunrise"),
            image.generate("A sunset"),
            image.generate("A moonrise"),
        )
        for r in results:
            print(r.url)

asyncio.run(main())

VideoClient

Method Returns Blocking
generate(prompt) VideoJob Yes (default)
generate(prompt, wait=False) VideoJob (queued) No
status(job_id) VideoJob No (single check)
wait(job_id) VideoJob Yes (polls until done)
from jarvisclaw import VideoClient

video = VideoClient(private_key="0x...")

# ─── generate() — blocking (default, waits 1-3 minutes) ───
job = video.generate("A cat walking on a beach", duration=5)
print(job.url)     # MP4 URL
print(job.status)  # "completed"

# ─── generate(wait=False) — non-blocking ───
job = video.generate("Ocean waves at sunset", wait=False)
print(job.id)      # "bytedance:video_c6f42c34..."
print(job.status)  # "queued"

# ─── status(job_id) — single check, non-blocking ───
result = video.status(job.id)
print(result.status)  # "in_progress" or "completed"
if result.url:
    print(result.url)

# ─── wait(job_id) — block until done ───
result = video.wait(job.id)
print(result.url)    # guaranteed MP4 URL
print(result.status) # "completed"

Full non-blocking workflow

from jarvisclaw import VideoClient
import time

video = VideoClient(private_key="0x...")

# Submit job
job = video.generate("A timelapse of a flower blooming", wait=False)
print(f"Submitted: {job.id}")

# Do other work...
print("Doing other work while video generates...")
time.sleep(30)

# Now wait for the result
result = video.wait(job.id)
print(f"Done! URL: {result.url}")

VideoClient async (asyncio)

import asyncio
from jarvisclaw.aio import VideoClient

async def main():
    async with VideoClient(private_key="0x...") as video:
        # Blocking
        job = await video.generate("Sunset over mountains")
        print(job.url)

        # Non-blocking
        job = await video.generate("Waves crashing", wait=False)
        print(f"Submitted: {job.id}")
        # ... do other async work ...

        # Wait when ready
        result = await video.status(job.id)  # single check
        # or block:
        # result = await video.wait(job.id)  # NOT YET IN ASYNC (use generate with wait=True)

        # Concurrent
        jobs = await asyncio.gather(
            video.generate("A cat"),
            video.generate("A dog"),
        )
        for j in jobs:
            print(j.url)

asyncio.run(main())

AudioClient

Method Returns Blocking
music(prompt) AudioResponse Yes (1-3 min)
music(prompt, wait=False) MusicJob No
MusicJob.result() AudioResponse Yes (blocks until ready)
MusicJob.done bool No
speech(text) AudioResponse Yes (fast)
transcribe(file) str Yes
from jarvisclaw import AudioClient

audio = AudioClient(private_key="0x...")

# ─── music() — blocking (takes 1-3 minutes) ───
result = audio.music("An upbeat electronic track")
with open("music.mp3", "wb") as f:
    f.write(result.content)
print(result.content_type)  # "audio/mpeg"

# ─── music(wait=False) — non-blocking ───
job = audio.music("Lo-fi hip hop beat", wait=False)
print(job.done)  # False

# Do other work...
print("Working on other things...")

# Get result when needed (blocks from this point)
result = job.result()
with open("lofi.mp3", "wb") as f:
    f.write(result.content)

# Check without blocking
if job.done:
    result = job.result()  # instant, already done

# ─── speech() — always blocking (fast, <5s) ───
result = audio.speech("Hello world", voice="alloy")
with open("speech.mp3", "wb") as f:
    f.write(result.content)

# Available voices: alloy, echo, fable, onyx, nova, shimmer
result = audio.speech("Good morning", model="tts-1", voice="nova")

# ─── transcribe() — always blocking ───
with open("recording.mp3", "rb") as f:
    text = audio.transcribe(f)
print(text)  # "Hello, this is a test recording."

AudioClient async (asyncio)

import asyncio
from jarvisclaw.aio import AudioClient

async def main():
    async with AudioClient(private_key="0x...") as audio:
        # Concurrent music + speech
        music, speech = await asyncio.gather(
            audio.music("Jazz piano"),
            audio.speech("Hello world", voice="nova"),
        )
        # music.content, speech.content are bytes

asyncio.run(main())

SearchClient

Method Returns Blocking
query(q) list[SearchResult] Yes
find_similar(url) list[SearchResult] Yes
contents(urls) list[dict] Yes
from jarvisclaw import SearchClient

search = SearchClient(private_key="0x...")

# ─── query() ───
results = search.query("latest AI news", num_results=5)
for r in results:
    print(f"{r.title}")
    print(f"  {r.url}")
    print(f"  {r.snippet}")

# ─── find_similar() ───
similar = search.find_similar("https://example.com/article")
for r in similar:
    print(r.title, r.url)

# ─── contents() ───
pages = search.contents(["https://example.com/page1", "https://example.com/page2"])
for page in pages:
    print(page)  # full page content dict

MarketplaceClient

Method Returns Blocking
call(service, path) dict Yes
call(service, path, method="POST") dict Yes
from jarvisclaw import MarketplaceClient

mp = MarketplaceClient(private_key="0x...")

# ─── GET request ───
markets = mp.call("polymarket", "markets?sort=volume&limit=10")
for m in markets.get("markets", []):
    print(f"{m['question']}: {m['volume']}")

# ─── POST request ───
data = mp.call("polymarket", "wallet/identities",
               method="POST", json={"addresses": ["0xabc..."]})

# ─── Other HTTP methods ───
mp.call("dex", "orders/123", method="DELETE")
mp.call("service", "config", method="PUT", json={"key": "value"})

Error Handling

from jarvisclaw import (
    ChatClient, APIError, AuthenticationError,
    RateLimitError, InsufficientBalanceError, PaymentError,
)

chat = ChatClient()

try:
    response = chat.complete("Hello")
except AuthenticationError:
    print("Invalid API key or wallet key")
except RateLimitError:
    print("Rate limited — slow down")
except InsufficientBalanceError:
    print("Balance too low — top up USDC")
except PaymentError as e:
    print(f"x402 payment signing failed: {e}")
except APIError as e:
    print(f"API error {e.status_code}: {e.message}")

Balance & Wallet

from jarvisclaw import ChatClient

client = ChatClient(private_key="0x...")

# On-chain USDC balance
print(f"Balance: ${client.get_balance():.2f}")

# Session spending (tracked locally)
print(f"Spent: ${client.get_spending():.4f}")

# Wallet address
print(f"Wallet: {client.address}")

Concurrent Batch Processing (ThreadPool)

from concurrent.futures import ThreadPoolExecutor
from jarvisclaw import ImageClient

image = ImageClient(private_key="0x...")
prompts = ["A cat", "A dog", "A bird", "A fish", "A horse"]

with ThreadPoolExecutor(max_workers=5) as pool:
    futures = [pool.submit(image.generate, p) for p in prompts]
    for f in futures:
        print(f.result().url)

Solana Payments

from jarvisclaw import ChatClient, ImageClient

# Auto-detected from bs58 key format
chat = ChatClient(private_key="<base58-solana-keypair>")
print(chat.complete("Hello from Solana!"))

# Explicit network
chat = ChatClient(private_key="<key>", network="solana")

# All clients work identically — only payment chain differs
image = ImageClient(private_key="<base58-solana-keypair>")
result = image.generate("Cyberpunk city")
print(result.url)

Requirements

  • Python >= 3.9
  • USDC on Base chain (EVM) or Solana (SPL)
  • No ETH/SOL needed for gas (facilitator pays)

Links

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

jarvisclaw-1.2.0.tar.gz (33.4 kB view details)

Uploaded Source

Built Distribution

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

jarvisclaw-1.2.0-py3-none-any.whl (31.3 kB view details)

Uploaded Python 3

File details

Details for the file jarvisclaw-1.2.0.tar.gz.

File metadata

  • Download URL: jarvisclaw-1.2.0.tar.gz
  • Upload date:
  • Size: 33.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for jarvisclaw-1.2.0.tar.gz
Algorithm Hash digest
SHA256 cf51e13551c9abab3f2da0607d50da8385a9ee639fce2a81991b93889f3a1747
MD5 b5ab13a86d5050e88de7956e70059bb9
BLAKE2b-256 fa225a12f92d9f99f66996334047974a26048d05a53141f9c6fa596ee6a734d5

See more details on using hashes here.

File details

Details for the file jarvisclaw-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: jarvisclaw-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 31.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for jarvisclaw-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 de96356c186dac8d06c9fe5c7001c20d8da12266d6214feb3a2e34f6a77509e8
MD5 a965a9edc74af4a87ee29a8cfd2ab18a
BLAKE2b-256 4a41fa6575666e6c18f220cb9e286ceebbeab4e2d5cbc6ee0e119b7d8d434ca0

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