@deeprelay/sdk 0.2.0 → 0.3.0

package/docs/Model.md

@@ -13,15 +13,23 @@ Name | Type
 `author` | string
 `modality` | string
 `category` | string
+`tier` | string
 `contextLength` | number
+`maxCompletionTokens` | number
 `supportedParameters` | Array<string>
+`reasoningEfforts` | Array<string>
 `parameters` | [Array<ModelParametersInner>](ModelParametersInner.md)
 `pricing` | [ModelPricing](ModelPricing.md)
 `aliases` | Array<string>
 `fineTunable` | boolean
 `fineTuneBaseModel` | string
+`hfRepo` | string
+`usageFactorMilli` | number
 `planCovered` | boolean
+`recommendedFor` | Array<string>
+`codingAgentRank` | number
 `status` | string
+`metrics` | [ModelMetrics](ModelMetrics.md)
 
 ## Example
 
@@ -37,15 +45,23 @@ const example = {
   "author": null,
   "modality": null,
   "category": null,
+  "tier": null,
   "contextLength": null,
+  "maxCompletionTokens": null,
   "supportedParameters": null,
+  "reasoningEfforts": null,
   "parameters": null,
   "pricing": null,
   "aliases": null,
   "fineTunable": null,
   "fineTuneBaseModel": null,
+  "hfRepo": null,
+  "usageFactorMilli": null,
   "planCovered": null,
+  "recommendedFor": null,
+  "codingAgentRank": null,
   "status": null,
+  "metrics": null,
 } satisfies Model
 
 console.log(example)

package/docs/ModelMetrics.md

@@ -0,0 +1,55 @@
+
+# ModelMetrics
+
+Measured performance over a rolling window, from deeprelay\'s own customer traffic only. A figure is omitted (never zero) when it has too few samples behind it; the counts and minimums are always present so a reader can tell why.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`windowDays` | number
+`asOf` | Date
+`sampleCount` | number
+`streamSampleCount` | number
+`minSamples` | number
+`minStreamSamples` | number
+`ttftP50Ms` | number
+`tokensPerSecondP50` | number
+`successRate` | number
+`insufficientData` | boolean
+`precision` | string
+
+## Example
+
+```typescript
+import type { ModelMetrics } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "windowDays": null,
+  "asOf": null,
+  "sampleCount": null,
+  "streamSampleCount": null,
+  "minSamples": null,
+  "minStreamSamples": null,
+  "ttftP50Ms": null,
+  "tokensPerSecondP50": null,
+  "successRate": null,
+  "insufficientData": null,
+  "precision": null,
+} satisfies ModelMetrics
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ModelMetrics
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/OpenAIErrorEnvelopeError.md

@@ -10,6 +10,7 @@ Name | Type
 `type` | string
 `param` | string
 `code` | string
+`quotaFreesAt` | Date
 
 ## Example
 
@@ -22,6 +23,7 @@ const example = {
   "type": null,
   "param": null,
   "code": null,
+  "quotaFreesAt": null,
 } satisfies OpenAIErrorEnvelopeError
 
 console.log(example)

package/docs/Problem.md

@@ -12,6 +12,8 @@ Name | Type
 `detail` | string
 `code` | string
 `requestId` | string
+`field` | string
+`maxRows` | number
 
 ## Example
 
@@ -26,6 +28,8 @@ const example = {
   "detail": null,
   "code": null,
   "requestId": null,
+  "field": null,
+  "maxRows": null,
 } satisfies Problem
 
 console.log(example)

package/docs/Referral.md

@@ -13,10 +13,12 @@ Name | Type
 `qualified` | number
 `settled` | number
 `earnedCents` | number
+`commissionEarnedCents` | number
 `rewardCents` | number
 `refereeRewardCents` | number
 `qualifySpendCents` | number
 `holdDays` | number
+`commissionPct` | number
 `referred` | [RefereeStatus](RefereeStatus.md)
 
 ## Example
@@ -26,16 +28,18 @@ import type { Referral } from '@deeprelay/sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "code": GPU-7KQ2-M4XP,
-  "inviteUrl": https://deeprelay.ai/r/GPU-7KQ2-M4XP,
+  "code": DR-7KQ2-M4XP,
+  "inviteUrl": https://deeprelay.ai/r/DR-7KQ2-M4XP,
   "pending": null,
   "qualified": null,
   "settled": null,
   "earnedCents": null,
+  "commissionEarnedCents": null,
   "rewardCents": null,
   "refereeRewardCents": null,
   "qualifySpendCents": null,
   "holdDays": null,
+  "commissionPct": null,
   "referred": null,
 } satisfies Referral
 

package/docs/RequestLogEntry.md

@@ -0,0 +1,87 @@
+
+# RequestLogEntry
+
+One inference call as the request log records it. Never carries prompt or completion content. Optional numeric fields are omitted when they do not apply (for example token counts on a rejected call).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`requestId` | string
+`clientRequestId` | string
+`occurredAt` | Date
+`surface` | string
+`model` | string
+`keyId` | string
+`keyName` | string
+`keyPrefix` | string
+`status` | string
+`httpStatus` | number
+`errorCode` | string
+`finishReason` | string
+`promptTokens` | number
+`completionTokens` | number
+`cachedTokens` | number
+`reasoningTokens` | number
+`quotaUnits` | number
+`cost` | string
+`costMicroCents` | number
+`planCovered` | boolean
+`ttftMs` | number
+`durationMs` | number
+`ignoredParams` | Array<string>
+`hadToolCalls` | boolean
+`imageCount` | number
+`videoSeconds` | number
+`suppressedCount` | number
+
+## Example
+
+```typescript
+import type { RequestLogEntry } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "requestId": null,
+  "clientRequestId": null,
+  "occurredAt": null,
+  "surface": null,
+  "model": null,
+  "keyId": null,
+  "keyName": null,
+  "keyPrefix": null,
+  "status": null,
+  "httpStatus": null,
+  "errorCode": null,
+  "finishReason": null,
+  "promptTokens": null,
+  "completionTokens": null,
+  "cachedTokens": null,
+  "reasoningTokens": null,
+  "quotaUnits": null,
+  "cost": null,
+  "costMicroCents": null,
+  "planCovered": null,
+  "ttftMs": null,
+  "durationMs": null,
+  "ignoredParams": null,
+  "hadToolCalls": null,
+  "imageCount": null,
+  "videoSeconds": null,
+  "suppressedCount": null,
+} satisfies RequestLogEntry
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RequestLogEntry
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RequestLogPage.md

