@knowledge-stack/ksapi 1.139.1 → 1.140.1
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 +28 -0
- package/README.md +25 -11
- package/dist/apis/AdminKbApi.d.ts +109 -0
- package/dist/apis/AdminKbApi.js +172 -0
- package/dist/apis/AdminWorkflowsApi.d.ts +252 -0
- package/dist/apis/AdminWorkflowsApi.js +337 -0
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +2 -0
- package/dist/esm/apis/AdminKbApi.d.ts +109 -0
- package/dist/esm/apis/AdminKbApi.js +135 -0
- package/dist/esm/apis/AdminWorkflowsApi.d.ts +252 -0
- package/dist/esm/apis/AdminWorkflowsApi.js +300 -0
- package/dist/esm/apis/index.d.ts +2 -0
- package/dist/esm/apis/index.js +2 -0
- package/dist/esm/models/CitedChunk.d.ts +6 -4
- package/dist/esm/models/DefinitionOutputStat.d.ts +65 -0
- package/dist/esm/models/DefinitionOutputStat.js +56 -0
- package/dist/esm/models/HourHistogramResponse.d.ts +53 -0
- package/dist/esm/models/HourHistogramResponse.js +54 -0
- package/dist/esm/models/KbMetric.d.ts +26 -0
- package/dist/esm/models/KbMetric.js +44 -0
- package/dist/esm/models/KbSummaryResponse.d.ts +152 -0
- package/dist/esm/models/KbSummaryResponse.js +109 -0
- package/dist/esm/models/KbTimeseriesResponse.d.ts +71 -0
- package/dist/esm/models/KbTimeseriesResponse.js +57 -0
- package/dist/esm/models/LabeledSeries.d.ts +54 -0
- package/dist/esm/models/LabeledSeries.js +47 -0
- package/dist/esm/models/LeaderboardEntry.d.ts +59 -0
- package/dist/esm/models/LeaderboardEntry.js +52 -0
- package/dist/esm/models/RunTimeseriesResponse.d.ts +61 -0
- package/dist/esm/models/RunTimeseriesResponse.js +52 -0
- package/dist/esm/models/TimeBucket.d.ts +27 -0
- package/dist/esm/models/TimeBucket.js +45 -0
- package/dist/esm/models/TimeseriesPoint.d.ts +53 -0
- package/dist/esm/models/TimeseriesPoint.js +48 -0
- package/dist/esm/models/WorkflowLeaderboardResponse.d.ts +54 -0
- package/dist/esm/models/WorkflowLeaderboardResponse.js +45 -0
- package/dist/esm/models/WorkflowOutputStatsResponse.d.ts +54 -0
- package/dist/esm/models/WorkflowOutputStatsResponse.js +47 -0
- package/dist/esm/models/index.d.ts +12 -0
- package/dist/esm/models/index.js +12 -0
- package/dist/models/CitedChunk.d.ts +6 -4
- package/dist/models/DefinitionOutputStat.d.ts +65 -0
- package/dist/models/DefinitionOutputStat.js +64 -0
- package/dist/models/HourHistogramResponse.d.ts +53 -0
- package/dist/models/HourHistogramResponse.js +62 -0
- package/dist/models/KbMetric.d.ts +26 -0
- package/dist/models/KbMetric.js +52 -0
- package/dist/models/KbSummaryResponse.d.ts +152 -0
- package/dist/models/KbSummaryResponse.js +117 -0
- package/dist/models/KbTimeseriesResponse.d.ts +71 -0
- package/dist/models/KbTimeseriesResponse.js +65 -0
- package/dist/models/LabeledSeries.d.ts +54 -0
- package/dist/models/LabeledSeries.js +55 -0
- package/dist/models/LeaderboardEntry.d.ts +59 -0
- package/dist/models/LeaderboardEntry.js +60 -0
- package/dist/models/RunTimeseriesResponse.d.ts +61 -0
- package/dist/models/RunTimeseriesResponse.js +60 -0
- package/dist/models/TimeBucket.d.ts +27 -0
- package/dist/models/TimeBucket.js +53 -0
- package/dist/models/TimeseriesPoint.d.ts +53 -0
- package/dist/models/TimeseriesPoint.js +56 -0
- package/dist/models/WorkflowLeaderboardResponse.d.ts +54 -0
- package/dist/models/WorkflowLeaderboardResponse.js +53 -0
- package/dist/models/WorkflowOutputStatsResponse.d.ts +54 -0
- package/dist/models/WorkflowOutputStatsResponse.js +55 -0
- package/dist/models/index.d.ts +12 -0
- package/dist/models/index.js +12 -0
- package/docs/AdminKbApi.md +163 -0
- package/docs/AdminWorkflowsApi.md +424 -0
- package/docs/CitedChunk.md +1 -1
- package/docs/DefinitionOutputStat.md +41 -0
- package/docs/HourHistogramResponse.md +37 -0
- package/docs/KbMetric.md +33 -0
- package/docs/KbSummaryResponse.md +67 -0
- package/docs/KbTimeseriesResponse.md +41 -0
- package/docs/LabeledSeries.md +37 -0
- package/docs/LeaderboardEntry.md +39 -0
- package/docs/RunTimeseriesResponse.md +39 -0
- package/docs/TimeBucket.md +33 -0
- package/docs/TimeseriesPoint.md +37 -0
- package/docs/WorkflowLeaderboardResponse.md +37 -0
- package/docs/WorkflowOutputStatsResponse.md +37 -0
- package/package.json +1 -1
- package/src/apis/AdminKbApi.ts +237 -0
- package/src/apis/AdminWorkflowsApi.ts +539 -0
- package/src/apis/index.ts +2 -0
- package/src/models/CitedChunk.ts +6 -4
- package/src/models/DefinitionOutputStat.ts +110 -0
- package/src/models/HourHistogramResponse.ts +97 -0
- package/src/models/KbMetric.ts +54 -0
- package/src/models/KbSummaryResponse.ts +235 -0
- package/src/models/KbTimeseriesResponse.ts +136 -0
- package/src/models/LabeledSeries.ts +99 -0
- package/src/models/LeaderboardEntry.ts +101 -0
- package/src/models/RunTimeseriesResponse.ts +117 -0
- package/src/models/TimeBucket.ts +55 -0
- package/src/models/TimeseriesPoint.ts +92 -0
- package/src/models/WorkflowLeaderboardResponse.ts +98 -0
- package/src/models/WorkflowOutputStatsResponse.ts +99 -0
- package/src/models/index.ts +12 -0
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Knowledge Stack API
|
|
6
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.TimeseriesPointPropertyValidationAttributesMap = void 0;
|
|
17
|
+
exports.instanceOfTimeseriesPoint = instanceOfTimeseriesPoint;
|
|
18
|
+
exports.TimeseriesPointFromJSON = TimeseriesPointFromJSON;
|
|
19
|
+
exports.TimeseriesPointFromJSONTyped = TimeseriesPointFromJSONTyped;
|
|
20
|
+
exports.TimeseriesPointToJSON = TimeseriesPointToJSON;
|
|
21
|
+
exports.TimeseriesPointToJSONTyped = TimeseriesPointToJSONTyped;
|
|
22
|
+
exports.TimeseriesPointPropertyValidationAttributesMap = {};
|
|
23
|
+
/**
|
|
24
|
+
* Check if a given object implements the TimeseriesPoint interface.
|
|
25
|
+
*/
|
|
26
|
+
function instanceOfTimeseriesPoint(value) {
|
|
27
|
+
if (!('bucketStart' in value) || value['bucketStart'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('count' in value) || value['count'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
return true;
|
|
32
|
+
}
|
|
33
|
+
function TimeseriesPointFromJSON(json) {
|
|
34
|
+
return TimeseriesPointFromJSONTyped(json, false);
|
|
35
|
+
}
|
|
36
|
+
function TimeseriesPointFromJSONTyped(json, ignoreDiscriminator) {
|
|
37
|
+
if (json == null) {
|
|
38
|
+
return json;
|
|
39
|
+
}
|
|
40
|
+
return {
|
|
41
|
+
'bucketStart': (new Date(json['bucket_start'])),
|
|
42
|
+
'count': json['count'],
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
function TimeseriesPointToJSON(json) {
|
|
46
|
+
return TimeseriesPointToJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
function TimeseriesPointToJSONTyped(value, ignoreDiscriminator = false) {
|
|
49
|
+
if (value == null) {
|
|
50
|
+
return value;
|
|
51
|
+
}
|
|
52
|
+
return {
|
|
53
|
+
'bucket_start': value['bucketStart'].toISOString(),
|
|
54
|
+
'count': value['count'],
|
|
55
|
+
};
|
|
56
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { LeaderboardEntry } from './LeaderboardEntry';
|
|
13
|
+
/**
|
|
14
|
+
* Top workflows and top users by run count over a window.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface WorkflowLeaderboardResponse
|
|
17
|
+
*/
|
|
18
|
+
export interface WorkflowLeaderboardResponse {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {Array<LeaderboardEntry>}
|
|
22
|
+
* @memberof WorkflowLeaderboardResponse
|
|
23
|
+
*/
|
|
24
|
+
topWorkflows?: Array<LeaderboardEntry>;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {Array<LeaderboardEntry>}
|
|
28
|
+
* @memberof WorkflowLeaderboardResponse
|
|
29
|
+
*/
|
|
30
|
+
topUsers?: Array<LeaderboardEntry>;
|
|
31
|
+
}
|
|
32
|
+
export declare const WorkflowLeaderboardResponsePropertyValidationAttributesMap: {
|
|
33
|
+
[property: string]: {
|
|
34
|
+
maxLength?: number;
|
|
35
|
+
minLength?: number;
|
|
36
|
+
pattern?: string;
|
|
37
|
+
maximum?: number;
|
|
38
|
+
exclusiveMaximum?: boolean;
|
|
39
|
+
minimum?: number;
|
|
40
|
+
exclusiveMinimum?: boolean;
|
|
41
|
+
multipleOf?: number;
|
|
42
|
+
maxItems?: number;
|
|
43
|
+
minItems?: number;
|
|
44
|
+
uniqueItems?: boolean;
|
|
45
|
+
};
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Check if a given object implements the WorkflowLeaderboardResponse interface.
|
|
49
|
+
*/
|
|
50
|
+
export declare function instanceOfWorkflowLeaderboardResponse(value: object): value is WorkflowLeaderboardResponse;
|
|
51
|
+
export declare function WorkflowLeaderboardResponseFromJSON(json: any): WorkflowLeaderboardResponse;
|
|
52
|
+
export declare function WorkflowLeaderboardResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowLeaderboardResponse;
|
|
53
|
+
export declare function WorkflowLeaderboardResponseToJSON(json: any): WorkflowLeaderboardResponse;
|
|
54
|
+
export declare function WorkflowLeaderboardResponseToJSONTyped(value?: WorkflowLeaderboardResponse | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Knowledge Stack API
|
|
6
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.WorkflowLeaderboardResponsePropertyValidationAttributesMap = void 0;
|
|
17
|
+
exports.instanceOfWorkflowLeaderboardResponse = instanceOfWorkflowLeaderboardResponse;
|
|
18
|
+
exports.WorkflowLeaderboardResponseFromJSON = WorkflowLeaderboardResponseFromJSON;
|
|
19
|
+
exports.WorkflowLeaderboardResponseFromJSONTyped = WorkflowLeaderboardResponseFromJSONTyped;
|
|
20
|
+
exports.WorkflowLeaderboardResponseToJSON = WorkflowLeaderboardResponseToJSON;
|
|
21
|
+
exports.WorkflowLeaderboardResponseToJSONTyped = WorkflowLeaderboardResponseToJSONTyped;
|
|
22
|
+
const LeaderboardEntry_1 = require("./LeaderboardEntry");
|
|
23
|
+
exports.WorkflowLeaderboardResponsePropertyValidationAttributesMap = {};
|
|
24
|
+
/**
|
|
25
|
+
* Check if a given object implements the WorkflowLeaderboardResponse interface.
|
|
26
|
+
*/
|
|
27
|
+
function instanceOfWorkflowLeaderboardResponse(value) {
|
|
28
|
+
return true;
|
|
29
|
+
}
|
|
30
|
+
function WorkflowLeaderboardResponseFromJSON(json) {
|
|
31
|
+
return WorkflowLeaderboardResponseFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
function WorkflowLeaderboardResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if (json == null) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'topWorkflows': json['top_workflows'] == null ? undefined : (json['top_workflows'].map(LeaderboardEntry_1.LeaderboardEntryFromJSON)),
|
|
39
|
+
'topUsers': json['top_users'] == null ? undefined : (json['top_users'].map(LeaderboardEntry_1.LeaderboardEntryFromJSON)),
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
function WorkflowLeaderboardResponseToJSON(json) {
|
|
43
|
+
return WorkflowLeaderboardResponseToJSONTyped(json, false);
|
|
44
|
+
}
|
|
45
|
+
function WorkflowLeaderboardResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
46
|
+
if (value == null) {
|
|
47
|
+
return value;
|
|
48
|
+
}
|
|
49
|
+
return {
|
|
50
|
+
'top_workflows': value['topWorkflows'] == null ? undefined : (value['topWorkflows'].map(LeaderboardEntry_1.LeaderboardEntryToJSON)),
|
|
51
|
+
'top_users': value['topUsers'] == null ? undefined : (value['topUsers'].map(LeaderboardEntry_1.LeaderboardEntryToJSON)),
|
|
52
|
+
};
|
|
53
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { DefinitionOutputStat } from './DefinitionOutputStat';
|
|
13
|
+
/**
|
|
14
|
+
* Avg documents generated per workflow definition (completed runs).
|
|
15
|
+
* @export
|
|
16
|
+
* @interface WorkflowOutputStatsResponse
|
|
17
|
+
*/
|
|
18
|
+
export interface WorkflowOutputStatsResponse {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {Array<DefinitionOutputStat>}
|
|
22
|
+
* @memberof WorkflowOutputStatsResponse
|
|
23
|
+
*/
|
|
24
|
+
perDefinition?: Array<DefinitionOutputStat>;
|
|
25
|
+
/**
|
|
26
|
+
* Mean output DOCUMENTs across all completed runs; null when none.
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof WorkflowOutputStatsResponse
|
|
29
|
+
*/
|
|
30
|
+
overallAvg: number | null;
|
|
31
|
+
}
|
|
32
|
+
export declare const WorkflowOutputStatsResponsePropertyValidationAttributesMap: {
|
|
33
|
+
[property: string]: {
|
|
34
|
+
maxLength?: number;
|
|
35
|
+
minLength?: number;
|
|
36
|
+
pattern?: string;
|
|
37
|
+
maximum?: number;
|
|
38
|
+
exclusiveMaximum?: boolean;
|
|
39
|
+
minimum?: number;
|
|
40
|
+
exclusiveMinimum?: boolean;
|
|
41
|
+
multipleOf?: number;
|
|
42
|
+
maxItems?: number;
|
|
43
|
+
minItems?: number;
|
|
44
|
+
uniqueItems?: boolean;
|
|
45
|
+
};
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Check if a given object implements the WorkflowOutputStatsResponse interface.
|
|
49
|
+
*/
|
|
50
|
+
export declare function instanceOfWorkflowOutputStatsResponse(value: object): value is WorkflowOutputStatsResponse;
|
|
51
|
+
export declare function WorkflowOutputStatsResponseFromJSON(json: any): WorkflowOutputStatsResponse;
|
|
52
|
+
export declare function WorkflowOutputStatsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowOutputStatsResponse;
|
|
53
|
+
export declare function WorkflowOutputStatsResponseToJSON(json: any): WorkflowOutputStatsResponse;
|
|
54
|
+
export declare function WorkflowOutputStatsResponseToJSONTyped(value?: WorkflowOutputStatsResponse | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Knowledge Stack API
|
|
6
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.WorkflowOutputStatsResponsePropertyValidationAttributesMap = void 0;
|
|
17
|
+
exports.instanceOfWorkflowOutputStatsResponse = instanceOfWorkflowOutputStatsResponse;
|
|
18
|
+
exports.WorkflowOutputStatsResponseFromJSON = WorkflowOutputStatsResponseFromJSON;
|
|
19
|
+
exports.WorkflowOutputStatsResponseFromJSONTyped = WorkflowOutputStatsResponseFromJSONTyped;
|
|
20
|
+
exports.WorkflowOutputStatsResponseToJSON = WorkflowOutputStatsResponseToJSON;
|
|
21
|
+
exports.WorkflowOutputStatsResponseToJSONTyped = WorkflowOutputStatsResponseToJSONTyped;
|
|
22
|
+
const DefinitionOutputStat_1 = require("./DefinitionOutputStat");
|
|
23
|
+
exports.WorkflowOutputStatsResponsePropertyValidationAttributesMap = {};
|
|
24
|
+
/**
|
|
25
|
+
* Check if a given object implements the WorkflowOutputStatsResponse interface.
|
|
26
|
+
*/
|
|
27
|
+
function instanceOfWorkflowOutputStatsResponse(value) {
|
|
28
|
+
if (!('overallAvg' in value) || value['overallAvg'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
return true;
|
|
31
|
+
}
|
|
32
|
+
function WorkflowOutputStatsResponseFromJSON(json) {
|
|
33
|
+
return WorkflowOutputStatsResponseFromJSONTyped(json, false);
|
|
34
|
+
}
|
|
35
|
+
function WorkflowOutputStatsResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
36
|
+
if (json == null) {
|
|
37
|
+
return json;
|
|
38
|
+
}
|
|
39
|
+
return {
|
|
40
|
+
'perDefinition': json['per_definition'] == null ? undefined : (json['per_definition'].map(DefinitionOutputStat_1.DefinitionOutputStatFromJSON)),
|
|
41
|
+
'overallAvg': json['overall_avg'],
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
function WorkflowOutputStatsResponseToJSON(json) {
|
|
45
|
+
return WorkflowOutputStatsResponseToJSONTyped(json, false);
|
|
46
|
+
}
|
|
47
|
+
function WorkflowOutputStatsResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
48
|
+
if (value == null) {
|
|
49
|
+
return value;
|
|
50
|
+
}
|
|
51
|
+
return {
|
|
52
|
+
'per_definition': value['perDefinition'] == null ? undefined : (value['perDefinition'].map(DefinitionOutputStat_1.DefinitionOutputStatToJSON)),
|
|
53
|
+
'overall_avg': value['overallAvg'],
|
|
54
|
+
};
|
|
55
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -80,6 +80,7 @@ export * from './DataSourceSchemaListResponse';
|
|
|
80
80
|
export * from './DataSourceSchemaResponse';
|
|
81
81
|
export * from './DataSourceSyncResponse';
|
|
82
82
|
export * from './DataSourceTableResponse';
|
|
83
|
+
export * from './DefinitionOutputStat';
|
|
83
84
|
export * from './DiffFormat';
|
|
84
85
|
export * from './DiffRow';
|
|
85
86
|
export * from './DiffRowType';
|
|
@@ -131,6 +132,7 @@ export * from './GroupPermissionResponse';
|
|
|
131
132
|
export * from './GroupResponse';
|
|
132
133
|
export * from './HTTPValidationError';
|
|
133
134
|
export * from './HealthCheckResponse';
|
|
135
|
+
export * from './HourHistogramResponse';
|
|
134
136
|
export * from './HybridSearchProfile';
|
|
135
137
|
export * from './IdpConfig';
|
|
136
138
|
export * from './IdpType';
|
|
@@ -150,6 +152,11 @@ export * from './InviteResponse';
|
|
|
150
152
|
export * from './InviteStatus';
|
|
151
153
|
export * from './InviteUserRequest';
|
|
152
154
|
export * from './ItemPermissions';
|
|
155
|
+
export * from './KbMetric';
|
|
156
|
+
export * from './KbSummaryResponse';
|
|
157
|
+
export * from './KbTimeseriesResponse';
|
|
158
|
+
export * from './LabeledSeries';
|
|
159
|
+
export * from './LeaderboardEntry';
|
|
153
160
|
export * from './LineageEdgeResponse';
|
|
154
161
|
export * from './LineageGraphResponse';
|
|
155
162
|
export * from './LineageNodeResponse';
|
|
@@ -226,6 +233,7 @@ export * from './RevisionEdit';
|
|
|
226
233
|
export * from './RootResponse';
|
|
227
234
|
export * from './RunFolder';
|
|
228
235
|
export * from './RunFolderRef';
|
|
236
|
+
export * from './RunTimeseriesResponse';
|
|
229
237
|
export * from './SSOInitiateResponse';
|
|
230
238
|
export * from './ScoredChunkResponse';
|
|
231
239
|
export * from './SearchSkillsRequest';
|
|
@@ -289,6 +297,8 @@ export * from './ThreadMessageDetails';
|
|
|
289
297
|
export * from './ThreadMessageResponse';
|
|
290
298
|
export * from './ThreadOrder';
|
|
291
299
|
export * from './ThreadResponse';
|
|
300
|
+
export * from './TimeBucket';
|
|
301
|
+
export * from './TimeseriesPoint';
|
|
292
302
|
export * from './ToolDisplayType';
|
|
293
303
|
export * from './ToolPart';
|
|
294
304
|
export * from './ToolStatus';
|
|
@@ -332,6 +342,8 @@ export * from './WorkflowDefinitionOrder';
|
|
|
332
342
|
export * from './WorkflowDefinitionResponse';
|
|
333
343
|
export * from './WorkflowDetailResponse';
|
|
334
344
|
export * from './WorkflowExecutionState';
|
|
345
|
+
export * from './WorkflowLeaderboardResponse';
|
|
346
|
+
export * from './WorkflowOutputStatsResponse';
|
|
335
347
|
export * from './WorkflowRunAsset';
|
|
336
348
|
export * from './WorkflowRunCallbackRequest';
|
|
337
349
|
export * from './WorkflowRunOrder';
|
package/dist/models/index.js
CHANGED
|
@@ -98,6 +98,7 @@ __exportStar(require("./DataSourceSchemaListResponse"), exports);
|
|
|
98
98
|
__exportStar(require("./DataSourceSchemaResponse"), exports);
|
|
99
99
|
__exportStar(require("./DataSourceSyncResponse"), exports);
|
|
100
100
|
__exportStar(require("./DataSourceTableResponse"), exports);
|
|
101
|
+
__exportStar(require("./DefinitionOutputStat"), exports);
|
|
101
102
|
__exportStar(require("./DiffFormat"), exports);
|
|
102
103
|
__exportStar(require("./DiffRow"), exports);
|
|
103
104
|
__exportStar(require("./DiffRowType"), exports);
|
|
@@ -149,6 +150,7 @@ __exportStar(require("./GroupPermissionResponse"), exports);
|
|
|
149
150
|
__exportStar(require("./GroupResponse"), exports);
|
|
150
151
|
__exportStar(require("./HTTPValidationError"), exports);
|
|
151
152
|
__exportStar(require("./HealthCheckResponse"), exports);
|
|
153
|
+
__exportStar(require("./HourHistogramResponse"), exports);
|
|
152
154
|
__exportStar(require("./HybridSearchProfile"), exports);
|
|
153
155
|
__exportStar(require("./IdpConfig"), exports);
|
|
154
156
|
__exportStar(require("./IdpType"), exports);
|
|
@@ -168,6 +170,11 @@ __exportStar(require("./InviteResponse"), exports);
|
|
|
168
170
|
__exportStar(require("./InviteStatus"), exports);
|
|
169
171
|
__exportStar(require("./InviteUserRequest"), exports);
|
|
170
172
|
__exportStar(require("./ItemPermissions"), exports);
|
|
173
|
+
__exportStar(require("./KbMetric"), exports);
|
|
174
|
+
__exportStar(require("./KbSummaryResponse"), exports);
|
|
175
|
+
__exportStar(require("./KbTimeseriesResponse"), exports);
|
|
176
|
+
__exportStar(require("./LabeledSeries"), exports);
|
|
177
|
+
__exportStar(require("./LeaderboardEntry"), exports);
|
|
171
178
|
__exportStar(require("./LineageEdgeResponse"), exports);
|
|
172
179
|
__exportStar(require("./LineageGraphResponse"), exports);
|
|
173
180
|
__exportStar(require("./LineageNodeResponse"), exports);
|
|
@@ -244,6 +251,7 @@ __exportStar(require("./RevisionEdit"), exports);
|
|
|
244
251
|
__exportStar(require("./RootResponse"), exports);
|
|
245
252
|
__exportStar(require("./RunFolder"), exports);
|
|
246
253
|
__exportStar(require("./RunFolderRef"), exports);
|
|
254
|
+
__exportStar(require("./RunTimeseriesResponse"), exports);
|
|
247
255
|
__exportStar(require("./SSOInitiateResponse"), exports);
|
|
248
256
|
__exportStar(require("./ScoredChunkResponse"), exports);
|
|
249
257
|
__exportStar(require("./SearchSkillsRequest"), exports);
|
|
@@ -307,6 +315,8 @@ __exportStar(require("./ThreadMessageDetails"), exports);
|
|
|
307
315
|
__exportStar(require("./ThreadMessageResponse"), exports);
|
|
308
316
|
__exportStar(require("./ThreadOrder"), exports);
|
|
309
317
|
__exportStar(require("./ThreadResponse"), exports);
|
|
318
|
+
__exportStar(require("./TimeBucket"), exports);
|
|
319
|
+
__exportStar(require("./TimeseriesPoint"), exports);
|
|
310
320
|
__exportStar(require("./ToolDisplayType"), exports);
|
|
311
321
|
__exportStar(require("./ToolPart"), exports);
|
|
312
322
|
__exportStar(require("./ToolStatus"), exports);
|
|
@@ -350,6 +360,8 @@ __exportStar(require("./WorkflowDefinitionOrder"), exports);
|
|
|
350
360
|
__exportStar(require("./WorkflowDefinitionResponse"), exports);
|
|
351
361
|
__exportStar(require("./WorkflowDetailResponse"), exports);
|
|
352
362
|
__exportStar(require("./WorkflowExecutionState"), exports);
|
|
363
|
+
__exportStar(require("./WorkflowLeaderboardResponse"), exports);
|
|
364
|
+
__exportStar(require("./WorkflowOutputStatsResponse"), exports);
|
|
353
365
|
__exportStar(require("./WorkflowRunAsset"), exports);
|
|
354
366
|
__exportStar(require("./WorkflowRunCallbackRequest"), exports);
|
|
355
367
|
__exportStar(require("./WorkflowRunOrder"), exports);
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
# AdminKbApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:8000*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**getAdminKbSummary**](AdminKbApi.md#getadminkbsummary) | **GET** /v1/admin/kb/summary | Get Admin Kb Summary Handler |
|
|
8
|
+
| [**getAdminKbTimeseries**](AdminKbApi.md#getadminkbtimeseries) | **GET** /v1/admin/kb/timeseries | Get Admin Kb Timeseries Handler |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## getAdminKbSummary
|
|
13
|
+
|
|
14
|
+
> KbSummaryResponse getAdminKbSummary()
|
|
15
|
+
|
|
16
|
+
Get Admin Kb Summary Handler
|
|
17
|
+
|
|
18
|
+
Point-in-time knowledge-base totals for the tenant.
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
import {
|
|
24
|
+
Configuration,
|
|
25
|
+
AdminKbApi,
|
|
26
|
+
} from '@knowledge-stack/ksapi';
|
|
27
|
+
import type { GetAdminKbSummaryRequest } from '@knowledge-stack/ksapi';
|
|
28
|
+
|
|
29
|
+
async function example() {
|
|
30
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
31
|
+
const config = new Configuration({
|
|
32
|
+
// To configure API key authorization: cookieAuth
|
|
33
|
+
apiKey: "YOUR API KEY",
|
|
34
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
35
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
36
|
+
});
|
|
37
|
+
const api = new AdminKbApi(config);
|
|
38
|
+
|
|
39
|
+
try {
|
|
40
|
+
const data = await api.getAdminKbSummary();
|
|
41
|
+
console.log(data);
|
|
42
|
+
} catch (error) {
|
|
43
|
+
console.error(error);
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
// Run the test
|
|
48
|
+
example().catch(console.error);
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Parameters
|
|
52
|
+
|
|
53
|
+
This endpoint does not need any parameter.
|
|
54
|
+
|
|
55
|
+
### Return type
|
|
56
|
+
|
|
57
|
+
[**KbSummaryResponse**](KbSummaryResponse.md)
|
|
58
|
+
|
|
59
|
+
### Authorization
|
|
60
|
+
|
|
61
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
62
|
+
|
|
63
|
+
### HTTP request headers
|
|
64
|
+
|
|
65
|
+
- **Content-Type**: Not defined
|
|
66
|
+
- **Accept**: `application/json`
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
### HTTP response details
|
|
70
|
+
| Status code | Description | Response headers |
|
|
71
|
+
|-------------|-------------|------------------|
|
|
72
|
+
| **200** | Successful Response | - |
|
|
73
|
+
| **0** | Error response. | - |
|
|
74
|
+
|
|
75
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
## getAdminKbTimeseries
|
|
79
|
+
|
|
80
|
+
> KbTimeseriesResponse getAdminKbTimeseries(metric, since, until, bucket, timezone)
|
|
81
|
+
|
|
82
|
+
Get Admin Kb Timeseries Handler
|
|
83
|
+
|
|
84
|
+
A knowledge-base metric bucketed over time, in the resolved timezone.
|
|
85
|
+
|
|
86
|
+
### Example
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
import {
|
|
90
|
+
Configuration,
|
|
91
|
+
AdminKbApi,
|
|
92
|
+
} from '@knowledge-stack/ksapi';
|
|
93
|
+
import type { GetAdminKbTimeseriesRequest } from '@knowledge-stack/ksapi';
|
|
94
|
+
|
|
95
|
+
async function example() {
|
|
96
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
97
|
+
const config = new Configuration({
|
|
98
|
+
// To configure API key authorization: cookieAuth
|
|
99
|
+
apiKey: "YOUR API KEY",
|
|
100
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
101
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
102
|
+
});
|
|
103
|
+
const api = new AdminKbApi(config);
|
|
104
|
+
|
|
105
|
+
const body = {
|
|
106
|
+
// KbMetric | Which KB metric to bucket.
|
|
107
|
+
metric: ...,
|
|
108
|
+
// Date | Window start. (optional)
|
|
109
|
+
since: 2013-10-20T19:20:30+01:00,
|
|
110
|
+
// Date | Window end. (optional)
|
|
111
|
+
until: 2013-10-20T19:20:30+01:00,
|
|
112
|
+
// TimeBucket | Bucket size. (optional)
|
|
113
|
+
bucket: ...,
|
|
114
|
+
// string | IANA tz override; defaults to tenant setting. (optional)
|
|
115
|
+
timezone: timezone_example,
|
|
116
|
+
} satisfies GetAdminKbTimeseriesRequest;
|
|
117
|
+
|
|
118
|
+
try {
|
|
119
|
+
const data = await api.getAdminKbTimeseries(body);
|
|
120
|
+
console.log(data);
|
|
121
|
+
} catch (error) {
|
|
122
|
+
console.error(error);
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
// Run the test
|
|
127
|
+
example().catch(console.error);
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Parameters
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
| Name | Type | Description | Notes |
|
|
134
|
+
|------------- | ------------- | ------------- | -------------|
|
|
135
|
+
| **metric** | `KbMetric` | Which KB metric to bucket. | [Defaults to `undefined`] [Enum: document_uploads, ingestion_completed, ingestion_failed] |
|
|
136
|
+
| **since** | `Date` | Window start. | [Optional] [Defaults to `undefined`] |
|
|
137
|
+
| **until** | `Date` | Window end. | [Optional] [Defaults to `undefined`] |
|
|
138
|
+
| **bucket** | `TimeBucket` | Bucket size. | [Optional] [Defaults to `undefined`] [Enum: hour, day, week, month] |
|
|
139
|
+
| **timezone** | `string` | IANA tz override; defaults to tenant setting. | [Optional] [Defaults to `undefined`] |
|
|
140
|
+
|
|
141
|
+
### Return type
|
|
142
|
+
|
|
143
|
+
[**KbTimeseriesResponse**](KbTimeseriesResponse.md)
|
|
144
|
+
|
|
145
|
+
### Authorization
|
|
146
|
+
|
|
147
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
148
|
+
|
|
149
|
+
### HTTP request headers
|
|
150
|
+
|
|
151
|
+
- **Content-Type**: Not defined
|
|
152
|
+
- **Accept**: `application/json`
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
### HTTP response details
|
|
156
|
+
| Status code | Description | Response headers |
|
|
157
|
+
|-------------|-------------|------------------|
|
|
158
|
+
| **200** | Successful Response | - |
|
|
159
|
+
| **422** | Validation Error | - |
|
|
160
|
+
| **0** | Error response. | - |
|
|
161
|
+
|
|
162
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
163
|
+
|