Skip to main content

Getting Started with Seltz API

Introduction

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

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install stz-apimatic-sdk==0.0.2

You can also view the package at: https://pypi.python.org/pypi/stz-apimatic-sdk/0.0.2

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
http_client_instance Union[Session, HttpClientProvider] The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 30
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ["GET", "PUT"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
custom_header_authentication_credentials CustomHeaderAuthenticationCredentials The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from seltzapi.configuration import Environment
from seltzapi.http.auth.custom_header_authentication import CustomHeaderAuthenticationCredentials
from seltzapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from seltzapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from seltzapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from seltzapi.seltzapi_client import SeltzapiClient

client = SeltzapiClient(
    custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(
        x_api_key='x-api-key'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from seltzapi.seltzapi_client import SeltzapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = SeltzapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for stz-apimatic-sdk 0.0.2

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.2
File Size Uploaded Provenance Actions
stz_apimatic_sdk-0.0.2.tar.gz 51.3 kB Without provenance Details for stz_apimatic_sdk-0.0.2.tar.gz

Built distribution (wheel)

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

Total release size: 177.0 kB

Release files / stz_apimatic_sdk-0.0.2.tar.gz

Download URL stz_apimatic_sdk-0.0.2.tar.gz
Size 51.3 kB
Tags Source
SHA-256 checksum
How to use checksums
254b424d385150a227b269e7b7409f54060eee8dd2d55e482a1a5c09e7021c2a
BLAKE2b-256 checksum
How to use checksums
a4bfd9dac6e2efaa4a7caac97fac557caca1d13b9ecc7d38c04d0f5e894a65c8
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.2-py3-none-any.whl

Download URL stz_apimatic_sdk-0.0.2-py3-none-any.whl
Size 125.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d0b5ca31f14307e7dbc48ea9b6d92189ef3d586073e2e0370f2ccc81886fa2dc
BLAKE2b-256 checksum
How to use checksums
19639308e871c430af8d18ed9cba88bcfe5ae72dd470c9a8ba30b0628d2a9be3
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.2

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.2 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