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 sz-apimatic-sdk==0.0.1

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

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

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.

• ApiKeyAuth (Custom Header Signature)

List of APIs

• Search
• Answer
• Monitors
• Records
• Runs
• Agent
• Fetch

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime