deeprelay-sdk

Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.

Keys minted from the dashboard or deeprelay login belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.

Versioning: /v1 is the API version. info.version is the revision of this /v1 document, not a separate API.

OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 unsupported_parameter and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 0.4.0
• Generator version: 7.24.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

Install from PyPI with pip install deeprelay-sdk, or straight from the public source mirror:

pip install git+https://github.com/deeprelay-dev/deeprelay-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/deeprelay-dev/deeprelay-python-sdk.git)

Then import the package:

import deeprelay_sdk

Setuptools

Install from a mirror checkout (run from the checkout root):

pip install --user .

(or sudo pip install . to install the package for all users)

Then import the package:

import deeprelay_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import os

import deeprelay_sdk
from deeprelay_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.deeprelay.ai/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = deeprelay_sdk.Configuration(
    host = "https://api.deeprelay.ai/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (deeprelay_live_<24-base62>): bearerAuth
configuration = deeprelay_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with deeprelay_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deeprelay_sdk.AlertsApi(api_client)

    try:
        # Get the organization's alert settings
        api_response = api_instance.get_alert_settings()
        print("The response of AlertsApi->get_alert_settings:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AlertsApi->get_alert_settings: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.deeprelay.ai/v1

Documentation For Models

• AlertEmailToggles
• AlertSettings
• AlertSettingsUpdate
• ApiKey
• ApiKeyCreate
• ApiKeyCreated
• ApiKeyList
• ApiKeyScopes
• ApiKeyUpdate
• Balance
• ChatChoice
• ChatCompletionRequest
• ChatCompletionRequestResponseFormat
• ChatCompletionRequestToolChoice
• ChatCompletionResponse
• ChatMessage
• CostDetails
• CreateCryptoDepositRequest
• CreateWebhookEndpointRequest
• CryptoDeposit
• Embedding
• EmbeddingsRequest
• EmbeddingsRequestInput
• EmbeddingsResponse
• EmbeddingsUsage
• GetHealth200Response
• ImagesGenerationsRequest
• ImagesResponse
• ImagesResponseDataInner
• ImagesResponseUsage
• InferencePreflight
• JSONSchemaFormat
• ListDeposits200Response
• Model
• ModelList
• ModelMetrics
• ModelParametersInner
• ModelPricing
• ModelRate
• OpenAIErrorEnvelope
• OpenAIErrorEnvelopeError
• PeakWindow
• Problem
• RefereeStatus
• Referral
• RequestLogEntry
• RequestLogPage
• ResponseFormatJSONObject
• ResponseFormatJSONSchema
• ResponseFormatText
• SpendingLimit
• StreamOptions
• Subscription
• SubscriptionCheckoutRequest
• SubscriptionCheckoutSession
• SubscriptionModelUsage
• SubscriptionPlan
• SubscriptionPortalRequest
• SubscriptionPortalSession
• SubscriptionPrice
• SubscriptionQuota
• SubscriptionTier
• SubscriptionUpgradeRequest
• SubscriptionUsage
• Tool
• ToolCall
• ToolCallFunction
• ToolChoiceFunction
• ToolChoiceFunctionFunction
• ToolFunction
• UpdateSpendingLimitRequest
• Usage
• UsageBucket
• UsageCompletionTokensDetails
• UsagePage
• UsagePromptTokensDetails
• VideoCreateRequest
• VideoJob
• VideoList
• WebhookEndpoint
• WebhookEndpointPage

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (deeprelay_live_<24-base62>)

Author

support@deeprelay.ai