cygn
Official Python SDK for the Cygn Enterprise API — deepfake detection, C2PA content signing, sonic watermarking, and voice ID.
Zero dependencies. Python 3.9+.
Installation
pip install cygn
Quick Start
from cygn import CygnEnterprise
import base64
cygn = CygnEnterprise(license_key="cygn_ent_xxxx")
# Camera capture: sign a photo at the moment it's taken
with open("photo.jpg", "rb") as f:
image_b64 = base64.b64encode(f.read()).decode()
result = cygn.sign_image(
image=image_b64,
provenance="captured",
app_name="MyDeliveryApp Camera",
)
# result.signed_image is a base64-encoded C2PA-signed JPEG
Authentication
Two methods:
# License Key (simpler)
cygn = CygnEnterprise(license_key="cygn_ent_xxxx")
# Cygn-Token (Ed25519 cryptographic identity)
cygn = CygnEnterprise(cygn_token="eyJhbGci...")
API Methods
Deepfake Detection
result = cygn.detect_deepfake(content=image_b64, media_type="image")
# result.score, result.verdict, result.signals
See your enterprise dashboard for current pricing.
C2PA Content Signing
result = cygn.sign_image(
image=image_b64,
provenance="captured", # "captured" or "cygned"
app_name="Zomato Camera", # your app branding
did="did:key:z6Mkv...", # optional signer DID
)
# result.signed_image (base64), result.signed_at
See your enterprise dashboard for current pricing.
Provenance Bundle (Deepfake Detection + Signing)
result = cygn.provenance_bundle(
image=image_b64,
provenance="captured",
app_name="Zomato Rider",
did="did:key:z6Mkv...",
display_name="Rider #4521",
)
# result.signed_image, result.deepfake.verdict, result.deepfake.score
See your enterprise dashboard for current pricing.
Sonic Watermarking
See your enterprise dashboard for current pricing.
Voice ID
See your enterprise dashboard for current pricing.
Usage & Balance
usage = cygn.get_usage()
# usage.balance (paise), usage.total_spent, usage.current_month
balance = cygn.get_balance() # returns balance in paise
Error Handling
from cygn import CygnEnterprise, CygnAPIError
try:
result = cygn.sign_image(image=image_b64)
except CygnAPIError as e:
print(e.status) # HTTP status code (e.g. 402)
print(e.code) # VALIDATION_ERROR, UNAUTHORIZED, INSUFFICIENT_BALANCE, etc.
print(e.balance) # remaining balance (if available)
print(e.cost) # operation cost (if available)
| Status | Code | Meaning |
|---|---|---|
| 400 | VALIDATION_ERROR | Invalid request body |
| 401 | UNAUTHORIZED | Missing or invalid auth |
| 402 | INSUFFICIENT_BALANCE | Top up required |
| 403 | FORBIDDEN | Revoked or invalid license |
| 413 | FILE_TOO_LARGE | Payload exceeds limit |
| 415 | UNSUPPORTED_MEDIA_TYPE | Unsupported file format |
| 429 | RATE_LIMITED | Too many requests |
| 503 | SERVICE_UNAVAILABLE | Temporary outage |
Use Case: Food Delivery Camera App
# Rider captures photo of delivered food
result = cygn.provenance_bundle(
image=camera_capture_b64,
provenance="captured",
app_name="Zomato Rider",
did="did:key:z6Mkv...",
display_name="Rider #4521",
)
if result.deepfake.verdict == "likely_authentic":
save_signed_photo(result.signed_image)
License
Apache-2.0
Metadata
Release files for cygn 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| cygn-1.0.1.tar.gz | 8.4 kB | Without provenance | Details for cygn-1.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| cygn-1.0.1-py3-none-any.whl | Python 3 | none | any | Details for cygn-1.0.1-py3-none-any.whl |
Total release size: 15.4 kB
Release files / cygn-1.0.1.tar.gz
| Download URL | cygn-1.0.1.tar.gz |
|---|---|
| Size | 8.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
359e8841164382613e608e46d8328979e7eba1cbf549369e67f6b03722c8602c
|
|
BLAKE2b-256 checksum How to use checksums |
2b3f118036025184c738f33ff4c365f6b349728f6a37e16a4fceb9b827765697
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.9
|
Release files / cygn-1.0.1-py3-none-any.whl
| Download URL | cygn-1.0.1-py3-none-any.whl |
|---|---|
| Size | 6.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3134240c43708c3b0e65103c95b358ed510dc87f4fd6799e0b77ebb31441494e
|
|
BLAKE2b-256 checksum How to use checksums |
1e7e4a48de312a4ca647e77d3cb80757d1cc1daed7145d6402769c7caea7735f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.9
|
Security for cygn 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.