@@ -0,0 +1,38 @@
+
+# RequestLogPage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<RequestLogEntry>](RequestLogEntry.md)
+`nextCursor` | string
+`windowDays` | number
+
+## Example
+
+```typescript
+import type { RequestLogPage } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "nextCursor": null,
+  "windowDays": null,
+} satisfies RequestLogPage
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RequestLogPage
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RequestsApi.md

@@ -0,0 +1,282 @@
+# RequestsApi
+
+All URIs are relative to *https://api.deeprelay.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**exportRequests**](RequestsApi.md#exportrequests) | **GET** /requests/export | Export the request log as CSV |
+| [**getRequest**](RequestsApi.md#getrequest) | **GET** /requests/{id} | Get one request |
+| [**listRequests**](RequestsApi.md#listrequests) | **GET** /requests | List requests (the request log) |
+
+
+
+## exportRequests
+
+> string exportRequests(key, model, surface, status, errorCode, clientRequestId, from, to)
+
+Export the request log as CSV
+
+Streams every request-log row matching the filters as a CSV attachment, oldest columns first: `request_id, client_request_id, occurred_at, surface, model, key_id, key_name, key_prefix, status, http_status, error_code, finish_reason, prompt_tokens, completion_tokens, cached_tokens, reasoning_tokens, quota_units, cost, plan_covered, ttft_ms, duration_ms, ignored_params`. Takes the same filters and visibility rules as `GET /requests`, without the cursor and limit.  The export is counted before anything is written. When the filters match more rows than the export cap, the answer is 422 `export_too_large` and the problem body carries `max_rows`; narrow the time range or add a filter, then export again.  Requires the `serverless:read` scope. Exports have their own, tighter per-key rate limit. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RequestsApi,
+} from '@deeprelay/sdk';
+import type { ExportRequestsRequest } 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 RequestsApi(config);
+
+  const body = {
+    // string | Only rows sent with this API key (its `api_key_id`). (optional)
+    key: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Only rows for this model id. (optional)
+    model: model_example,
+    // 'chat' | 'messages' | 'responses' | 'embeddings' | 'image' | 'video' | Only rows from this endpoint family. (optional)
+    surface: surface_example,
+    // 'ok' | 'error' | 'cancelled' | 'rejected' | Only rows with this outcome. `rejected` is a call refused before it reached a model (a budget, limit, allowlist or quota gate). (optional)
+    status: status_example,
+    // string | Only rows that ended with this `X-Deeprelay-Error-Code`. (optional)
+    errorCode: errorCode_example,
+    // string | Only rows whose `X-Client-Request-Id` equals this value. (optional)
+    clientRequestId: clientRequestId_example,
+    // Date | Inclusive RFC 3339 range start. Defaults to the start of the 90-day window; an older value is clamped to it. (optional)
+    from: 2013-10-20T19:20:30+01:00,
+    // Date | Exclusive RFC 3339 range end. Defaults to now; must be after `from`. (optional)
+    to: 2013-10-20T19:20:30+01:00,
+  } satisfies ExportRequestsRequest;
+
+  try {
+    const data = await api.exportRequests(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **key** | `string` | Only rows sent with this API key (its `api_key_id`). | [Optional] [Defaults to `undefined`] |
+| **model** | `string` | Only rows for this model id. | [Optional] [Defaults to `undefined`] |
+| **surface** | `chat`, `messages`, `responses`, `embeddings`, `image`, `video` | Only rows from this endpoint family. | [Optional] [Defaults to `undefined`] [Enum: chat, messages, responses, embeddings, image, video] |
+| **status** | `ok`, `error`, `cancelled`, `rejected` | Only rows with this outcome. `rejected` is a call refused before it reached a model (a budget, limit, allowlist or quota gate). | [Optional] [Defaults to `undefined`] [Enum: ok, error, cancelled, rejected] |
+| **errorCode** | `string` | Only rows that ended with this `X-Deeprelay-Error-Code`. | [Optional] [Defaults to `undefined`] |
+| **clientRequestId** | `string` | Only rows whose `X-Client-Request-Id` equals this value. | [Optional] [Defaults to `undefined`] |
+| **from** | `Date` | Inclusive RFC 3339 range start. Defaults to the start of the 90-day window; an older value is clamped to it. | [Optional] [Defaults to `undefined`] |
+| **to** | `Date` | Exclusive RFC 3339 range end. Defaults to now; must be after `from`. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+**string**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/csv`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | CSV attachment (`Content-Disposition` names the file). |  -  |
+| **400** | Error response (RFC 7807) |  -  |
+| **422** | `export_too_large`: the filters match more rows than the export cap. `max_rows` in the problem body is the cap. |  -  |
+| **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)
+
+
+## getRequest
+
+> RequestLogEntry getRequest(id)
+
+Get one request
+
+Returns one request-log row. An unknown id, an id older than 90 days and an id the caller cannot see all answer the same 404. Requires the &#x60;serverless:read&#x60; scope. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RequestsApi,
+} from '@deeprelay/sdk';
+import type { GetRequestRequest } 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 RequestsApi(config);
+
+  const body = {
+    // string | Any id the caller holds for the request: the `X-Request-Id` response header, a chat completion id (`chatcmpl-…`), a message id (`msg_…`), a response id (`resp_…`) or a video id.
+    id: id_example,
+  } satisfies GetRequestRequest;
+
+  try {
+    const data = await api.getRequest(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Any id the caller holds for the request: the &#x60;X-Request-Id&#x60; response header, a chat completion id (&#x60;chatcmpl-…&#x60;), a message id (&#x60;msg_…&#x60;), a response id (&#x60;resp_…&#x60;) or a video id. | [Defaults to `undefined`] |
+
+### Return type
+
+[**RequestLogEntry**](RequestLogEntry.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 |  -  |
+| **404** | Error response (RFC 7807) |  -  |
+| **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)
+
+
+## listRequests
+
+> RequestLogPage listRequests(key, model, surface, status, errorCode, clientRequestId, from, to, cursor, limit)
+
+List requests (the request log)
+
+Returns one newest-first page of the organization\&#39;s inference request log: one row per call to chat completions, messages, responses, embeddings, image generation or video creation, including calls that were refused before they reached a model (&#x60;status: rejected&#x60;). Rows are kept for 90 days; &#x60;window_days&#x60; says how far back the log reaches, and a &#x60;from&#x60; older than that is clamped rather than rejected.  Visibility follows the caller. An org admin\&#39;s key and a &#x60;full_access&#x60; key see the whole organization; any other key sees only its own rows. A &#x60;key&#x60; filter naming a key the caller cannot see returns an empty page.  A row never carries prompt or completion content. &#x60;client_request_id&#x60; is the value the caller sent in &#x60;X-Client-Request-Id&#x60; (or &#x60;metadata.client_request_id&#x60; on &#x60;/responses&#x60;), kept for correlation.  Requires the &#x60;serverless:read&#x60; scope. Reads are rate-limited per key (429 &#x60;rate_limited&#x60; with Retry-After). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RequestsApi,
+} from '@deeprelay/sdk';
+import type { ListRequestsRequest } 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 RequestsApi(config);
+
+  const body = {
+    // string | Only rows sent with this API key (its `api_key_id`). (optional)
+    key: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Only rows for this model id. (optional)
+    model: model_example,
+    // 'chat' | 'messages' | 'responses' | 'embeddings' | 'image' | 'video' | Only rows from this endpoint family. (optional)
+    surface: surface_example,
+    // 'ok' | 'error' | 'cancelled' | 'rejected' | Only rows with this outcome. `rejected` is a call refused before it reached a model (a budget, limit, allowlist or quota gate). (optional)
+    status: status_example,
+    // string | Only rows that ended with this `X-Deeprelay-Error-Code`. (optional)
+    errorCode: errorCode_example,
+    // string | Only rows whose `X-Client-Request-Id` equals this value. (optional)
+    clientRequestId: clientRequestId_example,
+    // Date | Inclusive RFC 3339 range start. Defaults to the start of the 90-day window; an older value is clamped to it. (optional)
+    from: 2013-10-20T19:20:30+01:00,
+    // Date | Exclusive RFC 3339 range end. Defaults to now; must be after `from`. (optional)
+    to: 2013-10-20T19:20:30+01:00,
+    // string (optional)
+    cursor: cursor_example,
+    // number | Page size. Defaults to 50; values above 100 are clamped to 100. (optional)
+    limit: 56,
+  } satisfies ListRequestsRequest;
+
+  try {
+    const data = await api.listRequests(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **key** | `string` | Only rows sent with this API key (its &#x60;api_key_id&#x60;). | [Optional] [Defaults to `undefined`] |
+| **model** | `string` | Only rows for this model id. | [Optional] [Defaults to `undefined`] |
+| **surface** | `chat`, `messages`, `responses`, `embeddings`, `image`, `video` | Only rows from this endpoint family. | [Optional] [Defaults to `undefined`] [Enum: chat, messages, responses, embeddings, image, video] |
+| **status** | `ok`, `error`, `cancelled`, `rejected` | Only rows with this outcome. &#x60;rejected&#x60; is a call refused before it reached a model (a budget, limit, allowlist or quota gate). | [Optional] [Defaults to `undefined`] [Enum: ok, error, cancelled, rejected] |
+| **errorCode** | `string` | Only rows that ended with this &#x60;X-Deeprelay-Error-Code&#x60;. | [Optional] [Defaults to `undefined`] |
+| **clientRequestId** | `string` | Only rows whose &#x60;X-Client-Request-Id&#x60; equals this value. | [Optional] [Defaults to `undefined`] |
+| **from** | `Date` | Inclusive RFC 3339 range start. Defaults to the start of the 90-day window; an older value is clamped to it. | [Optional] [Defaults to `undefined`] |
+| **to** | `Date` | Exclusive RFC 3339 range end. Defaults to now; must be after &#x60;from&#x60;. | [Optional] [Defaults to `undefined`] |
+| **cursor** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` | Page size. Defaults to 50; values above 100 are clamped to 100. | [Optional] [Defaults to `50`] |
+
+### Return type
+
+[**RequestLogPage**](RequestLogPage.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 |  -  |
+| **400** | Error response (RFC 7807) |  -  |
+| **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)
+

package/docs/ResponseFormatJSONObject.md

@@ -0,0 +1,35 @@
+
+# ResponseFormatJSONObject
+
+The reply is a single valid JSON object.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+
+## Example
+
+```typescript
+import type { ResponseFormatJSONObject } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+} satisfies ResponseFormatJSONObject
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ResponseFormatJSONObject
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ResponseFormatJSONSchema.md

@@ -0,0 +1,36 @@
+
+# ResponseFormatJSONSchema
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`jsonSchema` | [JSONSchemaFormat](JSONSchemaFormat.md)
+
+## Example
+
+```typescript
+import type { ResponseFormatJSONSchema } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "jsonSchema": null,
+} satisfies ResponseFormatJSONSchema
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ResponseFormatJSONSchema
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ResponseFormatText.md

@@ -0,0 +1,34 @@
+
+# ResponseFormatText
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+
+## Example
+
+```typescript
+import type { ResponseFormatText } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+} satisfies ResponseFormatText
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ResponseFormatText
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+