Skip to main content

System Zero Python SDK

Synchronous server-side Python client for the System Zero API.

Requires Python 3.10 or later.

Install with pip install rightnow-system-zero; import it as system_zero.

Set SYSTEM_ZERO_API_KEY in the server environment, then call the API:

from system_zero import SystemZero

with SystemZero() as client:
    reply = client.decide({
        "model": "system-zero",
        "state": {"order_total": 42},
        "questions": {
            "eligible": {
                "type": "boolean",
                "instructions": "Is the order total at least 25?",
            },
        },
    })
    print(reply["answers"])
    print(client.models.list()["data"])

The client calls POST /system-zero/decide and authenticated GET /models. Boolean, choice and score questions use the same request. decision_for and decisions_for read typed answers and per-question refusals. Responses preserve the service's wire fields.

Use decide_with_response or models.list_with_response for response metadata, including request IDs, rate limits, latency and replay status. Decide options accept idempotency_key. Both calls accept client_request_id, extra headers and retry_budget; model listing has no idempotency-key option. Client timeouts and retry waits are seconds: timeout=150.0, max_retries=5, retry_budget=60.0 and max_retry_wait=60.0. Close the client or use its context manager to release the HTTP transport.

Media on decide

attachments is optional; null remains valid. Each inline attachment has a unique name, a type of image or audio, and a canonical base64 data URL in data. Names start with an ASCII letter and contain at most 64 letters, digits, _ or -. Function tools and the MCP adapter carry the same inline forms.

  • Images: static PNG (image/png) and JPEG (image/jpeg), at most 4 images, 16,777,216 pixels each, with an aspect ratio no greater than 50:1.
  • Audio: at most 1 audio attachment, inline RIFF WAV (audio/wav) at exactly 16,000 Hz. Integer PCM with 1-64 bits per sample or IEEE float with 32 or 64 bits is supported, including the extensible WAV form; 1-64 channels are allowed. The duration limit is 300 seconds (4,800,000 frames); the separate long-recording cutoff is 300.5 seconds. The byte limit can be reached earlier.
  • All decoded inline bytes together: at most 2,621,440 bytes. The entire JSON request, including base64, is at most 3,665,920 bytes. The schema has a 16-entry attachment guard; the served image and audio counts are stricter.

The helpers check MIME types, signatures, canonical encoding, counts, byte limits, and WAV structure/rate. Preflight is explicit; complete image decoding, dimensions, availability and other request checks remain with the API. Signatures alone do not prove a complete image is valid.

GIF (image/gif), WebP (image/webp), animated PNG and images outside the decoded profile are refused with media_unpriced. A mismatched image signature uses media_decode_failed; other unsupported image MIME types use media_unsupported. Documents remain refused with document_not_available, and video with video_not_available. Other audio formats, rates, malformed WAV and audio upload references use media_unsupported. Image upload references are unavailable and return service_unavailable in the listed service. Send bytes inline.

from pathlib import Path
from system_zero import SystemZero, inline_attachment, validate_attachments

attachments = validate_attachments([
    inline_attachment(name="picture", type="image", mime="image/png", data=Path("picture.png").read_bytes()),
    inline_attachment(name="speech", type="audio", mime="audio/wav", data=Path("speech-16khz.wav").read_bytes()),
])
with SystemZero() as client:
    reply = client.decide({
        "model": "system-zero", "state": "Use the picture and recording.", "attachments": attachments,
        "questions": {"ready": {"type": "boolean", "instructions": "Is the item ready?"}},
    })
    print(reply["answers"])

MIMES, MEDIA_LIMITS and attachment_magic_matches expose the served registry, limits and signature screen. inline_attachment encodes one input; validate_attachments also checks aggregate counts and decoded bytes.

Ordinary HTTP retries

The defaults are five retries, 150 seconds per attempt, a 60-second total retry budget and a 60-second maximum wait. The retry count is capped at five, so one call makes at most six attempts. The budget starts with the first attempt and includes requests and waits. The first attempt keeps its normal timeout; later attempts are limited by the remaining budget. A wait above the maximum wait, or one that exhausts the remaining budget, raises the last error without waiting. A retry needs at least one millisecond remaining.

Only GET requests or requests carrying a nonempty idempotency key can retry. With retries enabled, decide POSTs receive a generated key when none is supplied. An explicit blank key omits the header and disables decision retries. Each retry retains the same key and serialized body. Setting the retry count or budget to zero disables retries.

Ordinary HTTP calls retry these marked responses:

  • HTTP 429: capacity_exhausted, rate_limit, rate_limit_exceeded, concurrency_limit_exceeded or workspace_limit_exceeded.
  • HTTP 503: service_unavailable or system_zero_unavailable.
  • HTTP 409: idempotency_conflict.

