@crestal/nation-sdk 0.1.19 → 0.1.20

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/docs/AgentApi.md CHANGED
@@ -4,14 +4,30 @@ All URIs are relative to *http://localhost*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createAgent**](#createagent) | **POST** /agents | Create a new agent|
8
- |[**getAgentById**](#getagentbyid) | **GET** /agents/{aid} | Get agent by ID|
7
+ |[**createAgent**](#createagent) | **POST** /agents | Create Agent|
8
+ |[**createAgent_0**](#createagent_0) | **POST** /agents | Create Agent|
9
+ |[**exportAgent**](#exportagent) | **GET** /agents/{agent_id}/export | Export Agent|
10
+ |[**exportAgent_0**](#exportagent_0) | **GET** /agents/{agent_id}/export | Export Agent|
11
+ |[**getAgent**](#getagent) | **GET** /agents/{agent_id} | Get Agent|
9
12
  |[**getAgentStatistics**](#getagentstatistics) | **GET** /agents/{aid}/statistics | Get Agent Statistics|
13
+ |[**getAgent_0**](#getagent_0) | **GET** /agents/{agent_id} | Get Agent|
14
+ |[**getAgents**](#getagents) | **GET** /agents | Get Agents|
15
+ |[**getAgents_0**](#getagents_0) | **GET** /agents | Get Agents|
16
+ |[**importAgent**](#importagent) | **PUT** /agents/{agent_id}/import | Import Agent|
17
+ |[**importAgent_0**](#importagent_0) | **PUT** /agents/{agent_id}/import | Import Agent|
18
+ |[**overrideAgent**](#overrideagent) | **PUT** /agents/{agent_id} | Override Agent|
19
+ |[**overrideAgent_0**](#overrideagent_0) | **PUT** /agents/{agent_id} | Override Agent|
20
+ |[**updateAgent**](#updateagent) | **PATCH** /agents/{agent_id} | Update Agent|
21
+ |[**updateAgent_0**](#updateagent_0) | **PATCH** /agents/{agent_id} | Update Agent|
22
+ |[**validateAgentCreate**](#validateagentcreate) | **POST** /agent/validate | Validate Agent Create|
23
+ |[**validateAgentCreate_0**](#validateagentcreate_0) | **POST** /agent/validate | Validate Agent Create|
24
+ |[**validateAgentUpdate**](#validateagentupdate) | **POST** /agents/{agent_id}/validate | Validate Agent Update|
25
+ |[**validateAgentUpdate_0**](#validateagentupdate_0) | **POST** /agents/{agent_id}/validate | Validate Agent Update|
10
26
 
11
27
  # **createAgent**
12
- > AgentResponse createAgent(agentUpdate)
28
+ > AgentResponse createAgent()
13
29
 
14
- Create a new agent owned by the current user. The agent will be initialized with the provided details.
30
+ Create a new agent. **Request Body:** * `agent` - Agent configuration **Returns:** * `AgentResponse` - Created agent configuration with additional processed data **Raises:** * `HTTPException`: - 400: Invalid agent ID format or agent ID already exists - 500: Database error
15
31
 
16
32
  ### Example
17
33
 
@@ -25,7 +41,7 @@ import {
25
41
  const configuration = new Configuration();
26
42
  const apiInstance = new AgentApi(configuration);
27
43
 
28
- let agentUpdate: AgentUpdate; //
44
+ let agentUpdate: AgentUpdate; // (optional)
29
45
 
30
46
  const { status, data } = await apiInstance.createAgent(
31
47
  agentUpdate
@@ -53,6 +69,117 @@ const { status, data } = await apiInstance.createAgent(
53
69
  - **Accept**: application/json
54
70
 
55
71
 
72
+ ### HTTP response details
73
+ | Status code | Description | Response headers |
74
+ |-------------|-------------|------------------|
75
+ |**200** | Agent already exists | - |
76
+ |**201** | Agent created | - |
77
+ |**400** | Other client errors except format error | - |
78
+ |**422** | Invalid agent configuration | - |
79
+ |**500** | Server error | - |
80
+
81
+ [[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)
82
+
83
+ # **createAgent_0**
84
+ > AgentResponse createAgent_0()
85
+
86
+ Create a new agent. **Request Body:** * `agent` - Agent configuration **Returns:** * `AgentResponse` - Created agent configuration with additional processed data **Raises:** * `HTTPException`: - 400: Invalid agent ID format or agent ID already exists - 500: Database error
87
+
88
+ ### Example
89
+
90
+ ```typescript
91
+ import {
92
+ AgentApi,
93
+ Configuration,
94
+ AgentUpdate
95
+ } from '@crestal/nation-sdk';
96
+
97
+ const configuration = new Configuration();
98
+ const apiInstance = new AgentApi(configuration);
99
+
100
+ let agentUpdate: AgentUpdate; // (optional)
101
+
102
+ const { status, data } = await apiInstance.createAgent_0(
103
+ agentUpdate
104
+ );
105
+ ```
106
+
107
+ ### Parameters
108
+
109
+ |Name | Type | Description | Notes|
110
+ |------------- | ------------- | ------------- | -------------|
111
+ | **agentUpdate** | **AgentUpdate**| | |
112
+
113
+
114
+ ### Return type
115
+
116
+ **AgentResponse**
117
+
118
+ ### Authorization
119
+
120
+ [HTTPBearer](../README.md#HTTPBearer)
121
+
122
+ ### HTTP request headers
123
+
124
+ - **Content-Type**: application/json
125
+ - **Accept**: application/json
126
+
127
+
128
+ ### HTTP response details
129
+ | Status code | Description | Response headers |
130
+ |-------------|-------------|------------------|
131
+ |**200** | Agent already exists | - |
132
+ |**201** | Agent created | - |
133
+ |**400** | Other client errors except format error | - |
134
+ |**422** | Invalid agent configuration | - |
135
+ |**500** | Server error | - |
136
+
137
+ [[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)
138
+
139
+ # **exportAgent**
140
+ > any exportAgent()
141
+
142
+ Export agent configuration as YAML. **Path Parameters:** * `agent_id` - ID of the agent to export **Returns:** * `str` - YAML configuration of the agent **Raises:** * `HTTPException`: - 404: Agent not found
143
+
144
+ ### Example
145
+
146
+ ```typescript
147
+ import {
148
+ AgentApi,
149
+ Configuration
150
+ } from '@crestal/nation-sdk';
151
+
152
+ const configuration = new Configuration();
153
+ const apiInstance = new AgentApi(configuration);
154
+
155
+ let agentId: string; //ID of the agent to export (default to undefined)
156
+
157
+ const { status, data } = await apiInstance.exportAgent(
158
+ agentId
159
+ );
160
+ ```
161
+
162
+ ### Parameters
163
+
164
+ |Name | Type | Description | Notes|
165
+ |------------- | ------------- | ------------- | -------------|
166
+ | **agentId** | [**string**] | ID of the agent to export | defaults to undefined|
167
+
168
+
169
+ ### Return type
170
+
171
+ **any**
172
+
173
+ ### Authorization
174
+
175
+ [HTTPBearer](../README.md#HTTPBearer)
176
+
177
+ ### HTTP request headers
178
+
179
+ - **Content-Type**: Not defined
180
+ - **Accept**: application/json
181
+
182
+
56
183
  ### HTTP response details
57
184
  | Status code | Description | Response headers |
58
185
  |-------------|-------------|------------------|
@@ -61,10 +188,10 @@ const { status, data } = await apiInstance.createAgent(
61
188
 
62
189
  [[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)
63
190
 
64
- # **getAgentById**
65
- > AgentResponse getAgentById()
191
+ # **exportAgent_0**
192
+ > any exportAgent_0()
66
193
 
67
- Retrieve a specific agent by its ID. Returns 404 if not found.
194
+ Export agent configuration as YAML. **Path Parameters:** * `agent_id` - ID of the agent to export **Returns:** * `str` - YAML configuration of the agent **Raises:** * `HTTPException`: - 404: Agent not found
68
195
 
69
196
  ### Example
70
197
 
@@ -77,10 +204,10 @@ import {
77
204
  const configuration = new Configuration();
78
205
  const apiInstance = new AgentApi(configuration);
79
206
 
80
- let aid: string; //Agent ID (default to undefined)
207
+ let agentId: string; //ID of the agent to export (default to undefined)
81
208
 
82
- const { status, data } = await apiInstance.getAgentById(
83
- aid
209
+ const { status, data } = await apiInstance.exportAgent_0(
210
+ agentId
84
211
  );
85
212
  ```
86
213
 
@@ -88,12 +215,64 @@ const { status, data } = await apiInstance.getAgentById(
88
215
 
89
216
  |Name | Type | Description | Notes|
90
217
  |------------- | ------------- | ------------- | -------------|
91
- | **aid** | [**string**] | Agent ID | defaults to undefined|
218
+ | **agentId** | [**string**] | ID of the agent to export | defaults to undefined|
92
219
 
93
220
 
94
221
  ### Return type
95
222
 
96
- **AgentResponse**
223
+ **any**
224
+
225
+ ### Authorization
226
+
227
+ [HTTPBearer](../README.md#HTTPBearer)
228
+
229
+ ### HTTP request headers
230
+
231
+ - **Content-Type**: Not defined
232
+ - **Accept**: application/json
233
+
234
+
235
+ ### HTTP response details
236
+ | Status code | Description | Response headers |
237
+ |-------------|-------------|------------------|
238
+ |**200** | Successful Response | - |
239
+ |**422** | Validation Error | - |
240
+
241
+ [[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)
242
+
243
+ # **getAgent**
244
+ > any getAgent()
245
+
246
+ Get a single agent by ID. **Path Parameters:** * `agent_id` - ID of the agent to retrieve **Returns:** * `AgentResponse` - Agent configuration with additional processed data **Raises:** * `HTTPException`: - 404: Agent not found
247
+
248
+ ### Example
249
+
250
+ ```typescript
251
+ import {
252
+ AgentApi,
253
+ Configuration
254
+ } from '@crestal/nation-sdk';
255
+
256
+ const configuration = new Configuration();
257
+ const apiInstance = new AgentApi(configuration);
258
+
259
+ let agentId: string; //ID of the agent to retrieve (default to undefined)
260
+
261
+ const { status, data } = await apiInstance.getAgent(
262
+ agentId
263
+ );
264
+ ```
265
+
266
+ ### Parameters
267
+
268
+ |Name | Type | Description | Notes|
269
+ |------------- | ------------- | ------------- | -------------|
270
+ | **agentId** | [**string**] | ID of the agent to retrieve | defaults to undefined|
271
+
272
+
273
+ ### Return type
274
+
275
+ **any**
97
276
 
98
277
  ### Authorization
99
278
 
@@ -165,3 +344,723 @@ No authorization required
165
344
 
166
345
  [[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)
167
346
 
347
+ # **getAgent_0**
348
+ > any getAgent_0()
349
+
350
+ Get a single agent by ID. **Path Parameters:** * `agent_id` - ID of the agent to retrieve **Returns:** * `AgentResponse` - Agent configuration with additional processed data **Raises:** * `HTTPException`: - 404: Agent not found
351
+
352
+ ### Example
353
+
354
+ ```typescript
355
+ import {
356
+ AgentApi,
357
+ Configuration
358
+ } from '@crestal/nation-sdk';
359
+
360
+ const configuration = new Configuration();
361
+ const apiInstance = new AgentApi(configuration);
362
+
363
+ let agentId: string; //ID of the agent to retrieve (default to undefined)
364
+
365
+ const { status, data } = await apiInstance.getAgent_0(
366
+ agentId
367
+ );
368
+ ```
369
+
370
+ ### Parameters
371
+
372
+ |Name | Type | Description | Notes|
373
+ |------------- | ------------- | ------------- | -------------|
374
+ | **agentId** | [**string**] | ID of the agent to retrieve | defaults to undefined|
375
+
376
+
377
+ ### Return type
378
+
379
+ **any**
380
+
381
+ ### Authorization
382
+
383
+ No authorization required
384
+
385
+ ### HTTP request headers
386
+
387
+ - **Content-Type**: Not defined
388
+ - **Accept**: application/json
389
+
390
+
391
+ ### HTTP response details
392
+ | Status code | Description | Response headers |
393
+ |-------------|-------------|------------------|
394
+ |**200** | Successful Response | - |
395
+ |**422** | Validation Error | - |
396
+
397
+ [[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)
398
+
399
+ # **getAgents**
400
+ > AgentListResponse getAgents()
401
+
402
+ Get all agents with their quota information. **Query Parameters:** * `sort` - Sort order for the agents list * `cursor` - Cursor for pagination * `limit` - Maximum number of agents to return (1-100) **Returns:** * `AgentListResponse` - Paginated list of agents with their quota information and additional processed data
403
+
404
+ ### Example
405
+
406
+ ```typescript
407
+ import {
408
+ AgentApi,
409
+ Configuration
410
+ } from '@crestal/nation-sdk';
411
+
412
+ const configuration = new Configuration();
413
+ const apiInstance = new AgentApi(configuration);
414
+
415
+ let sort: AgentSortOption; //Sort order for agents list (optional) (default to undefined)
416
+ let cursor: string; //Cursor for pagination (optional) (default to undefined)
417
+ let limit: number; //Maximum number of agents to return (optional) (default to 20)
418
+
419
+ const { status, data } = await apiInstance.getAgents(
420
+ sort,
421
+ cursor,
422
+ limit
423
+ );
424
+ ```
425
+
426
+ ### Parameters
427
+
428
+ |Name | Type | Description | Notes|
429
+ |------------- | ------------- | ------------- | -------------|
430
+ | **sort** | **AgentSortOption** | Sort order for agents list | (optional) defaults to undefined|
431
+ | **cursor** | [**string**] | Cursor for pagination | (optional) defaults to undefined|
432
+ | **limit** | [**number**] | Maximum number of agents to return | (optional) defaults to 20|
433
+
434
+
435
+ ### Return type
436
+
437
+ **AgentListResponse**
438
+
439
+ ### Authorization
440
+
441
+ No authorization required
442
+
443
+ ### HTTP request headers
444
+
445
+ - **Content-Type**: Not defined
446
+ - **Accept**: application/json
447
+
448
+
449
+ ### HTTP response details
450
+ | Status code | Description | Response headers |
451
+ |-------------|-------------|------------------|
452
+ |**200** | Successful Response | - |
453
+ |**422** | Validation Error | - |
454
+
455
+ [[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)
456
+
457
+ # **getAgents_0**
458
+ > AgentListResponse getAgents_0()
459
+
460
+ Get all agents with their quota information. **Query Parameters:** * `sort` - Sort order for the agents list * `cursor` - Cursor for pagination * `limit` - Maximum number of agents to return (1-100) **Returns:** * `AgentListResponse` - Paginated list of agents with their quota information and additional processed data
461
+
462
+ ### Example
463
+
464
+ ```typescript
465
+ import {
466
+ AgentApi,
467
+ Configuration
468
+ } from '@crestal/nation-sdk';
469
+
470
+ const configuration = new Configuration();
471
+ const apiInstance = new AgentApi(configuration);
472
+
473
+ let sort: AgentSortOption; //Sort order for agents list (optional) (default to undefined)
474
+ let cursor: string; //Cursor for pagination (optional) (default to undefined)
475
+ let limit: number; //Maximum number of agents to return (optional) (default to 20)
476
+
477
+ const { status, data } = await apiInstance.getAgents_0(
478
+ sort,
479
+ cursor,
480
+ limit
481
+ );
482
+ ```
483
+
484
+ ### Parameters
485
+
486
+ |Name | Type | Description | Notes|
487
+ |------------- | ------------- | ------------- | -------------|
488
+ | **sort** | **AgentSortOption** | Sort order for agents list | (optional) defaults to undefined|
489
+ | **cursor** | [**string**] | Cursor for pagination | (optional) defaults to undefined|
490
+ | **limit** | [**number**] | Maximum number of agents to return | (optional) defaults to 20|
491
+
492
+
493
+ ### Return type
494
+
495
+ **AgentListResponse**
496
+
497
+ ### Authorization
498
+
499
+ No authorization required
500
+
501
+ ### HTTP request headers
502
+
503
+ - **Content-Type**: Not defined
504
+ - **Accept**: application/json
505
+
506
+
507
+ ### HTTP response details
508
+ | Status code | Description | Response headers |
509
+ |-------------|-------------|------------------|
510
+ |**200** | Successful Response | - |
511
+ |**422** | Validation Error | - |
512
+
513
+ [[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)
514
+
515
+ # **importAgent**
516
+ > string importAgent()
517
+
518
+ Import agent configuration from YAML file. Only updates existing agents, will not create new ones. **Path Parameters:** * `agent_id` - ID of the agent to update **Request Body:** * `file` - YAML file containing agent configuration **Returns:** * `str` - Success message **Raises:** * `HTTPException`: - 400: Invalid YAML or agent configuration - 404: Agent not found - 500: Server error
519
+
520
+ ### Example
521
+
522
+ ```typescript
523
+ import {
524
+ AgentApi,
525
+ Configuration
526
+ } from '@crestal/nation-sdk';
527
+
528
+ const configuration = new Configuration();
529
+ const apiInstance = new AgentApi(configuration);
530
+
531
+ let agentId: string; // (default to undefined)
532
+ let file: File; //YAML file containing agent configuration (default to undefined)
533
+
534
+ const { status, data } = await apiInstance.importAgent(
535
+ agentId,
536
+ file
537
+ );
538
+ ```
539
+
540
+ ### Parameters
541
+
542
+ |Name | Type | Description | Notes|
543
+ |------------- | ------------- | ------------- | -------------|
544
+ | **agentId** | [**string**] | | defaults to undefined|
545
+ | **file** | [**File**] | YAML file containing agent configuration | defaults to undefined|
546
+
547
+
548
+ ### Return type
549
+
550
+ **string**
551
+
552
+ ### Authorization
553
+
554
+ [HTTPBearer](../README.md#HTTPBearer)
555
+
556
+ ### HTTP request headers
557
+
558
+ - **Content-Type**: multipart/form-data
559
+ - **Accept**: text/plain, application/json
560
+
561
+
562
+ ### HTTP response details
563
+ | Status code | Description | Response headers |
564
+ |-------------|-------------|------------------|
565
+ |**200** | Successful Response | - |
566
+ |**422** | Validation Error | - |
567
+
568
+ [[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)
569
+
570
+ # **importAgent_0**
571
+ > string importAgent_0()
572
+
573
+ Import agent configuration from YAML file. Only updates existing agents, will not create new ones. **Path Parameters:** * `agent_id` - ID of the agent to update **Request Body:** * `file` - YAML file containing agent configuration **Returns:** * `str` - Success message **Raises:** * `HTTPException`: - 400: Invalid YAML or agent configuration - 404: Agent not found - 500: Server error
574
+
575
+ ### Example
576
+
577
+ ```typescript
578
+ import {
579
+ AgentApi,
580
+ Configuration
581
+ } from '@crestal/nation-sdk';
582
+
583
+ const configuration = new Configuration();
584
+ const apiInstance = new AgentApi(configuration);
585
+
586
+ let agentId: string; // (default to undefined)
587
+ let file: File; //YAML file containing agent configuration (default to undefined)
588
+
589
+ const { status, data } = await apiInstance.importAgent_0(
590
+ agentId,
591
+ file
592
+ );
593
+ ```
594
+
595
+ ### Parameters
596
+
597
+ |Name | Type | Description | Notes|
598
+ |------------- | ------------- | ------------- | -------------|
599
+ | **agentId** | [**string**] | | defaults to undefined|
600
+ | **file** | [**File**] | YAML file containing agent configuration | defaults to undefined|
601
+
602
+
603
+ ### Return type
604
+
605
+ **string**
606
+
607
+ ### Authorization
608
+
609
+ [HTTPBearer](../README.md#HTTPBearer)
610
+
611
+ ### HTTP request headers
612
+
613
+ - **Content-Type**: multipart/form-data
614
+ - **Accept**: text/plain, application/json
615
+
616
+
617
+ ### HTTP response details
618
+ | Status code | Description | Response headers |
619
+ |-------------|-------------|------------------|
620
+ |**200** | Successful Response | - |
621
+ |**422** | Validation Error | - |
622
+
623
+ [[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)
624
+
625
+ # **overrideAgent**
626
+ > any overrideAgent()
627
+
628
+ Override an existing agent. Use input to override agent configuration. If some fields are not provided, they will be reset to default values. **Path Parameters:** * `agent_id` - ID of the agent to update **Request Body:** * `agent` - Agent update configuration **Returns:** * `AgentResponse` - Updated agent configuration with additional processed data **Raises:** * `HTTPException`: - 400: Invalid agent ID format - 404: Agent not found - 403: Permission denied (if owner mismatch) - 500: Database error
629
+
630
+ ### Example
631
+
632
+ ```typescript
633
+ import {
634
+ AgentApi,
635
+ Configuration,
636
+ AgentUpdate
637
+ } from '@crestal/nation-sdk';
638
+
639
+ const configuration = new Configuration();
640
+ const apiInstance = new AgentApi(configuration);
641
+
642
+ let agentId: string; //ID of the agent to update (default to undefined)
643
+ let agentUpdate: AgentUpdate; // (optional)
644
+
645
+ const { status, data } = await apiInstance.overrideAgent(
646
+ agentId,
647
+ agentUpdate
648
+ );
649
+ ```
650
+
651
+ ### Parameters
652
+
653
+ |Name | Type | Description | Notes|
654
+ |------------- | ------------- | ------------- | -------------|
655
+ | **agentUpdate** | **AgentUpdate**| | |
656
+ | **agentId** | [**string**] | ID of the agent to update | defaults to undefined|
657
+
658
+
659
+ ### Return type
660
+
661
+ **any**
662
+
663
+ ### Authorization
664
+
665
+ [HTTPBearer](../README.md#HTTPBearer)
666
+
667
+ ### HTTP request headers
668
+
669
+ - **Content-Type**: application/json
670
+ - **Accept**: application/json
671
+
672
+
673
+ ### HTTP response details
674
+ | Status code | Description | Response headers |
675
+ |-------------|-------------|------------------|
676
+ |**200** | Successful Response | - |
677
+ |**422** | Validation Error | - |
678
+
679
+ [[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)
680
+
681
+ # **overrideAgent_0**
682
+ > any overrideAgent_0()
683
+
684
+ Override an existing agent. Use input to override agent configuration. If some fields are not provided, they will be reset to default values. **Path Parameters:** * `agent_id` - ID of the agent to update **Request Body:** * `agent` - Agent update configuration **Returns:** * `AgentResponse` - Updated agent configuration with additional processed data **Raises:** * `HTTPException`: - 400: Invalid agent ID format - 404: Agent not found - 403: Permission denied (if owner mismatch) - 500: Database error
685
+
686
+ ### Example
687
+
688
+ ```typescript
689
+ import {
690
+ AgentApi,
691
+ Configuration,
692
+ AgentUpdate
693
+ } from '@crestal/nation-sdk';
694
+
695
+ const configuration = new Configuration();
696
+ const apiInstance = new AgentApi(configuration);
697
+
698
+ let agentId: string; //ID of the agent to update (default to undefined)
699
+ let agentUpdate: AgentUpdate; // (optional)
700
+
701
+ const { status, data } = await apiInstance.overrideAgent_0(
702
+ agentId,
703
+ agentUpdate
704
+ );
705
+ ```
706
+
707
+ ### Parameters
708
+
709
+ |Name | Type | Description | Notes|
710
+ |------------- | ------------- | ------------- | -------------|
711
+ | **agentUpdate** | **AgentUpdate**| | |
712
+ | **agentId** | [**string**] | ID of the agent to update | defaults to undefined|
713
+
714
+
715
+ ### Return type
716
+
717
+ **any**
718
+
719
+ ### Authorization
720
+
721
+ [HTTPBearer](../README.md#HTTPBearer)
722
+
723
+ ### HTTP request headers
724
+
725
+ - **Content-Type**: application/json
726
+ - **Accept**: application/json
727
+
728
+
729
+ ### HTTP response details
730
+ | Status code | Description | Response headers |
731
+ |-------------|-------------|------------------|
732
+ |**200** | Successful Response | - |
733
+ |**422** | Validation Error | - |
734
+
735
+ [[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)
736
+
737
+ # **updateAgent**
738
+ > any updateAgent()
739
+
740
+ Update an existing agent. Use input to update agent configuration. If some fields are not provided, they will not be changed. **Path Parameters:** * `agent_id` - ID of the agent to update **Request Body:** * `agent` - Agent update configuration **Returns:** * `AgentResponse` - Updated agent configuration with additional processed data **Raises:** * `HTTPException`: - 400: Invalid agent ID format - 404: Agent not found - 403: Permission denied (if owner mismatch) - 500: Database error
741
+
742
+ ### Example
743
+
744
+ ```typescript
745
+ import {
746
+ AgentApi,
747
+ Configuration,
748
+ AgentUpdate
749
+ } from '@crestal/nation-sdk';
750
+
751
+ const configuration = new Configuration();
752
+ const apiInstance = new AgentApi(configuration);
753
+
754
+ let agentId: string; //ID of the agent to update (default to undefined)
755
+ let agentUpdate: AgentUpdate; // (optional)
756
+
757
+ const { status, data } = await apiInstance.updateAgent(
758
+ agentId,
759
+ agentUpdate
760
+ );
761
+ ```
762
+
763
+ ### Parameters
764
+
765
+ |Name | Type | Description | Notes|
766
+ |------------- | ------------- | ------------- | -------------|
767
+ | **agentUpdate** | **AgentUpdate**| | |
768
+ | **agentId** | [**string**] | ID of the agent to update | defaults to undefined|
769
+
770
+
771
+ ### Return type
772
+
773
+ **any**
774
+
775
+ ### Authorization
776
+
777
+ [HTTPBearer](../README.md#HTTPBearer)
778
+
779
+ ### HTTP request headers
780
+
781
+ - **Content-Type**: application/json
782
+ - **Accept**: application/json
783
+
784
+
785
+ ### HTTP response details
786
+ | Status code | Description | Response headers |
787
+ |-------------|-------------|------------------|
788
+ |**200** | Successful Response | - |
789
+ |**422** | Validation Error | - |
790
+
791
+ [[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)
792
+
793
+ # **updateAgent_0**
794
+ > any updateAgent_0()
795
+
796
+ Update an existing agent. Use input to update agent configuration. If some fields are not provided, they will not be changed. **Path Parameters:** * `agent_id` - ID of the agent to update **Request Body:** * `agent` - Agent update configuration **Returns:** * `AgentResponse` - Updated agent configuration with additional processed data **Raises:** * `HTTPException`: - 400: Invalid agent ID format - 404: Agent not found - 403: Permission denied (if owner mismatch) - 500: Database error
797
+
798
+ ### Example
799
+
800
+ ```typescript
801
+ import {
802
+ AgentApi,
803
+ Configuration,
804
+ AgentUpdate
805
+ } from '@crestal/nation-sdk';
806
+
807
+ const configuration = new Configuration();
808
+ const apiInstance = new AgentApi(configuration);
809
+
810
+ let agentId: string; //ID of the agent to update (default to undefined)
811
+ let agentUpdate: AgentUpdate; // (optional)
812
+
813
+ const { status, data } = await apiInstance.updateAgent_0(
814
+ agentId,
815
+ agentUpdate
816
+ );
817
+ ```
818
+
819
+ ### Parameters
820
+
821
+ |Name | Type | Description | Notes|
822
+ |------------- | ------------- | ------------- | -------------|
823
+ | **agentUpdate** | **AgentUpdate**| | |
824
+ | **agentId** | [**string**] | ID of the agent to update | defaults to undefined|
825
+
826
+
827
+ ### Return type
828
+
829
+ **any**
830
+
831
+ ### Authorization
832
+
833
+ [HTTPBearer](../README.md#HTTPBearer)
834
+
835
+ ### HTTP request headers
836
+
837
+ - **Content-Type**: application/json
838
+ - **Accept**: application/json
839
+
840
+
841
+ ### HTTP response details
842
+ | Status code | Description | Response headers |
843
+ |-------------|-------------|------------------|
844
+ |**200** | Successful Response | - |
845
+ |**422** | Validation Error | - |
846
+
847
+ [[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)
848
+
849
+ # **validateAgentCreate**
850
+ > validateAgentCreate()
851
+
852
+ Validate agent configuration. **Request Body:** * `agent` - Agent configuration **Returns:** * `204 No Content` - Agent configuration is valid **Raises:** * `HTTPException`: - 400: Invalid agent configuration - 422: Invalid agent configuration from intentkit core - 500: Server error
853
+
854
+ ### Example
855
+
856
+ ```typescript
857
+ import {
858
+ AgentApi,
859
+ Configuration,
860
+ AgentUpdate
861
+ } from '@crestal/nation-sdk';
862
+
863
+ const configuration = new Configuration();
864
+ const apiInstance = new AgentApi(configuration);
865
+
866
+ let agentUpdate: AgentUpdate; // (optional)
867
+
868
+ const { status, data } = await apiInstance.validateAgentCreate(
869
+ agentUpdate
870
+ );
871
+ ```
872
+
873
+ ### Parameters
874
+
875
+ |Name | Type | Description | Notes|
876
+ |------------- | ------------- | ------------- | -------------|
877
+ | **agentUpdate** | **AgentUpdate**| | |
878
+
879
+
880
+ ### Return type
881
+
882
+ void (empty response body)
883
+
884
+ ### Authorization
885
+
886
+ [HTTPBearer](../README.md#HTTPBearer)
887
+
888
+ ### HTTP request headers
889
+
890
+ - **Content-Type**: application/json
891
+ - **Accept**: application/json
892
+
893
+
894
+ ### HTTP response details
895
+ | Status code | Description | Response headers |
896
+ |-------------|-------------|------------------|
897
+ |**204** | Successful Response | - |
898
+ |**422** | Validation Error | - |
899
+
900
+ [[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)
901
+
902
+ # **validateAgentCreate_0**
903
+ > validateAgentCreate_0()
904
+
905
+ Validate agent configuration. **Request Body:** * `agent` - Agent configuration **Returns:** * `204 No Content` - Agent configuration is valid **Raises:** * `HTTPException`: - 400: Invalid agent configuration - 422: Invalid agent configuration from intentkit core - 500: Server error
906
+
907
+ ### Example
908
+
909
+ ```typescript
910
+ import {
911
+ AgentApi,
912
+ Configuration,
913
+ AgentUpdate
914
+ } from '@crestal/nation-sdk';
915
+
916
+ const configuration = new Configuration();
917
+ const apiInstance = new AgentApi(configuration);
918
+
919
+ let agentUpdate: AgentUpdate; // (optional)
920
+
921
+ const { status, data } = await apiInstance.validateAgentCreate_0(
922
+ agentUpdate
923
+ );
924
+ ```
925
+
926
+ ### Parameters
927
+
928
+ |Name | Type | Description | Notes|
929
+ |------------- | ------------- | ------------- | -------------|
930
+ | **agentUpdate** | **AgentUpdate**| | |
931
+
932
+
933
+ ### Return type
934
+
935
+ void (empty response body)
936
+
937
+ ### Authorization
938
+
939
+ [HTTPBearer](../README.md#HTTPBearer)
940
+
941
+ ### HTTP request headers
942
+
943
+ - **Content-Type**: application/json
944
+ - **Accept**: application/json
945
+
946
+
947
+ ### HTTP response details
948
+ | Status code | Description | Response headers |
949
+ |-------------|-------------|------------------|
950
+ |**204** | Successful Response | - |
951
+ |**422** | Validation Error | - |
952
+
953
+ [[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)
954
+
955
+ # **validateAgentUpdate**
956
+ > validateAgentUpdate()
957
+
958
+ Validate agent configuration. **Request Body:** * `agent` - Agent configuration **Returns:** * `204 No Content` - Agent configuration is valid **Raises:** * `HTTPException`: - 400: Invalid agent configuration - 422: Invalid agent configuration from intentkit core - 500: Server error
959
+
960
+ ### Example
961
+
962
+ ```typescript
963
+ import {
964
+ AgentApi,
965
+ Configuration,
966
+ AgentUpdate
967
+ } from '@crestal/nation-sdk';
968
+
969
+ const configuration = new Configuration();
970
+ const apiInstance = new AgentApi(configuration);
971
+
972
+ let agentId: string; //Agent ID (default to undefined)
973
+ let agentUpdate: AgentUpdate; // (optional)
974
+
975
+ const { status, data } = await apiInstance.validateAgentUpdate(
976
+ agentId,
977
+ agentUpdate
978
+ );
979
+ ```
980
+
981
+ ### Parameters
982
+
983
+ |Name | Type | Description | Notes|
984
+ |------------- | ------------- | ------------- | -------------|
985
+ | **agentUpdate** | **AgentUpdate**| | |
986
+ | **agentId** | [**string**] | Agent ID | defaults to undefined|
987
+
988
+
989
+ ### Return type
990
+
991
+ void (empty response body)
992
+
993
+ ### Authorization
994
+
995
+ [HTTPBearer](../README.md#HTTPBearer)
996
+
997
+ ### HTTP request headers
998
+
999
+ - **Content-Type**: application/json
1000
+ - **Accept**: application/json
1001
+
1002
+
1003
+ ### HTTP response details
1004
+ | Status code | Description | Response headers |
1005
+ |-------------|-------------|------------------|
1006
+ |**204** | Successful Response | - |
1007
+ |**422** | Validation Error | - |
1008
+
1009
+ [[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)
1010
+
1011
+ # **validateAgentUpdate_0**
1012
+ > validateAgentUpdate_0()
1013
+
1014
+ Validate agent configuration. **Request Body:** * `agent` - Agent configuration **Returns:** * `204 No Content` - Agent configuration is valid **Raises:** * `HTTPException`: - 400: Invalid agent configuration - 422: Invalid agent configuration from intentkit core - 500: Server error
1015
+
1016
+ ### Example
1017
+
1018
+ ```typescript
1019
+ import {
1020
+ AgentApi,
1021
+ Configuration,
1022
+ AgentUpdate
1023
+ } from '@crestal/nation-sdk';
1024
+
1025
+ const configuration = new Configuration();
1026
+ const apiInstance = new AgentApi(configuration);
1027
+
1028
+ let agentId: string; //Agent ID (default to undefined)
1029
+ let agentUpdate: AgentUpdate; // (optional)
1030
+
1031
+ const { status, data } = await apiInstance.validateAgentUpdate_0(
1032
+ agentId,
1033
+ agentUpdate
1034
+ );
1035
+ ```
1036
+
1037
+ ### Parameters
1038
+
1039
+ |Name | Type | Description | Notes|
1040
+ |------------- | ------------- | ------------- | -------------|
1041
+ | **agentUpdate** | **AgentUpdate**| | |
1042
+ | **agentId** | [**string**] | Agent ID | defaults to undefined|
1043
+
1044
+
1045
+ ### Return type
1046
+
1047
+ void (empty response body)
1048
+
1049
+ ### Authorization
1050
+
1051
+ [HTTPBearer](../README.md#HTTPBearer)
1052
+
1053
+ ### HTTP request headers
1054
+
1055
+ - **Content-Type**: application/json
1056
+ - **Accept**: application/json
1057
+
1058
+
1059
+ ### HTTP response details
1060
+ | Status code | Description | Response headers |
1061
+ |-------------|-------------|------------------|
1062
+ |**204** | Successful Response | - |
1063
+ |**422** | Validation Error | - |
1064
+
1065
+ [[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)
1066
+