@cherryin/aigw-api-client 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +180 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +289 -0
- package/api.ts +8041 -0
- package/base.ts +62 -0
- package/common.ts +113 -0
- package/configuration.ts +121 -0
- package/dist/api.d.ts +4760 -0
- package/dist/api.js +5694 -0
- package/dist/base.d.ts +42 -0
- package/dist/base.js +46 -0
- package/dist/common.d.ts +28 -0
- package/dist/common.js +124 -0
- package/dist/configuration.d.ts +98 -0
- package/dist/configuration.js +44 -0
- package/dist/esm/api.d.ts +4760 -0
- package/dist/esm/api.js +5638 -0
- package/dist/esm/base.d.ts +42 -0
- package/dist/esm/base.js +41 -0
- package/dist/esm/common.d.ts +28 -0
- package/dist/esm/common.js +112 -0
- package/dist/esm/configuration.d.ts +98 -0
- package/dist/esm/configuration.js +40 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.js +15 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- package/docs/AIModelAdminServiceApi.md +454 -0
- package/docs/AIModelPricingConfig.md +36 -0
- package/docs/AdminAIModel.md +72 -0
- package/docs/AdminAIModelCheckConnectionResponse.md +24 -0
- package/docs/AdminAIModelCheckItem.md +32 -0
- package/docs/AdminAIModelCheckResult.md +22 -0
- package/docs/AdminAIModelCreateRequest.md +66 -0
- package/docs/AdminAIModelCreateResponse.md +24 -0
- package/docs/AdminAIModelDeleteResponse.md +22 -0
- package/docs/AdminAIModelDisableRequest.md +22 -0
- package/docs/AdminAIModelDisableResponse.md +24 -0
- package/docs/AdminAIModelDiscountConfig.md +20 -0
- package/docs/AdminAIModelGetResponse.md +24 -0
- package/docs/AdminAIModelListResponse.md +26 -0
- package/docs/AdminAIModelProviderConfigItem.md +28 -0
- package/docs/AdminAIModelPublishRequest.md +22 -0
- package/docs/AdminAIModelPublishResponse.md +24 -0
- package/docs/AdminAIModelUpdateRequest.md +24 -0
- package/docs/AdminAIModelUpdateResponse.md +24 -0
- package/docs/AdminAPIToken.md +40 -0
- package/docs/AdminAPITokenCreateRequest.md +24 -0
- package/docs/AdminAPITokenCreateResponse.md +26 -0
- package/docs/AdminAPITokenDeleteResponse.md +22 -0
- package/docs/AdminAPITokenGetResponse.md +24 -0
- package/docs/AdminAPITokenListResponse.md +26 -0
- package/docs/AdminAPITokenRefreshRequest.md +20 -0
- package/docs/AdminAPITokenRefreshResponse.md +26 -0
- package/docs/AdminAPITokenScopes.md +24 -0
- package/docs/AdminAPITokenServiceApi.md +325 -0
- package/docs/AdminAPITokenUpdateRequest.md +28 -0
- package/docs/AdminAPITokenUpdateResponse.md +24 -0
- package/docs/AdminProvider.md +46 -0
- package/docs/AdminProviderCreateRequest.md +40 -0
- package/docs/AdminProviderCreateResponse.md +24 -0
- package/docs/AdminProviderDeleteResponse.md +22 -0
- package/docs/AdminProviderGetResponse.md +24 -0
- package/docs/AdminProviderListResponse.md +26 -0
- package/docs/AdminProviderModel.md +68 -0
- package/docs/AdminProviderModelCreateRequest.md +62 -0
- package/docs/AdminProviderModelCreateResponse.md +24 -0
- package/docs/AdminProviderModelDeleteResponse.md +22 -0
- package/docs/AdminProviderModelGetResponse.md +24 -0
- package/docs/AdminProviderModelListResponse.md +26 -0
- package/docs/AdminProviderModelUpdateRequest.md +26 -0
- package/docs/AdminProviderModelUpdateResponse.md +24 -0
- package/docs/AdminProviderUpdateRequest.md +26 -0
- package/docs/AdminProviderUpdateResponse.md +24 -0
- package/docs/AigwpbLabel.md +28 -0
- package/docs/AigwpbUserMeInfo.md +24 -0
- package/docs/AigwpbUserPayStripeCheckout.md +20 -0
- package/docs/AigwpbUserPortalDashboard.md +24 -0
- package/docs/Any.md +20 -0
- package/docs/AudioPricing.md +32 -0
- package/docs/BatchUpdateSessionsRequest.md +24 -0
- package/docs/BatchUpdateSessionsResponse.md +24 -0
- package/docs/CodeExecutionPricing.md +24 -0
- package/docs/DiscountAdminServiceApi.md +275 -0
- package/docs/DiscountCreateRequest.md +36 -0
- package/docs/DiscountDeleteResponse.md +22 -0
- package/docs/DiscountGetResponse.md +24 -0
- package/docs/DiscountInfo.md +42 -0
- package/docs/DiscountListResponse.md +26 -0
- package/docs/DiscountUpdateRequest.md +38 -0
- package/docs/DiscountUpdateResponse.md +24 -0
- package/docs/FeatureCostPricing.md +26 -0
- package/docs/FeaturePricing.md +26 -0
- package/docs/FrontAIModel.md +42 -0
- package/docs/FrontendModelExtraInfo.md +20 -0
- package/docs/FrontendModelPricing.md +58 -0
- package/docs/FrontendModelsResponse.md +28 -0
- package/docs/FrontendProviderInfo.md +30 -0
- package/docs/FrontendProviderModel.md +54 -0
- package/docs/FrontendProvidersResponse.md +28 -0
- package/docs/FrontendSearchContextCost.md +24 -0
- package/docs/GetUserDetailResponse.md +24 -0
- package/docs/ImagePricing.md +36 -0
- package/docs/LabelCreateRequest.md +22 -0
- package/docs/LabelCreateResponse.md +24 -0
- package/docs/LabelDeleteResponse.md +22 -0
- package/docs/LabelGetResponse.md +24 -0
- package/docs/LabelListResponse.md +26 -0
- package/docs/LabelUpdateRequest.md +24 -0
- package/docs/LabelUpdateResponse.md +24 -0
- package/docs/ListUsersRequest.md +36 -0
- package/docs/ListUsersResponse.md +30 -0
- package/docs/ModelCapabilities.md +58 -0
- package/docs/ModelLimits.md +40 -0
- package/docs/ModelListResponse.md +32 -0
- package/docs/ModelModalities.md +22 -0
- package/docs/MultimodalPricing.md +24 -0
- package/docs/PricingConditions.md +30 -0
- package/docs/PricingRules.md +32 -0
- package/docs/ProviderAWSAuth.md +24 -0
- package/docs/ProviderAdminServiceApi.md +579 -0
- package/docs/ProviderAuth.md +28 -0
- package/docs/ProviderGCPAuth.md +26 -0
- package/docs/ProviderModelAdminServiceApi.md +591 -0
- package/docs/QRCodeAdminServiceApi.md +281 -0
- package/docs/QRCodeCreateRequest.md +36 -0
- package/docs/QRCodeCreateResponse.md +24 -0
- package/docs/QRCodeDeleteResponse.md +22 -0
- package/docs/QRCodeGetResponse.md +24 -0
- package/docs/QRCodeHistoryItem.md +28 -0
- package/docs/QRCodeInfo.md +58 -0
- package/docs/QRCodeListResponse.md +26 -0
- package/docs/QRCodeSnapshot.md +36 -0
- package/docs/QRCodeUpdateRequest.md +38 -0
- package/docs/QRCodeUpdateResponse.md +24 -0
- package/docs/QRCodeWithHistory.md +22 -0
- package/docs/ReasoningTokensPricing.md +20 -0
- package/docs/RequestPricing.md +22 -0
- package/docs/SessionAction.md +11 -0
- package/docs/SetUserRoleRequest.md +22 -0
- package/docs/SetUserRoleResponse.md +24 -0
- package/docs/SetUserStatusRequest.md +22 -0
- package/docs/SetUserStatusResponse.md +26 -0
- package/docs/Status.md +24 -0
- package/docs/TextTokenInputPricing.md +26 -0
- package/docs/TextTokenOutputPricing.md +24 -0
- package/docs/TextTokenPricing.md +22 -0
- package/docs/TokenTier.md +24 -0
- package/docs/UpdateUserInfoRequest.md +26 -0
- package/docs/UpdateUserInfoResponse.md +24 -0
- package/docs/UserAPIKey.md +46 -0
- package/docs/UserAPIKeyCreateRequest.md +36 -0
- package/docs/UserAPIKeyCreateResponse.md +24 -0
- package/docs/UserAPIKeyDeleteResponse.md +22 -0
- package/docs/UserAPIKeyGetResponse.md +24 -0
- package/docs/UserAPIKeyListResponse.md +26 -0
- package/docs/UserAPIKeyServiceApi.md +284 -0
- package/docs/UserAPIKeyUpdateRequest.md +32 -0
- package/docs/UserAPIKeyUpdateResponse.md +24 -0
- package/docs/UserBalance.md +42 -0
- package/docs/UserBalanceBrief.md +32 -0
- package/docs/UserBalanceChangeResponse.md +24 -0
- package/docs/UserBalanceEditResponse.md +24 -0
- package/docs/UserBalanceListResponse.md +26 -0
- package/docs/UserBalanceServiceApi.md +223 -0
- package/docs/UserInfo.md +32 -0
- package/docs/UserLabelItem.md +22 -0
- package/docs/UserLabelListResponse.md +26 -0
- package/docs/UserLabelPair.md +22 -0
- package/docs/UserLabelPairChangeAction.md +22 -0
- package/docs/UserLabelPairChangeRequest.md +20 -0
- package/docs/UserLabelPairChangeResponse.md +22 -0
- package/docs/UserLabelServiceApi.md +392 -0
- package/docs/UserManageAPIKey.md +38 -0
- package/docs/UserManageAdminServiceApi.md +324 -0
- package/docs/UserManageAuthMethod.md +32 -0
- package/docs/UserManageBalance.md +32 -0
- package/docs/UserManageDetail.md +46 -0
- package/docs/UserManageItem.md +38 -0
- package/docs/UserManageSession.md +34 -0
- package/docs/UserManageSettings.md +20 -0
- package/docs/UserMeInfoResponse.md +24 -0
- package/docs/UserModelActivitySummary.md +30 -0
- package/docs/UserModelHourActivity.md +28 -0
- package/docs/UserModelHourlyUsages.md +20 -0
- package/docs/UserModelServiceApi.md +181 -0
- package/docs/UserPayServiceApi.md +71 -0
- package/docs/UserPayStripeCheckoutResponse.md +24 -0
- package/docs/UserPortalDashboardResponse.md +24 -0
- package/docs/UserPortalServiceApi.md +107 -0
- package/docs/UserSettings.md +20 -0
- package/docs/VersionedAPISchema.md +30 -0
- package/docs/VideoPricing.md +32 -0
- package/docs/WebSearchPricing.md +30 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/package.json +36 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
|
@@ -0,0 +1,454 @@
|
|
|
1
|
+
# AIModelAdminServiceApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**aIModelAdminServiceAdminAIModelCheckConnection**](#aimodeladminserviceadminaimodelcheckconnection) | **GET** /admin/ai-model/check/connection | AdminAIModelCheckConnection 检查 AIModel 的连接性|
|
|
8
|
+
|[**aIModelAdminServiceAdminAIModelCreate**](#aimodeladminserviceadminaimodelcreate) | **POST** /admin/ai-model/create | AdminAIModelCreate 创建新的 AIModel(草稿状态) 请求路径: POST /admin/ai-model/create|
|
|
9
|
+
|[**aIModelAdminServiceAdminAIModelDelete**](#aimodeladminserviceadminaimodeldelete) | **DELETE** /admin/ai-model/delete | AdminAIModelDelete 删除 AIModel(软删除) 请求路径: POST /admin/ai-model/delete|
|
|
10
|
+
|[**aIModelAdminServiceAdminAIModelDisable**](#aimodeladminserviceadminaimodeldisable) | **POST** /admin/ai-model/disable | AdminAIModelDisable 禁用 AIModel,状态变更为已禁用 请求路径: POST /admin/ai-model/disable|
|
|
11
|
+
|[**aIModelAdminServiceAdminAIModelGet**](#aimodeladminserviceadminaimodelget) | **GET** /admin/ai-model/get | AdminAIModelGet 根据 ID 或名称获取单个 AIModel 请求路径: GET /admin/ai-model/get?id={id} 或 GET /admin/ai-model/get?name={name}|
|
|
12
|
+
|[**aIModelAdminServiceAdminAIModelList**](#aimodeladminserviceadminaimodellist) | **GET** /admin/ai-model/list | AdminAIModelList 分页查询 AIModel 列表,支持按状态、名称前缀和分组过滤 请求路径: GET /admin/ai-model/list?page={page}&page_size={page_size}&status={status}&name_prefix={prefix}&group={group}|
|
|
13
|
+
|[**aIModelAdminServiceAdminAIModelPublish**](#aimodeladminserviceadminaimodelpublish) | **POST** /admin/ai-model/publish | AdminAIModelPublish 发布 AIModel,状态变更为已发布 请求路径: POST /admin/ai-model/publish|
|
|
14
|
+
|[**aIModelAdminServiceAdminAIModelUpdate**](#aimodeladminserviceadminaimodelupdate) | **POST** /admin/ai-model/update | AdminAIModelUpdate 更新现有的 AIModel 请求路径: POST /admin/ai-model/update|
|
|
15
|
+
|
|
16
|
+
# **aIModelAdminServiceAdminAIModelCheckConnection**
|
|
17
|
+
> AdminAIModelCheckConnectionResponse aIModelAdminServiceAdminAIModelCheckConnection()
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import {
|
|
24
|
+
AIModelAdminServiceApi,
|
|
25
|
+
Configuration
|
|
26
|
+
} from '@cherryin/aigw-api-client';
|
|
27
|
+
|
|
28
|
+
const configuration = new Configuration();
|
|
29
|
+
const apiInstance = new AIModelAdminServiceApi(configuration);
|
|
30
|
+
|
|
31
|
+
let aiModelNames: Array<string>; //@gotags: form:\"ai_model_names\" (optional) (default to undefined)
|
|
32
|
+
|
|
33
|
+
const { status, data } = await apiInstance.aIModelAdminServiceAdminAIModelCheckConnection(
|
|
34
|
+
aiModelNames
|
|
35
|
+
);
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Parameters
|
|
39
|
+
|
|
40
|
+
|Name | Type | Description | Notes|
|
|
41
|
+
|------------- | ------------- | ------------- | -------------|
|
|
42
|
+
| **aiModelNames** | **Array<string>** | @gotags: form:\"ai_model_names\" | (optional) defaults to undefined|
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
### Return type
|
|
46
|
+
|
|
47
|
+
**AdminAIModelCheckConnectionResponse**
|
|
48
|
+
|
|
49
|
+
### Authorization
|
|
50
|
+
|
|
51
|
+
No authorization required
|
|
52
|
+
|
|
53
|
+
### HTTP request headers
|
|
54
|
+
|
|
55
|
+
- **Content-Type**: Not defined
|
|
56
|
+
- **Accept**: application/json
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### HTTP response details
|
|
60
|
+
| Status code | Description | Response headers |
|
|
61
|
+
|-------------|-------------|------------------|
|
|
62
|
+
|**200** | A successful response. | - |
|
|
63
|
+
|**0** | An unexpected error response. | - |
|
|
64
|
+
|
|
65
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
66
|
+
|
|
67
|
+
# **aIModelAdminServiceAdminAIModelCreate**
|
|
68
|
+
> AdminAIModelCreateResponse aIModelAdminServiceAdminAIModelCreate(body)
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
### Example
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
import {
|
|
75
|
+
AIModelAdminServiceApi,
|
|
76
|
+
Configuration,
|
|
77
|
+
AdminAIModelCreateRequest
|
|
78
|
+
} from '@cherryin/aigw-api-client';
|
|
79
|
+
|
|
80
|
+
const configuration = new Configuration();
|
|
81
|
+
const apiInstance = new AIModelAdminServiceApi(configuration);
|
|
82
|
+
|
|
83
|
+
let body: AdminAIModelCreateRequest; //
|
|
84
|
+
|
|
85
|
+
const { status, data } = await apiInstance.aIModelAdminServiceAdminAIModelCreate(
|
|
86
|
+
body
|
|
87
|
+
);
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### Parameters
|
|
91
|
+
|
|
92
|
+
|Name | Type | Description | Notes|
|
|
93
|
+
|------------- | ------------- | ------------- | -------------|
|
|
94
|
+
| **body** | **AdminAIModelCreateRequest**| | |
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
### Return type
|
|
98
|
+
|
|
99
|
+
**AdminAIModelCreateResponse**
|
|
100
|
+
|
|
101
|
+
### Authorization
|
|
102
|
+
|
|
103
|
+
No authorization required
|
|
104
|
+
|
|
105
|
+
### HTTP request headers
|
|
106
|
+
|
|
107
|
+
- **Content-Type**: application/json
|
|
108
|
+
- **Accept**: application/json
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
### HTTP response details
|
|
112
|
+
| Status code | Description | Response headers |
|
|
113
|
+
|-------------|-------------|------------------|
|
|
114
|
+
|**200** | A successful response. | - |
|
|
115
|
+
|**0** | An unexpected error response. | - |
|
|
116
|
+
|
|
117
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
118
|
+
|
|
119
|
+
# **aIModelAdminServiceAdminAIModelDelete**
|
|
120
|
+
> AdminAIModelDeleteResponse aIModelAdminServiceAdminAIModelDelete()
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
### Example
|
|
124
|
+
|
|
125
|
+
```typescript
|
|
126
|
+
import {
|
|
127
|
+
AIModelAdminServiceApi,
|
|
128
|
+
Configuration
|
|
129
|
+
} from '@cherryin/aigw-api-client';
|
|
130
|
+
|
|
131
|
+
const configuration = new Configuration();
|
|
132
|
+
const apiInstance = new AIModelAdminServiceApi(configuration);
|
|
133
|
+
|
|
134
|
+
let id: string; //Provider 的唯一标识符 @gotags: form:\"id\" (optional) (default to undefined)
|
|
135
|
+
let recordId: string; //Provider 数据库自增 id - record_id @gotags: form:\"record_id\" (optional) (default to undefined)
|
|
136
|
+
|
|
137
|
+
const { status, data } = await apiInstance.aIModelAdminServiceAdminAIModelDelete(
|
|
138
|
+
id,
|
|
139
|
+
recordId
|
|
140
|
+
);
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Parameters
|
|
144
|
+
|
|
145
|
+
|Name | Type | Description | Notes|
|
|
146
|
+
|------------- | ------------- | ------------- | -------------|
|
|
147
|
+
| **id** | [**string**] | Provider 的唯一标识符 @gotags: form:\"id\" | (optional) defaults to undefined|
|
|
148
|
+
| **recordId** | [**string**] | Provider 数据库自增 id - record_id @gotags: form:\"record_id\" | (optional) defaults to undefined|
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
### Return type
|
|
152
|
+
|
|
153
|
+
**AdminAIModelDeleteResponse**
|
|
154
|
+
|
|
155
|
+
### Authorization
|
|
156
|
+
|
|
157
|
+
No authorization required
|
|
158
|
+
|
|
159
|
+
### HTTP request headers
|
|
160
|
+
|
|
161
|
+
- **Content-Type**: Not defined
|
|
162
|
+
- **Accept**: application/json
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
### HTTP response details
|
|
166
|
+
| Status code | Description | Response headers |
|
|
167
|
+
|-------------|-------------|------------------|
|
|
168
|
+
|**200** | A successful response. | - |
|
|
169
|
+
|**0** | An unexpected error response. | - |
|
|
170
|
+
|
|
171
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
172
|
+
|
|
173
|
+
# **aIModelAdminServiceAdminAIModelDisable**
|
|
174
|
+
> AdminAIModelDisableResponse aIModelAdminServiceAdminAIModelDisable(body)
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
### Example
|
|
178
|
+
|
|
179
|
+
```typescript
|
|
180
|
+
import {
|
|
181
|
+
AIModelAdminServiceApi,
|
|
182
|
+
Configuration,
|
|
183
|
+
AdminAIModelDisableRequest
|
|
184
|
+
} from '@cherryin/aigw-api-client';
|
|
185
|
+
|
|
186
|
+
const configuration = new Configuration();
|
|
187
|
+
const apiInstance = new AIModelAdminServiceApi(configuration);
|
|
188
|
+
|
|
189
|
+
let body: AdminAIModelDisableRequest; //
|
|
190
|
+
|
|
191
|
+
const { status, data } = await apiInstance.aIModelAdminServiceAdminAIModelDisable(
|
|
192
|
+
body
|
|
193
|
+
);
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### Parameters
|
|
197
|
+
|
|
198
|
+
|Name | Type | Description | Notes|
|
|
199
|
+
|------------- | ------------- | ------------- | -------------|
|
|
200
|
+
| **body** | **AdminAIModelDisableRequest**| | |
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
### Return type
|
|
204
|
+
|
|
205
|
+
**AdminAIModelDisableResponse**
|
|
206
|
+
|
|
207
|
+
### Authorization
|
|
208
|
+
|
|
209
|
+
No authorization required
|
|
210
|
+
|
|
211
|
+
### HTTP request headers
|
|
212
|
+
|
|
213
|
+
- **Content-Type**: application/json
|
|
214
|
+
- **Accept**: application/json
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
### HTTP response details
|
|
218
|
+
| Status code | Description | Response headers |
|
|
219
|
+
|-------------|-------------|------------------|
|
|
220
|
+
|**200** | A successful response. | - |
|
|
221
|
+
|**0** | An unexpected error response. | - |
|
|
222
|
+
|
|
223
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
224
|
+
|
|
225
|
+
# **aIModelAdminServiceAdminAIModelGet**
|
|
226
|
+
> AdminAIModelGetResponse aIModelAdminServiceAdminAIModelGet()
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
### Example
|
|
230
|
+
|
|
231
|
+
```typescript
|
|
232
|
+
import {
|
|
233
|
+
AIModelAdminServiceApi,
|
|
234
|
+
Configuration
|
|
235
|
+
} from '@cherryin/aigw-api-client';
|
|
236
|
+
|
|
237
|
+
const configuration = new Configuration();
|
|
238
|
+
const apiInstance = new AIModelAdminServiceApi(configuration);
|
|
239
|
+
|
|
240
|
+
let id: string; //Provider 的唯一标识符 @gotags: form:\"id\" (optional) (default to undefined)
|
|
241
|
+
let recordId: string; //Provider 数据库自增 id - record_id @gotags: form:\"record_id\" (optional) (default to undefined)
|
|
242
|
+
|
|
243
|
+
const { status, data } = await apiInstance.aIModelAdminServiceAdminAIModelGet(
|
|
244
|
+
id,
|
|
245
|
+
recordId
|
|
246
|
+
);
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
### Parameters
|
|
250
|
+
|
|
251
|
+
|Name | Type | Description | Notes|
|
|
252
|
+
|------------- | ------------- | ------------- | -------------|
|
|
253
|
+
| **id** | [**string**] | Provider 的唯一标识符 @gotags: form:\"id\" | (optional) defaults to undefined|
|
|
254
|
+
| **recordId** | [**string**] | Provider 数据库自增 id - record_id @gotags: form:\"record_id\" | (optional) defaults to undefined|
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
### Return type
|
|
258
|
+
|
|
259
|
+
**AdminAIModelGetResponse**
|
|
260
|
+
|
|
261
|
+
### Authorization
|
|
262
|
+
|
|
263
|
+
No authorization required
|
|
264
|
+
|
|
265
|
+
### HTTP request headers
|
|
266
|
+
|
|
267
|
+
- **Content-Type**: Not defined
|
|
268
|
+
- **Accept**: application/json
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
### HTTP response details
|
|
272
|
+
| Status code | Description | Response headers |
|
|
273
|
+
|-------------|-------------|------------------|
|
|
274
|
+
|**200** | A successful response. | - |
|
|
275
|
+
|**0** | An unexpected error response. | - |
|
|
276
|
+
|
|
277
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
278
|
+
|
|
279
|
+
# **aIModelAdminServiceAdminAIModelList**
|
|
280
|
+
> AdminAIModelListResponse aIModelAdminServiceAdminAIModelList()
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
### Example
|
|
284
|
+
|
|
285
|
+
```typescript
|
|
286
|
+
import {
|
|
287
|
+
AIModelAdminServiceApi,
|
|
288
|
+
Configuration
|
|
289
|
+
} from '@cherryin/aigw-api-client';
|
|
290
|
+
|
|
291
|
+
const configuration = new Configuration();
|
|
292
|
+
const apiInstance = new AIModelAdminServiceApi(configuration);
|
|
293
|
+
|
|
294
|
+
let page: number; //page 页码,从 1 开始 默认值: 1 @gotags: form:\"page\" (optional) (default to undefined)
|
|
295
|
+
let pageSize: number; //page_size 每页数量 默认值: 20,最大值: 100 @gotags: form:\"page_size\" (optional) (default to undefined)
|
|
296
|
+
let modelStatus: number; //model_status 按状态过滤(可选) 0: 返回所有状态 1: 仅返回草稿状态 2: 仅返回启用状态 3: 仅返回禁用状态 (optional) (default to undefined)
|
|
297
|
+
let modelId: string; //model_id 按 id 前缀过滤(可选) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 @gotags: form:\"model_id\" (optional) (default to undefined)
|
|
298
|
+
let modelName: string; //name 按 name 前缀过滤(可选) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 @gotags: form:\"model_name\" (optional) (default to undefined)
|
|
299
|
+
let providerId: string; //provider_id 按 id 前缀过滤(可选) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 @gotags: form:\"provider_id\" (optional) (default to undefined)
|
|
300
|
+
let providerName: string; //provider_name 按 name 前缀过滤(可选) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 @gotags: form:\"provider_name\" (optional) (default to undefined)
|
|
301
|
+
let isOfficial: boolean; //是否仅查询官方供应商,则返回的是官方供应商的信息(如果有) (optional) (default to undefined)
|
|
302
|
+
|
|
303
|
+
const { status, data } = await apiInstance.aIModelAdminServiceAdminAIModelList(
|
|
304
|
+
page,
|
|
305
|
+
pageSize,
|
|
306
|
+
modelStatus,
|
|
307
|
+
modelId,
|
|
308
|
+
modelName,
|
|
309
|
+
providerId,
|
|
310
|
+
providerName,
|
|
311
|
+
isOfficial
|
|
312
|
+
);
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### Parameters
|
|
316
|
+
|
|
317
|
+
|Name | Type | Description | Notes|
|
|
318
|
+
|------------- | ------------- | ------------- | -------------|
|
|
319
|
+
| **page** | [**number**] | page 页码,从 1 开始 默认值: 1 @gotags: form:\"page\" | (optional) defaults to undefined|
|
|
320
|
+
| **pageSize** | [**number**] | page_size 每页数量 默认值: 20,最大值: 100 @gotags: form:\"page_size\" | (optional) defaults to undefined|
|
|
321
|
+
| **modelStatus** | [**number**] | model_status 按状态过滤(可选) 0: 返回所有状态 1: 仅返回草稿状态 2: 仅返回启用状态 3: 仅返回禁用状态 | (optional) defaults to undefined|
|
|
322
|
+
| **modelId** | [**string**] | model_id 按 id 前缀过滤(可选) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 @gotags: form:\"model_id\" | (optional) defaults to undefined|
|
|
323
|
+
| **modelName** | [**string**] | name 按 name 前缀过滤(可选) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 @gotags: form:\"model_name\" | (optional) defaults to undefined|
|
|
324
|
+
| **providerId** | [**string**] | provider_id 按 id 前缀过滤(可选) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 @gotags: form:\"provider_id\" | (optional) defaults to undefined|
|
|
325
|
+
| **providerName** | [**string**] | provider_name 按 name 前缀过滤(可选) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 @gotags: form:\"provider_name\" | (optional) defaults to undefined|
|
|
326
|
+
| **isOfficial** | [**boolean**] | 是否仅查询官方供应商,则返回的是官方供应商的信息(如果有) | (optional) defaults to undefined|
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
### Return type
|
|
330
|
+
|
|
331
|
+
**AdminAIModelListResponse**
|
|
332
|
+
|
|
333
|
+
### Authorization
|
|
334
|
+
|
|
335
|
+
No authorization required
|
|
336
|
+
|
|
337
|
+
### HTTP request headers
|
|
338
|
+
|
|
339
|
+
- **Content-Type**: Not defined
|
|
340
|
+
- **Accept**: application/json
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
### HTTP response details
|
|
344
|
+
| Status code | Description | Response headers |
|
|
345
|
+
|-------------|-------------|------------------|
|
|
346
|
+
|**200** | A successful response. | - |
|
|
347
|
+
|**0** | An unexpected error response. | - |
|
|
348
|
+
|
|
349
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
350
|
+
|
|
351
|
+
# **aIModelAdminServiceAdminAIModelPublish**
|
|
352
|
+
> AdminAIModelPublishResponse aIModelAdminServiceAdminAIModelPublish(body)
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
### Example
|
|
356
|
+
|
|
357
|
+
```typescript
|
|
358
|
+
import {
|
|
359
|
+
AIModelAdminServiceApi,
|
|
360
|
+
Configuration,
|
|
361
|
+
AdminAIModelPublishRequest
|
|
362
|
+
} from '@cherryin/aigw-api-client';
|
|
363
|
+
|
|
364
|
+
const configuration = new Configuration();
|
|
365
|
+
const apiInstance = new AIModelAdminServiceApi(configuration);
|
|
366
|
+
|
|
367
|
+
let body: AdminAIModelPublishRequest; //
|
|
368
|
+
|
|
369
|
+
const { status, data } = await apiInstance.aIModelAdminServiceAdminAIModelPublish(
|
|
370
|
+
body
|
|
371
|
+
);
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
### Parameters
|
|
375
|
+
|
|
376
|
+
|Name | Type | Description | Notes|
|
|
377
|
+
|------------- | ------------- | ------------- | -------------|
|
|
378
|
+
| **body** | **AdminAIModelPublishRequest**| | |
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
### Return type
|
|
382
|
+
|
|
383
|
+
**AdminAIModelPublishResponse**
|
|
384
|
+
|
|
385
|
+
### Authorization
|
|
386
|
+
|
|
387
|
+
No authorization required
|
|
388
|
+
|
|
389
|
+
### HTTP request headers
|
|
390
|
+
|
|
391
|
+
- **Content-Type**: application/json
|
|
392
|
+
- **Accept**: application/json
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
### HTTP response details
|
|
396
|
+
| Status code | Description | Response headers |
|
|
397
|
+
|-------------|-------------|------------------|
|
|
398
|
+
|**200** | A successful response. | - |
|
|
399
|
+
|**0** | An unexpected error response. | - |
|
|
400
|
+
|
|
401
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
402
|
+
|
|
403
|
+
# **aIModelAdminServiceAdminAIModelUpdate**
|
|
404
|
+
> AdminAIModelUpdateResponse aIModelAdminServiceAdminAIModelUpdate(body)
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
### Example
|
|
408
|
+
|
|
409
|
+
```typescript
|
|
410
|
+
import {
|
|
411
|
+
AIModelAdminServiceApi,
|
|
412
|
+
Configuration,
|
|
413
|
+
AdminAIModelUpdateRequest
|
|
414
|
+
} from '@cherryin/aigw-api-client';
|
|
415
|
+
|
|
416
|
+
const configuration = new Configuration();
|
|
417
|
+
const apiInstance = new AIModelAdminServiceApi(configuration);
|
|
418
|
+
|
|
419
|
+
let body: AdminAIModelUpdateRequest; //
|
|
420
|
+
|
|
421
|
+
const { status, data } = await apiInstance.aIModelAdminServiceAdminAIModelUpdate(
|
|
422
|
+
body
|
|
423
|
+
);
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
### Parameters
|
|
427
|
+
|
|
428
|
+
|Name | Type | Description | Notes|
|
|
429
|
+
|------------- | ------------- | ------------- | -------------|
|
|
430
|
+
| **body** | **AdminAIModelUpdateRequest**| | |
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
### Return type
|
|
434
|
+
|
|
435
|
+
**AdminAIModelUpdateResponse**
|
|
436
|
+
|
|
437
|
+
### Authorization
|
|
438
|
+
|
|
439
|
+
No authorization required
|
|
440
|
+
|
|
441
|
+
### HTTP request headers
|
|
442
|
+
|
|
443
|
+
- **Content-Type**: application/json
|
|
444
|
+
- **Accept**: application/json
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
### HTTP response details
|
|
448
|
+
| Status code | Description | Response headers |
|
|
449
|
+
|-------------|-------------|------------------|
|
|
450
|
+
|**200** | A successful response. | - |
|
|
451
|
+
|**0** | An unexpected error response. | - |
|
|
452
|
+
|
|
453
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
454
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# AIModelPricingConfig
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**currency_code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**pricing_name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**pricing_type** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**priority** | **number** | | [optional] [default to undefined]
|
|
12
|
+
**pricing_rules** | [**PricingRules**](PricingRules.md) | | [optional] [default to undefined]
|
|
13
|
+
**pricing_conditions** | [**PricingConditions**](PricingConditions.md) | | [optional] [default to undefined]
|
|
14
|
+
**pricing_status** | **number** | | [optional] [default to undefined]
|
|
15
|
+
**effective_from** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**effective_until** | **string** | | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { AIModelPricingConfig } from '@cherryin/aigw-api-client';
|
|
22
|
+
|
|
23
|
+
const instance: AIModelPricingConfig = {
|
|
24
|
+
currency_code,
|
|
25
|
+
pricing_name,
|
|
26
|
+
pricing_type,
|
|
27
|
+
priority,
|
|
28
|
+
pricing_rules,
|
|
29
|
+
pricing_conditions,
|
|
30
|
+
pricing_status,
|
|
31
|
+
effective_from,
|
|
32
|
+
effective_until,
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# AdminAIModel
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**family** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**source** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**model_card** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**temperature** | **boolean** | | [optional] [default to undefined]
|
|
14
|
+
**knowledge** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**release_date** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**last_updated** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**open_weights** | **boolean** | | [optional] [default to undefined]
|
|
18
|
+
**deprecation_date** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**context_length** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**modalities** | [**ModelModalities**](ModelModalities.md) | | [optional] [default to undefined]
|
|
21
|
+
**limits** | [**ModelLimits**](ModelLimits.md) | | [optional] [default to undefined]
|
|
22
|
+
**capabilities** | [**ModelCapabilities**](ModelCapabilities.md) | | [optional] [default to undefined]
|
|
23
|
+
**pricing** | [**FrontendModelPricing**](FrontendModelPricing.md) | | [optional] [default to undefined]
|
|
24
|
+
**extra_info** | [**FrontendModelExtraInfo**](FrontendModelExtraInfo.md) | | [optional] [default to undefined]
|
|
25
|
+
**is_official** | **boolean** | 是否为官方供应商,官方供应商会额外写官方供应商表. | [optional] [default to undefined]
|
|
26
|
+
**endpoints** | [**Array<VersionedAPISchema>**](VersionedAPISchema.md) | | [optional] [default to undefined]
|
|
27
|
+
**provider_configs** | [**Array<AdminAIModelProviderConfigItem>**](AdminAIModelProviderConfigItem.md) | | [optional] [default to undefined]
|
|
28
|
+
**pricing_configs** | [**Array<AIModelPricingConfig>**](AIModelPricingConfig.md) | | [optional] [default to undefined]
|
|
29
|
+
**discount_config** | [**AdminAIModelDiscountConfig**](AdminAIModelDiscountConfig.md) | | [optional] [default to undefined]
|
|
30
|
+
**model_status** | **number** | | [optional] [default to undefined]
|
|
31
|
+
**record_id** | **string** | | [optional] [default to undefined]
|
|
32
|
+
**created_at** | **string** | | [optional] [default to undefined]
|
|
33
|
+
**updated_at** | **string** | | [optional] [default to undefined]
|
|
34
|
+
**deleted_at** | **string** | | [optional] [default to undefined]
|
|
35
|
+
|
|
36
|
+
## Example
|
|
37
|
+
|
|
38
|
+
```typescript
|
|
39
|
+
import { AdminAIModel } from '@cherryin/aigw-api-client';
|
|
40
|
+
|
|
41
|
+
const instance: AdminAIModel = {
|
|
42
|
+
id,
|
|
43
|
+
name,
|
|
44
|
+
family,
|
|
45
|
+
source,
|
|
46
|
+
model_card,
|
|
47
|
+
temperature,
|
|
48
|
+
knowledge,
|
|
49
|
+
release_date,
|
|
50
|
+
last_updated,
|
|
51
|
+
open_weights,
|
|
52
|
+
deprecation_date,
|
|
53
|
+
context_length,
|
|
54
|
+
modalities,
|
|
55
|
+
limits,
|
|
56
|
+
capabilities,
|
|
57
|
+
pricing,
|
|
58
|
+
extra_info,
|
|
59
|
+
is_official,
|
|
60
|
+
endpoints,
|
|
61
|
+
provider_configs,
|
|
62
|
+
pricing_configs,
|
|
63
|
+
discount_config,
|
|
64
|
+
model_status,
|
|
65
|
+
record_id,
|
|
66
|
+
created_at,
|
|
67
|
+
updated_at,
|
|
68
|
+
deleted_at,
|
|
69
|
+
};
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# AdminAIModelCheckConnectionResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**results** | [**Array<AdminAIModelCheckResult>**](AdminAIModelCheckResult.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AdminAIModelCheckConnectionResponse } from '@cherryin/aigw-api-client';
|
|
16
|
+
|
|
17
|
+
const instance: AdminAIModelCheckConnectionResponse = {
|
|
18
|
+
code,
|
|
19
|
+
message,
|
|
20
|
+
results,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# AdminAIModelCheckItem
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**ai_model_name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**provider_name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**provider_model_name** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**ai_model_endpoint** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**provider_model_endpoint** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**is_valid** | **boolean** | | [optional] [default to undefined]
|
|
14
|
+
**error** | **string** | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { AdminAIModelCheckItem } from '@cherryin/aigw-api-client';
|
|
20
|
+
|
|
21
|
+
const instance: AdminAIModelCheckItem = {
|
|
22
|
+
ai_model_name,
|
|
23
|
+
provider_name,
|
|
24
|
+
provider_model_name,
|
|
25
|
+
ai_model_endpoint,
|
|
26
|
+
provider_model_endpoint,
|
|
27
|
+
is_valid,
|
|
28
|
+
error,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# AdminAIModelCheckResult
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**ai_model_name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**items** | [**Array<AdminAIModelCheckItem>**](AdminAIModelCheckItem.md) | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AdminAIModelCheckResult } from '@cherryin/aigw-api-client';
|
|
15
|
+
|
|
16
|
+
const instance: AdminAIModelCheckResult = {
|
|
17
|
+
ai_model_name,
|
|
18
|
+
items,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|