@deeprelay/sdk 0.1.0 → 0.1.2

package/dist/models/SubscriptionCheckoutSession.js

@@ -0,0 +1,59 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * deeprelay Public Developer API
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@deeprelay.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfSubscriptionCheckoutSession = instanceOfSubscriptionCheckoutSession;
+exports.SubscriptionCheckoutSessionFromJSON = SubscriptionCheckoutSessionFromJSON;
+exports.SubscriptionCheckoutSessionFromJSONTyped = SubscriptionCheckoutSessionFromJSONTyped;
+exports.SubscriptionCheckoutSessionToJSON = SubscriptionCheckoutSessionToJSON;
+exports.SubscriptionCheckoutSessionToJSONTyped = SubscriptionCheckoutSessionToJSONTyped;
+const SubscriptionPlan_1 = require("./SubscriptionPlan");
+/**
+ * Check if a given object implements the SubscriptionCheckoutSession interface.
+ */
+function instanceOfSubscriptionCheckoutSession(value) {
+    if ((!('checkoutUrl' in value) && !('checkout_url' in value)) || (value['checkoutUrl'] === undefined && value['checkout_url'] === undefined))
+        return false;
+    if ((!('sessionId' in value) && !('session_id' in value)) || (value['sessionId'] === undefined && value['session_id'] === undefined))
+        return false;
+    if (!('plan' in value) || value['plan'] === undefined)
+        return false;
+    return true;
+}
+function SubscriptionCheckoutSessionFromJSON(json) {
+    return SubscriptionCheckoutSessionFromJSONTyped(json, false);
+}
+function SubscriptionCheckoutSessionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'checkoutUrl': json['checkout_url'],
+        'sessionId': json['session_id'],
+        'plan': (0, SubscriptionPlan_1.SubscriptionPlanFromJSON)(json['plan']),
+    };
+}
+function SubscriptionCheckoutSessionToJSON(json) {
+    return SubscriptionCheckoutSessionToJSONTyped(json, false);
+}
+function SubscriptionCheckoutSessionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'checkout_url': value['checkoutUrl'],
+        'session_id': value['sessionId'],
+        'plan': (0, SubscriptionPlan_1.SubscriptionPlanToJSON)(value['plan']),
+    };
+}

package/dist/models/SubscriptionPortalRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * deeprelay Public Developer API
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@deeprelay.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Optional overrides for a billing-portal mint.
+ * @export
+ * @interface SubscriptionPortalRequest
+ */
+export interface SubscriptionPortalRequest {
+    /**
+     * Where the provider returns when the customer leaves the portal. Defaults to the deployment's configured URL.
+     * @type {string}
+     * @memberof SubscriptionPortalRequest
+     */
+    returnUrl?: string;
+}
+/**
+ * Check if a given object implements the SubscriptionPortalRequest interface.
+ */
+export declare function instanceOfSubscriptionPortalRequest(value: object): value is SubscriptionPortalRequest;
+export declare function SubscriptionPortalRequestFromJSON(json: any): SubscriptionPortalRequest;
+export declare function SubscriptionPortalRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionPortalRequest;
+export declare function SubscriptionPortalRequestToJSON(json: any): SubscriptionPortalRequest;
+export declare function SubscriptionPortalRequestToJSONTyped(value?: SubscriptionPortalRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/SubscriptionPortalRequest.js

@@ -0,0 +1,48 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * deeprelay Public Developer API
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@deeprelay.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfSubscriptionPortalRequest = instanceOfSubscriptionPortalRequest;
+exports.SubscriptionPortalRequestFromJSON = SubscriptionPortalRequestFromJSON;
+exports.SubscriptionPortalRequestFromJSONTyped = SubscriptionPortalRequestFromJSONTyped;
+exports.SubscriptionPortalRequestToJSON = SubscriptionPortalRequestToJSON;
+exports.SubscriptionPortalRequestToJSONTyped = SubscriptionPortalRequestToJSONTyped;
+/**
+ * Check if a given object implements the SubscriptionPortalRequest interface.
+ */
+function instanceOfSubscriptionPortalRequest(value) {
+    return true;
+}
+function SubscriptionPortalRequestFromJSON(json) {
+    return SubscriptionPortalRequestFromJSONTyped(json, false);
+}
+function SubscriptionPortalRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'returnUrl': json['return_url'] == null ? undefined : json['return_url'],
+    };
+}
+function SubscriptionPortalRequestToJSON(json) {
+    return SubscriptionPortalRequestToJSONTyped(json, false);
+}
+function SubscriptionPortalRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'return_url': value['returnUrl'],
+    };
+}

