Metadata-Version: 2.4
Name: deeprelay-sdk
Version: 0.1.2
Summary: deeprelay Public Developer API
Home-page: 
Author: deeprelay Support
Author-email: deeprelay Support <support@deeprelay.ai>
License: Apache-2.0
Project-URL: Homepage, https://deeprelay.ai
Project-URL: Documentation, https://deeprelay.ai/docs
Project-URL: Repository, https://github.com/deeprelay-dev/deeprelay-python-sdk
Keywords: OpenAPI,OpenAPI-Generator,deeprelay Public Developer API
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=2.6.3
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: license-file

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


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 0.1.2
- 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:

```sh
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:
```python
import deeprelay_sdk
```

### Setuptools

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

```sh
pip install --user .
```
(or `sudo pip install .` to install the package for all users)

Then import the package:
```python
import deeprelay_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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.BillingApi(api_client)
    create_crypto_deposit_request = deeprelay_sdk.CreateCryptoDepositRequest() # CreateCryptoDepositRequest | 

    try:
        # Create a stablecoin deposit
        api_response = api_instance.create_crypto_deposit(create_crypto_deposit_request)
        print("The response of BillingApi->create_crypto_deposit:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BillingApi->create_crypto_deposit: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BillingApi* | [**create_crypto_deposit**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/BillingApi.md#create_crypto_deposit) | **POST** /billing/deposits/crypto | Create a stablecoin deposit
*BillingApi* | [**create_subscription_checkout**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/BillingApi.md#create_subscription_checkout) | **POST** /billing/subscription/checkout | Start a subscription checkout session
*BillingApi* | [**create_subscription_portal**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/BillingApi.md#create_subscription_portal) | **POST** /billing/subscription/portal | Open the billing portal to cancel or manage the subscription
*BillingApi* | [**get_balance**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/BillingApi.md#get_balance) | **GET** /billing/balance | Get the org credit balance
*BillingApi* | [**get_deposit**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/BillingApi.md#get_deposit) | **GET** /billing/deposits/{id} | Get one stablecoin deposit
*BillingApi* | [**get_referral**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/BillingApi.md#get_referral) | **GET** /referrals | Get the org referral code, invite link, terms and stats
*BillingApi* | [**get_spending_limit**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/BillingApi.md#get_spending_limit) | **GET** /billing/spending-limit | Get the org spending limit
*BillingApi* | [**get_subscription**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/BillingApi.md#get_subscription) | **GET** /billing/subscription | Get the org subscription status and quota usage
*BillingApi* | [**list_deposits**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/BillingApi.md#list_deposits) | **GET** /billing/deposits | List stablecoin deposits
*BillingApi* | [**update_spending_limit**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/BillingApi.md#update_spending_limit) | **PUT** /billing/spending-limit | Set the org spending limit
*InferenceApi* | [**cancel_video**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/InferenceApi.md#cancel_video) | **POST** /videos/{id}/cancel | Cancel a video generation job
*InferenceApi* | [**create_chat_completion**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/InferenceApi.md#create_chat_completion) | **POST** /chat/completions | Create a chat completion (OpenAI-compatible)
*InferenceApi* | [**create_embeddings**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/InferenceApi.md#create_embeddings) | **POST** /embeddings | Create embeddings (OpenAI-compatible)
*InferenceApi* | [**create_image**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/InferenceApi.md#create_image) | **POST** /images/generations | Create image (OpenAI-compatible)
*InferenceApi* | [**create_video**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/InferenceApi.md#create_video) | **POST** /videos | Create a video generation job (async)
*InferenceApi* | [**get_model**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/InferenceApi.md#get_model) | **GET** /models/{id} | Get a specific model (OpenAI-compatible)
*InferenceApi* | [**get_video**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/InferenceApi.md#get_video) | **GET** /videos/{id} | Get a video generation job
*InferenceApi* | [**get_video_content**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/InferenceApi.md#get_video_content) | **GET** /videos/{id}/content | Download a completed video artifact
*InferenceApi* | [**inference_preflight**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/InferenceApi.md#inference_preflight) | **GET** /inference/preflight | Check whether a model request would be served, and at whose expense
*InferenceApi* | [**list_models**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/InferenceApi.md#list_models) | **GET** /models | List available models (OpenAI-compatible)
*InferenceApi* | [**list_videos**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/InferenceApi.md#list_videos) | **GET** /videos | List video generation jobs
*MetaApi* | [**get_health**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/MetaApi.md#get_health) | **GET** /health | Liveness probe
*MetaApi* | [**get_open_api_spec**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/MetaApi.md#get_open_api_spec) | **GET** /openapi.json | OpenAPI 3.1 specification
*OperationsApi* | [**get_operation**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/OperationsApi.md#get_operation) | **GET** /operations/{id} | Get an async operation status
*UsageApi* | [**list_usage**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/UsageApi.md#list_usage) | **GET** /usage | Time-bucketed usage
*WebhooksApi* | [**create_webhook_endpoint**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/WebhooksApi.md#create_webhook_endpoint) | **POST** /webhook-endpoints | Create a webhook endpoint
*WebhooksApi* | [**delete_webhook_endpoint**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/WebhooksApi.md#delete_webhook_endpoint) | **DELETE** /webhook-endpoints/{id} | Delete a webhook endpoint
*WebhooksApi* | [**get_webhook_endpoint**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/WebhooksApi.md#get_webhook_endpoint) | **GET** /webhook-endpoints/{id} | Get a webhook endpoint
*WebhooksApi* | [**list_webhook_endpoints**](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/WebhooksApi.md#list_webhook_endpoints) | **GET** /webhook-endpoints | List webhook endpoints


## Documentation For Models

 - [Balance](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/Balance.md)
 - [ChatChoice](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/ChatChoice.md)
 - [ChatCompletionRequest](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/ChatCompletionRequest.md)
 - [ChatCompletionResponse](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/ChatCompletionResponse.md)
 - [ChatMessage](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/ChatMessage.md)
 - [CreateCryptoDepositRequest](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/CreateCryptoDepositRequest.md)
 - [CreateWebhookEndpointRequest](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/CreateWebhookEndpointRequest.md)
 - [CryptoDeposit](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/CryptoDeposit.md)
 - [Embedding](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/Embedding.md)
 - [EmbeddingsRequest](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/EmbeddingsRequest.md)
 - [EmbeddingsRequestInput](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/EmbeddingsRequestInput.md)
 - [EmbeddingsResponse](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/EmbeddingsResponse.md)
 - [EmbeddingsUsage](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/EmbeddingsUsage.md)
 - [GetHealth200Response](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/GetHealth200Response.md)
 - [ImagesGenerationsRequest](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/ImagesGenerationsRequest.md)
 - [ImagesResponse](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/ImagesResponse.md)
 - [ImagesResponseDataInner](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/ImagesResponseDataInner.md)
 - [ImagesResponseUsage](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/ImagesResponseUsage.md)
 - [InferencePreflight](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/InferencePreflight.md)
 - [ListDeposits200Response](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/ListDeposits200Response.md)
 - [Model](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/Model.md)
 - [ModelList](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/ModelList.md)
 - [ModelParametersInner](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/ModelParametersInner.md)
 - [ModelPricing](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/ModelPricing.md)
 - [ModelRate](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/ModelRate.md)
 - [OpenAIErrorEnvelope](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/OpenAIErrorEnvelope.md)
 - [OpenAIErrorEnvelopeError](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/OpenAIErrorEnvelopeError.md)
 - [Operation](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/Operation.md)
 - [OperationError](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/OperationError.md)
 - [OperationResult](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/OperationResult.md)
 - [PeakWindow](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/PeakWindow.md)
 - [Problem](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/Problem.md)
 - [RefereeStatus](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/RefereeStatus.md)
 - [Referral](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/Referral.md)
 - [SpendingLimit](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/SpendingLimit.md)
 - [StreamOptions](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/StreamOptions.md)
 - [Subscription](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/Subscription.md)
 - [SubscriptionCheckoutRequest](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/SubscriptionCheckoutRequest.md)
 - [SubscriptionCheckoutSession](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/SubscriptionCheckoutSession.md)
 - [SubscriptionPlan](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/SubscriptionPlan.md)
 - [SubscriptionPortalRequest](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/SubscriptionPortalRequest.md)
 - [SubscriptionPortalSession](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/SubscriptionPortalSession.md)
 - [SubscriptionPrice](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/SubscriptionPrice.md)
 - [SubscriptionQuota](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/SubscriptionQuota.md)
 - [SubscriptionUsage](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/SubscriptionUsage.md)
 - [UpdateSpendingLimitRequest](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/UpdateSpendingLimitRequest.md)
 - [Usage](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/Usage.md)
 - [UsageBucket](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/UsageBucket.md)
 - [UsagePage](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/UsagePage.md)
 - [VideoCreateRequest](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/VideoCreateRequest.md)
 - [VideoJob](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/VideoJob.md)
 - [VideoList](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/VideoList.md)
 - [WebhookEndpoint](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/WebhookEndpoint.md)
 - [WebhookEndpointPage](https://github.com/deeprelay-dev/deeprelay-python-sdk/blob/main/docs/WebhookEndpointPage.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

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


## Author

support@deeprelay.ai


