Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Impact SDK for Python

Capture model and tool work from your Python application in Impact Traces. Your application keeps its native clients, responses, streams, errors and tool effects. Python 3.11 or newer is required.

Quickstart

Create a virtual environment and install the exact SDK prerelease alongside the OpenAI client for this example. The shell commands use a POSIX shell.

python3 -m venv .venv
. .venv/bin/activate
python -m pip install 'impact==1.2.0rc10' 'openai==3.46.0'

Pin the full version, including the prerelease suffix. For an existing application, resolve impact with the application's dependencies and keep its compatible clients. For example, in an existing uv project use uv add 'impact==1.2.0rc10'.

  1. Ask a workspace owner or admin to open Ingest keys → Create ingest key in the intended AI product. Copy the OpenTelemetry exporter settings URL ending in /v1/traces to IMPACT_ENDPOINT. Store the raw ingest secret as IMPACT_API_KEY. Impact adds the Bearer header.
  2. Set OPENAI_API_KEY from your OpenAI project and IMPACT_SERVICE_NAME=impact-quickstart. Store both keys in your application's secret configuration. The example makes one billable OpenAI Responses call. Set OPENAI_MODEL to a model your project can use with the supplied options, or adjust the options for that model.
  3. Save the following as quickstart.py. Importing impact is passive. Initialize it before constructing the client.
import os

import impact

runtime = impact.init(startup="strict")
try:
    from openai import OpenAI

    status = runtime.status()
    print("Impact SDK", status.artifact["version"], "runtime", status.runtime_id)
    with OpenAI(max_retries=0) as client:
        response = client.responses.create(
            model=os.getenv("OPENAI_MODEL", "gpt-6.1-sol"),
            max_output_tokens=512,
            reasoning={"effort": "low"},
            input="Say hello in one sentence.",
        )
        print(response.output_text)
finally:
    shutdown = runtime.shutdown()
    status = runtime.status()
    print("Impact local delivery", shutdown.delivery)
    print("Impact exported traces", status.traces.exported if status.traces else None)
    if status.cause not in (None, "none"):
        print("Impact diagnosis", status.cause, status.action)
    if not shutdown.completed:
        print("Impact shutdown incomplete", shutdown.message)
python quickstart.py

Open Traces in the same AI product. Find impact-quickstart and match the Trace's impact.runtime.id to the printed runtime ID. In the model span's Recorded fields, check the model and available token usage. Match the prompt and printed reply when the Product retains content. Verify the installed SDK version against the version you selected. Treat shutdown completion, local export and a readable Product Trace as separate checks.

Integrate with your application

  • Start Impact before constructing supported provider and framework clients. Retain the runtime and call runtime.shutdown() during application teardown. In an async application, use await impact.init_async() and await runtime.shutdown(). Inspect runtime.status() locally in either case.
  • Keep your existing OpenTelemetry providers, processors and samplers. To add an Impact destination to your customer-owned provider, pass tracer_provider=provider and the explicit Impact endpoint= and api_key= to init(). Pass logger_provider= if using a customer LoggerProvider. When both route options are omitted, customer exporters own delivery, even with managed-mode environment variables set.
  • Wrap a logical request with impact.interaction() to record its actual result and native work. Supply a Session ID when those requests belong to the same Session. Use impact.span() for an application-owned tool.
  • With supported streams, capture follows the native events the application consumes. Early close can leave terminal output and usage unavailable.
  • Set the relevant keys to False in init(content=...) to omit input, output, tools, retrieval or media from the Impact destination. These categories are enabled by default, subject to native settings and signal controls. Customer destinations retain their own policies.

Use the Python integration catalogue and runtime.status().integration_details for exact operation and route limits. This quickstart uses synchronous OpenAI Responses on the public route. The broader client operation sets, including background and resumed streams and image and audio operations, remain unassessed.

Troubleshooting and support

If the Trace is missing, check the service and runtime IDs, then inspect runtime.status().cause, .action, integration activation, and local export counts. Direct OTLP checks the ingest key at export. After correcting the endpoint or key for an active runtime, restart the process and run a new application operation. A zero-record flush leaves capture unverified. Check the matching Trace even after successful local export.

For setup help, email biz@impact.ai with SDK and Python versions, the integration and operation, and the local diagnosis code. Keep keys, prompt text and raw telemetry private.

Python setup and lifecycle · Trace troubleshooting · Impact SDK setup plugin

Security reporting

Email biz@impact.ai with the subject Impact SDK security report. Include the affected package, version and a contact address, and ask for a private channel to share the details. Keep credentials, customer data and reproductions out of the initial message and public issue trackers.

Metadata

Release files for impact 1.2.0rc10

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

Source distribution (sdist)

Source distribution for impact 1.2.0rc10
File Size Uploaded Provenance Actions
impact-1.2.0rc10.tar.gz 570.3 kB With provenance Details for impact-1.2.0rc10.tar.gz

Built distribution (wheel)

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

Total release size: 855.3 kB

Release files / impact-1.2.0rc10.tar.gz

Download URL impact-1.2.0rc10.tar.gz
Size 570.3 kB
Tags Source
SHA-256 checksum
How to use checksums
cf1331712bb8d703618752553523582252f97320d34a48ccfc789c3772752a86
BLAKE2b-256 checksum
How to use checksums
9c3acd59b7970fb282b63fdf1aee6040ff53f9f4e6effd924eb1dc363f252844
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Nov 16, 2026.

Transparency log

Release files / impact-1.2.0rc10-py3-none-any.whl

Download URL impact-1.2.0rc10-py3-none-any.whl
Size 285.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7992623f7ee13ea7fad6c713656e7f1c9589cb56eda687cc2b80cbf13e20537b
BLAKE2b-256 checksum
How to use checksums
902842c48276f6c7747b7d4e7c209c8d82ab4ec5bbdd73b42ccfdf56ac75d91e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Nov 16, 2026.

Transparency log

Security for impact 1.2.0rc10

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 impact-1.2.0rc10.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 Nov 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