package/dist/models/SubscriptionPortalSession.d.ts

@@ -0,0 +1,32 @@
+/**
+ * deeprelay Public Developer API
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@deeprelay.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SubscriptionPortalSession
+ */
+export interface SubscriptionPortalSession {
+    /**
+     * The hosted billing portal — cancel, resume, change payment method, download invoices.
+     * @type {string}
+     * @memberof SubscriptionPortalSession
+     */
+    portalUrl: string;
+}
+/**
+ * Check if a given object implements the SubscriptionPortalSession interface.
+ */
+export declare function instanceOfSubscriptionPortalSession(value: object): value is SubscriptionPortalSession;
+export declare function SubscriptionPortalSessionFromJSON(json: any): SubscriptionPortalSession;
+export declare function SubscriptionPortalSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionPortalSession;
+export declare function SubscriptionPortalSessionToJSON(json: any): SubscriptionPortalSession;
+export declare function SubscriptionPortalSessionToJSONTyped(value?: SubscriptionPortalSession | null, ignoreDiscriminator?: boolean): any;

package/dist/models/SubscriptionPortalSession.js

@@ -0,0 +1,50 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * deeprelay Public Developer API
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@deeprelay.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfSubscriptionPortalSession = instanceOfSubscriptionPortalSession;
+exports.SubscriptionPortalSessionFromJSON = SubscriptionPortalSessionFromJSON;
+exports.SubscriptionPortalSessionFromJSONTyped = SubscriptionPortalSessionFromJSONTyped;
+exports.SubscriptionPortalSessionToJSON = SubscriptionPortalSessionToJSON;
+exports.SubscriptionPortalSessionToJSONTyped = SubscriptionPortalSessionToJSONTyped;
+/**
+ * Check if a given object implements the SubscriptionPortalSession interface.
+ */
+function instanceOfSubscriptionPortalSession(value) {
+    if ((!('portalUrl' in value) && !('portal_url' in value)) || (value['portalUrl'] === undefined && value['portal_url'] === undefined))
+        return false;
+    return true;
+}
+function SubscriptionPortalSessionFromJSON(json) {
+    return SubscriptionPortalSessionFromJSONTyped(json, false);
+}
+function SubscriptionPortalSessionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'portalUrl': json['portal_url'],
+    };
+}
+function SubscriptionPortalSessionToJSON(json) {
+    return SubscriptionPortalSessionToJSONTyped(json, false);
+}
+function SubscriptionPortalSessionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'portal_url': value['portalUrl'],
+    };
+}

package/dist/models/VideoJob.d.ts

