Skip to main content

hyperclipco

PyPI PyPI downloads Python versions

Official Python SDK for the Hyperclip API.

Installed as hyperclipco (the unscoped hyperclip name was already taken on PyPI). Imports as hyperclipco.

Install

pip install hyperclipco

Requires Python 3.9+.

Quickstart

import os, uuid
from hyperclipco import Hyperclip

hc = Hyperclip(api_key=os.environ["HYPERCLIP_API_KEY"])

ref = hc.runs.create(
    flow_id="a3c7f1ea-1234-4abc-bb11-5faed63c7e90",
    inputs={"prompts": {0: "a lighthouse at dawn"}},
    idempotency_key=str(uuid.uuid4()),
)

run = hc.runs.wait(
    ref["id"],
    on_update=lambda r: print(r["status"], r.get("current_step")),
)

if run["status"] == "completed":
    print("Video:", run["video_url"])
else:
    print(run["error_code"], run["error_message"])

Configuration

Argument Env var Required
api_key HYPERCLIP_API_KEY yes
base_url HYPERCLIP_BASE_URL no (defaults to Hyperclip production)
timeout — no (defaults to 30s)
client — no (inject your own httpx.Client)

API

  • hc.runs.create(flow_id=..., flow_schema=..., inputs=..., idempotency_key=...)
  • hc.runs.get(run_id)
  • hc.runs.list(limit=..., status=...)
  • hc.runs.cancel(run_id)
  • hc.runs.wait(run_id, timeout=600, poll_interval=4, on_update=...) — polls until terminal
  • hc.flows.list()
  • hc.flows.get(flow_id)

Errors raise HyperclipError (with .status and .code). Timeouts raise HyperclipTimeoutError.

Metadata

Release files for hyperclipco 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hyperclipco 0.1.3
File Size Uploaded Provenance Actions
hyperclipco-0.1.3.tar.gz 3.4 kB With provenance Details for hyperclipco-0.1.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for hyperclipco 0.1.3
File Interpreter ABI Platform Actions
hyperclipco-0.1.3-py3-none-any.whl Python 3 none any Details for hyperclipco-0.1.3-py3-none-any.whl

Total release size: 7.7 kB

Release files / hyperclipco-0.1.3.tar.gz

Download URL hyperclipco-0.1.3.tar.gz
Size 3.4 kB
Tags Source
SHA-256 checksum
How to use checksums
c2d1afbc51fb63ca34a53f5ab11f1edd33ae5f2eea818a4a48a893685e0769fb
BLAKE2b-256 checksum
How to use checksums
f21798ccfbde46f9a2d574bd477667276d5053e1142150490c3ed53def452389
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 16, 2026.

Transparency log

Release files / hyperclipco-0.1.3-py3-none-any.whl

Download URL hyperclipco-0.1.3-py3-none-any.whl
Size 4.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e99a5a0ca247f8889999177aa04bca494a5493bdeca37166bf052eff91518b22
BLAKE2b-256 checksum
How to use checksums
623003a8b1b18240ebb22f72fdf1842e50234995c12b83fb80535ed3e1d0e0ae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 16, 2026.

Transparency log

Security for hyperclipco 0.1.3

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.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for hyperclipco-0.1.3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 16, 2026.

Transparency log

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page