matrx-api
The Python client of every AI Matrx server. Sister of the TypeScript @ai-matrx/api: both are
GENERATED from the same language-neutral server contract (aidream/api-contract/), so every
operation, deployment route, auth tier, org rule and stream kind agrees across languages.
Depends on httpx only. Never imports aidream, never reads env vars: the host injects
credentials, the organization and base URLs.
from matrx_api import MatrxApi, UserCredential
from matrx_api.generated import files
async with MatrxApi(credentials=lambda: UserCredential(token()), organization_id=org_id,
base_urls={"aidream": "http://localhost:8000"}) as api:
meta = await files.get_file(api, path={"file_id": fid})
async for frame in await some_domain.some_ndjson_op(api, body={...}): # NDJSON -> parsed dicts
...
Behaviors: credentials on every call (user / guest / api_key / service / scoped, re-read per call);
X-Organization-Id per the operation's org rule (required + missing -> OrganizationContextError
before the wire; exempt never sends one); unique X-Request-Id; GET/HEAD retry with backoff on network
failure, writes never; one MatrxApiError(status, code, message); NDJSON/SSE/bytes streams as async
iterators (*_or_json operations return JsonOrStream).
Per-schema types: every generated domain module exports the contract's request/response schemas as
TypedDicts (files.TYPES) and annotates body= / the return with them. route_prefix= (a string for
every deployment, or {deployment: prefix}) is prepended to every path for callers that mount under a prefix.
Installs on Python >=3.11.
Regenerate
python packages/matrx-api/scripts/generate.py # after the contract changes
python packages/matrx-api/scripts/generate.py --check # exit 1 on drift (also run by the tests)
Writes matrx_api/generated/<domain>.py (one module per x-matrx-domain) and
matrx_api/deployments.py (CONTRACT_SHA256, default base URLs). RED (exit 1) on a missing/unknown
x-matrx-* tag, an operation no deployment serves, or a domain-module collision. Never edit generated files.
Test
uv run pytest packages/matrx-api/tests
1 maintainer
Metadata
1 maintainer
Release files for matrx-api 0.1.18
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 | |
|---|---|---|---|---|
| matrx_api-0.1.18.tar.gz | 501.5 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| matrx_api-0.1.18-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.0 MB
Release files / matrx_api-0.1.18.tar.gz
| Download URL | matrx_api-0.1.18.tar.gz |
|---|---|
| Size | 501.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c01708e40f05e81c356e26aeb9a761668eb7c7c8104d6d5640eb3bec4bcf2ac5
|
|
BLAKE2b-256 checksum How to use checksums |
4058a9c5f547babb51f521bc71094773cc4ca26aa37abc01a803e6c7b86873c1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 23, 2026.
Transparency logRelease files / matrx_api-0.1.18-py3-none-any.whl
| Download URL | matrx_api-0.1.18-py3-none-any.whl |
|---|---|
| Size | 502.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b47c0657d97d6955dc8731910bad6de4ab6fd3c82f0d2ab6b48d6e3c3497ae01
|
|
BLAKE2b-256 checksum How to use checksums |
aaf179df56b77b2a3163133aed976891ce8c01a310320a42ba92b2e76ea42a32
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 23, 2026.
Transparency logSecurity for matrx-api 0.1.18
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.
Attestation for matrx_api-0.1.18.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 23, 2026.
Transparency logA 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.
