Skip to main content

Python SDK for the Sidearm API — protect media from AI training, detect AI content, and search for stolen work

Project description

sidearmdrm

Python SDK for the Sidearm API. Protect media from AI training, detect AI content, search for stolen work.

Install

pip install sidearmdrm

Quick Start

from sidearm import Sidearm

client = Sidearm(api_key="sk_live_...")
job = client.protect(media_url="https://example.com/art.png", level="maximum")
result = job.wait()
print(result)

Protection

# Preset level (auto-selects algorithms)
job = client.protect(media_url="https://...", level="standard", tags=["portfolio"])

# Run specific algorithms by name
job = client.run(algorithms=["nightshade", "glaze", "hmark"], media_url="https://...")

Job Polling

Async endpoints return a Job handle with built-in polling:

# Wait until done (default 120s timeout, 2s interval)
result = job.wait(timeout=120, interval=2)

# Manual poll
status = job.poll()

# Resume from a previous job ID
resumed = client.jobs.handle("job-uuid")
resumed.wait()

Algorithms

all_algos = client.algorithms.list()
audio = client.algorithms.list(media_type="audio")
open_algos = client.algorithms.list(category="open")

Detection

# AI content detection (async)
ai_job = client.detect.ai(media_url="https://...")
ai_result = ai_job.wait()

# Fingerprint detection (sync)
matches = client.detect.fingerprint(media_url="https://...", tier="perceptual")

# Membership inference
mem_job = client.detect.membership(
    content_ids=["uuid-1", "uuid-2"],
    suspect_model="stable-diffusion-xl",
    method="combined",
)
mem_result = mem_job.wait()

Search

results = client.search.run(media_url="https://...", type="perceptual", limit=10)
history = client.search.list(limit=20)

Media Management

media = client.media.register(media_url="https://...", mode="basic")
library = client.media.list(limit=50)
asset = client.media.get("uuid")
client.media.update("uuid", original_media_url="https://...")
client.media.delete("uuid")

Rights and Billing

rights = client.rights.get("media-uuid")
billing = client.billing.get("account-uuid", start_date="2026-01-01")

Error Handling

from sidearm import Sidearm, SidearmError

try:
    client.protect(media_url="...")
except SidearmError as e:
    print(e)          # Human-readable message
    print(e.status)   # HTTP status code
    print(e.body)     # Raw response body

Context Manager

with Sidearm(api_key="sk_live_...") as client:
    job = client.protect(media_url="https://...")
    result = job.wait()

Requirements

  • Python 3.9+
  • Single dependency: httpx
  • Full type annotations (py.typed)

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

sidearmdrm-0.3.0.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

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

sidearmdrm-0.3.0-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file sidearmdrm-0.3.0.tar.gz.

File metadata

  • Download URL: sidearmdrm-0.3.0.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for sidearmdrm-0.3.0.tar.gz
Algorithm Hash digest
SHA256 84062f2b6188c8d692294a417027b54306d764bcdd928ca17451f8164a018c69
MD5 9ea83dd833fef775aad0f495a8c30f85
BLAKE2b-256 fc760b37b3e2e0693ef9043ab16c5b922d30bf1d5db52d23250cba66be321c36

See more details on using hashes here.

File details

Details for the file sidearmdrm-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: sidearmdrm-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 14.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for sidearmdrm-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d6dd33e53817fc05f6b0faac956d7fce217890d2c53c1eaf443554ea3f5ad616
MD5 7251e48e6b1166ae731c51e1400eb62a
BLAKE2b-256 31b4a7a1865c5b03da0ad9dc12961defd277f36487a264282675f413f2a17db9

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