Marked means error.retryable is true or the x-should-retry header is true. An explicit false in either marker vetoes retry. A 503 warm-up response also qualifies when its code is starting, or when the service's warm-up header is true or 1 with service_unavailable or no code, and a valid retry delay is present. That warm-up case does not require a true retry marker; a false marker still vetoes it.

A qualifying connection failure or timeout before any response byte can also retry, even if the request was sent. Failures after a response byte never retry. Errors of authentication and permission types never retry. Python also refuses retry for codes containing spend, budget, auth or api_key.

Retry-After-Ms takes precedence; only when it is absent does Retry-After provide seconds or an HTTP date. The wait is never below the full-jitter floor min(8 seconds, 0.5 seconds * 2^attempt) * random, with attempt zero for the first retry and random drawn from zero to one. A malformed millisecond header does not fall back to the seconds header.

Workflow recovery and call limits

run_batch and run_flow use ordinary POST /system-zero/decide calls with a stricter recovery policy. Function tools use that policy for decide and model listing. Only a marked HTTP 429 refusal with one of these code/details.cause pairs proves that no work ran and permits recovery:

  • rate_limit_exceeded with key_rate or preauth.
  • concurrency_limit_exceeded with account_concurrency.

The marker is error.retryable=true or x-should-retry: true; an explicit false in either vetoes recovery. All connection failures and timeouts, HTTP 503 (including warm-up), HTTP 409 and every other code/cause pair are terminal. The ordinary HTTP retry allowlist above does not expand this workflow policy. Retries retain one key and one logical call admission and use the client's retry count, wait and time bounds. Batch retry options can only lower the client's retry count; they cannot enable retries disabled on the client.

Helper Call-cap option Default Maximum
run_batch max_decide_calls 1,000 Nonnegative safe integer
run_flow max_decide_calls 32 32
create_tool_handler / ToolHandler max_decide_calls 100 Nonnegative safe integer

Flow and batch reports record admitted decide calls; retries do not consume additional logical admissions. Batch receipts also record actual HTTP attempts. Flows admit a step only when its bounded call fits the remaining deadline; batches also respect their deadline and the original key's replay lifetime. Evaluation compares caller-supplied labels locally and adds no network calls. Explicit call caps must be nonnegative safe integers; zero is allowed. A tool handler retains its count across calls, so reuse one handler for the tool loop. Model listing does not consume a decide count. The module-level tool helper has a zero decide-call limit. A depleted tool limit returns local call_limit_reached without dispatch; this is separate from API errors.

system_zero.tools supplies OpenAI and Anthropic function definitions and the ToolHandler, create_tool_handler and handle_tool_call helpers. They share the API request validation and error vocabulary. Tool catalog messages are SDK summaries; HTTP refusal messages are preserved with credential redaction.

Response metadata

SDK errors and response metadata expose the request's idempotency key as idempotency_key (None when no key was sent). RateLimitError and OverloadedError expose the response's retry delay as retry_after_ms in milliseconds, or None when no valid retry delay is available.

Every HTTP attempt sends X-SDK-Retry-Count, starting at 0, and a User-Agent containing only the SDK name, SDK version and runtime version. A blank or whitespace-only client_request_id omits the X-Client-Request-Id header.

Keep API keys on trusted servers. See the security policy for private vulnerability reporting.

Metadata

Release files for rightnow-system-zero 0.2.0

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

Source distribution (sdist)

Source distribution for rightnow-system-zero 0.2.0
File Size Uploaded Provenance Actions
rightnow_system_zero-0.2.0.tar.gz 56.7 kB With provenance Details for rightnow_system_zero-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for rightnow-system-zero 0.2.0
File Interpreter ABI Platform Actions
rightnow_system_zero-0.2.0-py3-none-any.whl Python 3 none any Details for rightnow_system_zero-0.2.0-py3-none-any.whl

Total release size: 121.7 kB

Release files / rightnow_system_zero-0.2.0.tar.gz

Download URL rightnow_system_zero-0.2.0.tar.gz
Size 56.7 kB
Tags Source
SHA-256 checksum
How to use checksums
e7a18962ceb11b4a073553670e6f8bd3c762e40b392978ec4c926b03b61ff1e4
BLAKE2b-256 checksum
How to use checksums
555d0b837d3f5cbe5ba908bda68a9f9d7eedf2f108b385ddf39dc520b2bc1e15
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

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 Oct 22, 2026.

Transparency log

Release files / rightnow_system_zero-0.2.0-py3-none-any.whl

Download URL rightnow_system_zero-0.2.0-py3-none-any.whl
Size 65.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
13f18b40664a669c06dd65f69949f7fc2f34a4a73a42dae3cfc3acd91f9a54c3
BLAKE2b-256 checksum
How to use checksums
e58f573f6efc147d2f602207bcbe802e6e286930ec016a99604fd9a774c6337c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

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 Oct 22, 2026.

Transparency log

Security for rightnow-system-zero 0.2.0

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

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for rightnow_system_zero-0.2.0.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 Oct 22, 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