Skip to main content

Seltz API SDK

Built with APIMatic License: MIT Python 3.10+

The Seltz API SDK for Python provides access to the Seltz API REST APIs from Python applications.

REST API for the Seltz platform: context retrieval (/v1/search), RAG answers (/v1/answer), monitors (/v1/monitors), and page fetching (/v1/fetch).


Installation

Install the Python SDK from PyPI, with whichever package manager your project uses:

pip install stz-apimatic-sdk
uv add stz-apimatic-sdk
poetry add stz-apimatic-sdk

Quick Start

Synchronous client

Construct SeltzApiClient with keyword arguments, and call close() when you are done. Every argument is optional; the full list is in the SDK map.

from seltz_api import SeltzApiClient

client = SeltzApiClient(api_key_auth="YOUR_API_KEY")

# TODO: call endpoints here -- see api-reference.md

client.close()

Alternatively, scope it -- with SeltzApiClient(...) as client: closes the pool on exit; see Best Practices.

Client is exported as an alias of SeltzApiClient, so from seltz_api import Client also works.

The SDK accepts every model-typed input in two interchangeable spellings, both type-checked: the typed model, or a plain dict with the same keys -- the OrDict and Model | ModelDict unions in the SDK map. Pick whichever suits the call site: the dict form needs no import, while the model form adds a keyword-checked constructor and editor completion.

Asynchronous client

AsyncSeltzApiClient mirrors SeltzApiClient with identical method names, and every endpoint method is a coroutine. It takes the same arguments, with some differences -- for example, the transport argument is custom_async_http_client.

from asyncio import run

from seltz_api import AsyncSeltzApiClient


async def main() -> None:
    client = AsyncSeltzApiClient(api_key_auth="YOUR_API_KEY")
    # TODO: call endpoints here, awaiting each -- see api-reference.md
    await client.aclose()


run(main())

Alternatively, scope it -- async with AsyncSeltzApiClient(...) as client: closes the pool on exit. Only the async spelling is aclose, matching httpx; see Best Practices.

AsyncClient is the exported alias. Each client accepts only its own transport argument; passing the other's is a TypeError at runtime and an error under mypy.


Usage

Two generated references cover the SDK; each answers a different question:

Reference For
API Reference Usage guidance for a single parsed operation: client.<group>.<operation>(...) returns the typed payload and raises ApiError on any non-2xx, with .error the typed error body, or RawError for a status the operation does not document.
Raw API Reference The same for the raw variant: client.<group>.with_raw_response.<operation>(...) returns ApiResult[T, E] and never raises for an API error.

Both API references carry every one of the 17 operations, with a sync and an async sample and a parameter table each.

SDK map

This SDK ships a generated SDK map -- sdk-map.md -- a deterministic, lookup-oriented table of contents of the SDK's Python surface, generated by APIMatic alongside this SDK.

Consult the map before scanning or grepping the source: it answers call-level contract questions by lookup, and for anything it does not carry -- model shapes, enum values, an endpoint's route or behavioural prose -- it names the one source file to read. How to read the map itself, including the SDK-wide defaults its rows rely on, is stated at the top of sdk-map.md.

Best Practices

Match the disposal to the client's lifetime: an application-lifetime client is closed once at shutdown with close() / aclose(); where the lifetime fits a block, with SeltzApiClient() as client: / async with AsyncSeltzApiClient() as client: releases it automatically. Both are idempotent, but a closed client is not reusable: the next call raises. The client closes whatever transport it holds, including one you supplied via custom_http_client / custom_async_http_client; if you intend to reuse your own transport across clients, don't hand its lifetime to a with block.

License

This SDK is distributed under the MIT License.


Support

Refer to the API reference for detailed information on available operations with code samples.


Metadata

Release files for stz-apimatic-sdk 0.0.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 stz-apimatic-sdk 0.0.3
File Size Uploaded Provenance Actions
stz_apimatic_sdk-0.0.3.tar.gz 121.8 kB Without provenance Details for stz_apimatic_sdk-0.0.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for stz-apimatic-sdk 0.0.3
File Interpreter ABI Platform Actions
stz_apimatic_sdk-0.0.3-py3-none-any.whl Python 3 none any Details for stz_apimatic_sdk-0.0.3-py3-none-any.whl

Total release size: 309.5 kB

Release files / stz_apimatic_sdk-0.0.3.tar.gz

Download URL stz_apimatic_sdk-0.0.3.tar.gz
Size 121.8 kB
Tags Source
SHA-256 checksum
How to use checksums
d9de49cd1d586554cc8793633c1f558caf78c70a5b32b595cfdec40be8a0dbd9
BLAKE2b-256 checksum
How to use checksums
6a77a0a570b3cd6963fd818ffe4dcc0545a97c81b565d163fe6691e976c4a639
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.13.15 Linux/6.1.158.2-microsoft-standard

Release files / stz_apimatic_sdk-0.0.3-py3-none-any.whl

Download URL stz_apimatic_sdk-0.0.3-py3-none-any.whl
Size 187.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e77f562f868ad73312d3f7903cd76d0948cfb15a03d7ae1d6122317bd7711caf
BLAKE2b-256 checksum
How to use checksums
0c64b8e72ae3ccfb527afbf4a5f712897910488a9ef4e21acaa7904695eb980c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.13.15 Linux/6.1.158.2-microsoft-standard

Security for stz-apimatic-sdk 0.0.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.

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.

Release history Release notifications | RSS feed

This release

0.0.3 This release

2 release files No provenance

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