@@ -81,6 +81,12 @@ export interface VideoJob {
      * @memberof VideoJob
      */
     error?: string;
+    /**
+     * Human-readable reason behind `error`, when the upstream supplied one. `error` classifies the failure, `error_message` explains it (for example a requested duration outside the model's supported range). Sanitized before storage; only ever present alongside `error`.
+     * @type {string}
+     * @memberof VideoJob
+     */
+    errorMessage?: string;
     /**
      * Final billed cost in cents; present once the job completes (failed/cancelled jobs are never billed).
      * @type {number}

package/dist/models/VideoJob.js

@@ -75,6 +75,7 @@ function VideoJobFromJSONTyped(json, ignoreDiscriminator) {
         'completedAt': json['completed_at'] == null ? undefined : json['completed_at'],
         'expiresAt': json['expires_at'] == null ? undefined : json['expires_at'],
         'error': json['error'] == null ? undefined : json['error'],
+        'errorMessage': json['error_message'] == null ? undefined : json['error_message'],
         'costCents': json['cost_cents'] == null ? undefined : json['cost_cents'],
     };
 }
@@ -97,6 +98,7 @@ function VideoJobToJSONTyped(value, ignoreDiscriminator = false) {
         'completed_at': value['completedAt'],
         'expires_at': value['expiresAt'],
         'error': value['error'],
+        'error_message': value['errorMessage'],
         'cost_cents': value['costCents'],
     };
 }

package/dist/models/index.d.ts

@@ -16,6 +16,7 @@ export * from './ImagesGenerationsRequest';
 export * from './ImagesResponse';
 export * from './ImagesResponseDataInner';
 export * from './ImagesResponseUsage';
+export * from './InferencePreflight';
 export * from './ListDeposits200Response';
 export * from './Model';
 export * from './ModelList';
@@ -29,10 +30,16 @@ export * from './OperationError';
 export * from './OperationResult';
 export * from './PeakWindow';
 export * from './Problem';
+export * from './RefereeStatus';
+export * from './Referral';
 export * from './SpendingLimit';
 export * from './StreamOptions';
 export * from './Subscription';
+export * from './SubscriptionCheckoutRequest';
+export * from './SubscriptionCheckoutSession';
 export * from './SubscriptionPlan';
+export * from './SubscriptionPortalRequest';
+export * from './SubscriptionPortalSession';
 export * from './SubscriptionPrice';
 export * from './SubscriptionQuota';
 export * from './SubscriptionUsage';

package/dist/models/index.js

@@ -34,6 +34,7 @@ __exportStar(require("./ImagesGenerationsRequest"), exports);
 __exportStar(require("./ImagesResponse"), exports);
 __exportStar(require("./ImagesResponseDataInner"), exports);
 __exportStar(require("./ImagesResponseUsage"), exports);
+__exportStar(require("./InferencePreflight"), exports);
 __exportStar(require("./ListDeposits200Response"), exports);
 __exportStar(require("./Model"), exports);
 __exportStar(require("./ModelList"), exports);
@@ -47,10 +48,16 @@ __exportStar(require("./OperationError"), exports);
 __exportStar(require("./OperationResult"), exports);
 __exportStar(require("./PeakWindow"), exports);
 __exportStar(require("./Problem"), exports);
+__exportStar(require("./RefereeStatus"), exports);
+__exportStar(require("./Referral"), exports);
 __exportStar(require("./SpendingLimit"), exports);
 __exportStar(require("./StreamOptions"), exports);
 __exportStar(require("./Subscription"), exports);
+__exportStar(require("./SubscriptionCheckoutRequest"), exports);
+__exportStar(require("./SubscriptionCheckoutSession"), exports);
 __exportStar(require("./SubscriptionPlan"), exports);
+__exportStar(require("./SubscriptionPortalRequest"), exports);
+__exportStar(require("./SubscriptionPortalSession"), exports);
 __exportStar(require("./SubscriptionPrice"), exports);
 __exportStar(require("./SubscriptionQuota"), exports);
 __exportStar(require("./SubscriptionUsage"), exports);

package/dist/runtime.js

@@ -69,7 +69,7 @@ class Configuration {
         return undefined;
     }
     get headers() {
-        return Object.assign({ 'User-Agent': 'deeprelay-sdk-ts/0.1.0' }, this.configuration.headers);
+        return Object.assign({ 'User-Agent': 'deeprelay-sdk-ts/0.1.2' }, this.configuration.headers);
     }
     get credentials() {
         return this.configuration.credentials;

package/docs/BillingApi.md

@@ -5,8 +5,11 @@ All URIs are relative to *https://api.deeprelay.ai/v1*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**createCryptoDeposit**](BillingApi.md#createcryptodepositoperation) | **POST** /billing/deposits/crypto | Create a stablecoin deposit |
+| [**createSubscriptionCheckout**](BillingApi.md#createsubscriptioncheckout) | **POST** /billing/subscription/checkout | Start a subscription checkout session |
+| [**createSubscriptionPortal**](BillingApi.md#createsubscriptionportal) | **POST** /billing/subscription/portal | Open the billing portal to cancel or manage the subscription |
 | [**getBalance**](BillingApi.md#getbalance) | **GET** /billing/balance | Get the org credit balance |
 | [**getDeposit**](BillingApi.md#getdeposit) | **GET** /billing/deposits/{id} | Get one stablecoin deposit |
+| [**getReferral**](BillingApi.md#getreferral) | **GET** /referrals | Get the org referral code, invite link, terms and stats |
 | [**getSpendingLimit**](BillingApi.md#getspendinglimit) | **GET** /billing/spending-limit | Get the org spending limit |
 | [**getSubscription**](BillingApi.md#getsubscription) | **GET** /billing/subscription | Get the org subscription status and quota usage |
 | [**listDeposits**](BillingApi.md#listdeposits) | **GET** /billing/deposits | List stablecoin deposits |
@@ -91,6 +94,158 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## createSubscriptionCheckout
+
+> SubscriptionCheckoutSession createSubscriptionCheckout(subscriptionCheckoutRequest)
+
+Start a subscription checkout session
+
+Opens a hosted checkout session for the flat tier and returns its URL. Requires the `billing:write` scope AND organization-admin privileges — subscribing spends organization money.  This endpoint does NOT subscribe anyone. Checkout is a hosted page that needs a browser and a card, so the caller\'s job is to put the returned URL in front of a human. The subscription becomes active when payment completes, which is not synchronous with this call: poll `/billing/subscription` to confirm.  `success_url` and `cancel_url` are optional and fall back to the deployment\'s configured redirects, which is what lets a command-line client start a purchase without having any URLs of its own. An empty request body is valid and means \"use every default\".  `plan_key`, when sent, pins the plan the client DISPLAYED: an unknown key is a 400 rather than a silent purchase of a different tier. Today there is one tier, so the only accepted value is its key — but sending it is the forward-compatible choice.  One flat tier means at most one subscription per organization: a second checkout while an entitling subscription exists is a 409. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BillingApi,
+} from '@deeprelay/sdk';
+import type { CreateSubscriptionCheckoutRequest } from '@deeprelay/sdk';
+
+async function example() {
+  console.log("🚀 Testing @deeprelay/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BillingApi(config);
+
+  const body = {
+    // SubscriptionCheckoutRequest (optional)
+    subscriptionCheckoutRequest: ...,
+  } satisfies CreateSubscriptionCheckoutRequest;
+
+  try {
+    const data = await api.createSubscriptionCheckout(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **subscriptionCheckoutRequest** | [SubscriptionCheckoutRequest](SubscriptionCheckoutRequest.md) |  | [Optional] |
+
+### Return type
+
+[**SubscriptionCheckoutSession**](SubscriptionCheckoutSession.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **403** | Not an organization admin |  -  |
+| **409** | The organization already has an active subscription |  -  |
+| **503** | Subscription billing is not configured on this deployment |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createSubscriptionPortal
+
+> SubscriptionPortalSession createSubscriptionPortal(subscriptionPortalRequest)
+
+Open the billing portal to cancel or manage the subscription
+
+Returns a URL for the hosted billing portal: where a customer cancels the subscription, resumes one they cancelled, changes payment method, or downloads invoices. Requires the &#x60;billing:write&#x60; scope AND organization-admin privileges.  Cancellation lives here rather than on its own endpoint because it is one surface with the rest of the billing lifecycle. The common reason a subscription is about to lapse is a declined card, and the fix for that is a new card, not a cancellation — sending a customer somewhere that can only cancel would lose renewals.  Cancelling in the portal ends the subscription at the close of the current period; coverage continues until then and &#x60;/billing/subscription&#x60; reports &#x60;cancel_at_period_end: true&#x60;.  An organization that has never paid for anything gets 404: there is no billing account to manage, and this endpoint deliberately does not create one as a side effect of looking. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BillingApi,
+} from '@deeprelay/sdk';
+import type { CreateSubscriptionPortalRequest } from '@deeprelay/sdk';
+
+async function example() {
+  console.log("🚀 Testing @deeprelay/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BillingApi(config);
+
+  const body = {
+    // SubscriptionPortalRequest (optional)
+    subscriptionPortalRequest: ...,
+  } satisfies CreateSubscriptionPortalRequest;
+
+  try {
+    const data = await api.createSubscriptionPortal(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **subscriptionPortalRequest** | [SubscriptionPortalRequest](SubscriptionPortalRequest.md) |  | [Optional] |
+
+### Return type
+
+[**SubscriptionPortalSession**](SubscriptionPortalSession.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **403** | Not an organization admin |  -  |
+| **404** | The organization has no billing account yet |  -  |
+| **503** | Subscription billing is not configured on this deployment |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getBalance
 
 > Balance getBalance()
@@ -230,6 +385,71 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getReferral
+
+> Referral getReferral()
+
+Get the org referral code, invite link, terms and stats
+
+Returns the organization\&#39;s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\&#39;s stats, and — when this organization itself signed up through someone else\&#39;s link — its own progress toward the referee reward. Requires the &#x60;billing:read&#x60; scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends &#x60;qualify_spend_cents&#x60; on inference, the referrer receives &#x60;reward_cents&#x60; and the friend receives &#x60;referee_reward_cents&#x60;, both as non-withdrawable credit, after a &#x60;hold_days&#x60; chargeback hold. The terms ride on the wire so a client never hard-codes the amounts.  &#x60;referred&#x60; is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\&#39;s referral card reads. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BillingApi,
+} from '@deeprelay/sdk';
+import type { GetReferralRequest } from '@deeprelay/sdk';
+
+async function example() {
+  console.log("🚀 Testing @deeprelay/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BillingApi(config);
+
+  try {
+    const data = await api.getReferral();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Referral**](Referral.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getSpendingLimit
 
 > SpendingLimit getSpendingLimit()

package/docs/InferenceApi.md

@@ -12,6 +12,7 @@ All URIs are relative to *https://api.deeprelay.ai/v1*
 | [**getModel**](InferenceApi.md#getmodel) | **GET** /models/{id} | Get a specific model (OpenAI-compatible) |
 | [**getVideo**](InferenceApi.md#getvideo) | **GET** /videos/{id} | Get a video generation job |
 | [**getVideoContent**](InferenceApi.md#getvideocontent) | **GET** /videos/{id}/content | Download a completed video artifact |
+| [**inferencePreflight**](InferenceApi.md#inferencepreflight) | **GET** /inference/preflight | Check whether a model request would be served, and at whose expense |
 | [**listModels**](InferenceApi.md#listmodels) | **GET** /models | List available models (OpenAI-compatible) |
 | [**listVideos**](InferenceApi.md#listvideos) | **GET** /videos | List video generation jobs |
 
@@ -638,6 +639,79 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## inferencePreflight
+
+> InferencePreflight inferencePreflight(model)
+
+Check whether a model request would be served, and at whose expense
+
+Answers \"what happens if I call this model right now?\" before the call is made: whether the plan covers the model, whether the organization is subscribed, and whether there is credit to pay if it is not covered. Requires the `serverless:read` scope.  Nothing is sent, counted, charged, or reserved. The verdict is computed from the state of the SAME gates that judge the real request — plan coverage, subscription entitlement, remaining plan quota, credit balance and self-set spending caps — so the advice cannot drift from enforcement. It is deliberately NOT a dry run: no per-request cost estimate is quoted, because that figure changes with every prompt and quoting it would invite clients to cache it.  The gates consulted depend on the model\'s MODALITY, because the endpoints do not all meet the same ones. Chat, embeddings and image requests meet the full gate (balance, then the organization\'s opt-in daily cap, then its monthly cap). Video creation meets only the balance check, so an organization past its own spending cap but holding credit is reported as fundable for video — which is what the video endpoint will in fact do. Predicting the strictest gate rather than the applicable one would make this endpoint refuse requests the API accepts.  The same is true of the plan: video creation does not run the subscription gate, so `plan_covered` is false for a video model even if an operator has placed it on the plan\'s covered list. That is a deliberate divergence from the same-named field on `/v1/models`, which reports the platform\'s configuration. Here it means \"the plan covers this REQUEST\" — describing what will happen is the entire job of a preflight.  One caveat on \"read-only\": resolving the balance creates the organization\'s balance row if it has never had one (idempotent, org-scoped, and the same row the first real request would create). Nothing else is written.  The case this exists for is `warn` / `not_plan_covered`. A subscriber calling a model outside the plan IS served and IS charged pay-as-you-go, and nothing in the response to that request says so — the first signal used to be the invoice.  `funded` is a boolean and never a figure. This route is on the inference read scope, so it must not disclose the organization\'s balance; use `/billing/balance` for the number.  Failure posture is the opposite of the request gate\'s: any gate that cannot be read degrades the verdict toward `ok`, never toward `block`. A false `block` would stop a customer whose request would have succeeded, while a false `ok` costs them one honest error from the real call. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InferenceApi,
+} from '@deeprelay/sdk';
+import type { InferencePreflightRequest } from '@deeprelay/sdk';
+
+async function example() {
+  console.log("🚀 Testing @deeprelay/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new InferenceApi(config);
+
+  const body = {
+    // string | Model id or alias, optionally with a `:economy` tier suffix. It is resolved through the catalog exactly as the inference endpoints resolve it, so an alias and a tier view answer for the model that would actually serve.
+    model: model_example,
+  } satisfies InferencePreflightRequest;
+
+  try {
+    const data = await api.inferencePreflight(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **model** | `string` | Model id or alias, optionally with a `:economy` tier suffix. It is resolved through the catalog exactly as the inference endpoints resolve it, so an alias and a tier view answer for the model that would actually serve. | [Defaults to `undefined`] |
+
+### Return type
+
+[**InferencePreflight**](InferencePreflight.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **404** | Model or resource not found (OpenAI error envelope). |  -  |
+| **429** | Rate limit exceeded (OpenAI error envelope). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## listModels
 
 > ModelList listModels(modality)