-
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathopenapi.yaml
More file actions
2521 lines (2518 loc) · 77.2 KB
/
openapi.yaml
File metadata and controls
2521 lines (2518 loc) · 77.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
title: fleet-rlm
version: 0.5.0
paths:
/health:
get:
tags:
- health
summary: Health
description: Report a lightweight server health signal and package version.
operationId: health_health_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
'503':
description: Health status could not be determined.
/ready:
get:
tags:
- health
summary: Ready
description: Report whether critical startup dependencies are ready for requests.
operationId: ready_ready_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ReadyResponse'
'503':
description: Readiness evaluation could not complete.
/api/v1/auth/me:
get:
tags:
- auth
summary: Get Me
description: Return the authenticated identity and any admitted control-plane
IDs.
operationId: get_me_api_v1_auth_me_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AuthMeResponse'
'401':
description: Authentication is required or the provided token is invalid.
'403':
description: The authenticated tenant or user is not admitted to Fleet RLM.
'503':
description: Authentication or repository services are not configured yet.
security:
- HTTPBearer: []
/api/v1/sessions/state:
get:
tags:
- sessions
summary: List Session State
description: Return lightweight summaries of active/restored in-memory session
state.
operationId: list_session_state_api_v1_sessions_state_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SessionStateResponse'
'401':
description: Authentication is required or the provided token is invalid.
'503':
description: Session state is unavailable because server startup is incomplete.
security:
- HTTPBearer: []
/api/v1/sessions:
get:
tags:
- sessions
summary: List session history
description: Paginated list of durable session transcripts with search and status
filters.
operationId: list_sessions_endpoint_api_v1_sessions_get
security:
- HTTPBearer: []
parameters:
- name: search
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Full-text search on title
title: Search
description: Full-text search on title
- name: status
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter by status (active, archived)
title: Status
description: Filter by status (active, archived)
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
description: Page size
default: 20
title: Limit
description: Page size
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
default: 0
title: Offset
description: Pagination offset
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SessionListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions/{session_id}:
get:
tags:
- sessions
summary: Get session detail
description: Return session metadata and turn count for a specific session.
operationId: get_session_detail_api_v1_sessions__session_id__get
security:
- HTTPBearer: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
description: Identifier of the session to inspect.
title: Session Id
description: Identifier of the session to inspect.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SessionDetailResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- sessions
summary: Archive session
description: Soft-delete (archive) a session. Returns success when archived,
404 if not found or not owned.
operationId: delete_session_endpoint_api_v1_sessions__session_id__delete
security:
- HTTPBearer: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
description: Identifier of the session to archive.
title: Session Id
description: Identifier of the session to archive.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SessionDeleteResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions/{session_id}/turns:
get:
tags:
- sessions
summary: Get session turns
description: Paginated turn-by-turn transcript for a session.
operationId: get_session_turns_api_v1_sessions__session_id__turns_get
security:
- HTTPBearer: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
description: Identifier of the session whose turns to list.
title: Session Id
description: Identifier of the session whose turns to list.
- name: limit
in: query
required: false
schema:
type: integer
maximum: 200
minimum: 1
description: Page size
default: 50
title: Limit
description: Page size
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
default: 0
title: Offset
description: Pagination offset
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TurnListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions/{session_id}/export:
post:
tags:
- sessions
summary: Export session as GEPA dataset
description: Convert a session's turn history into a JSONL dataset suitable
for GEPA optimization. Requires a target module slug to determine the column
mapping.
operationId: export_session_endpoint_api_v1_sessions__session_id__export_post
security:
- HTTPBearer: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
description: Identifier of the session to export as a dataset.
title: Session Id
description: Identifier of the session to export as a dataset.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SessionExportRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/runtime/settings:
get:
tags:
- runtime
summary: Get Runtime Settings
description: Return the effective runtime settings snapshot used by the local
server.
operationId: get_runtime_settings_api_v1_runtime_settings_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RuntimeSettingsSnapshot'
'401':
description: Authentication is required or the provided token is invalid.
'503':
description: Runtime services are unavailable because server startup is
incomplete.
security:
- HTTPBearer: []
patch:
tags:
- runtime
summary: Patch Runtime Settings
description: Persist allowed runtime setting changes and hot-apply them in-process.
operationId: patch_runtime_settings_api_v1_runtime_settings_patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RuntimeSettingsUpdateRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RuntimeSettingsUpdateResponse'
'401':
description: Authentication is required or the provided token is invalid.
'503':
description: Runtime services are unavailable because server startup is
incomplete.
'400':
description: The supplied runtime setting values failed validation.
'403':
description: Runtime settings can only be updated when APP_ENV=local.
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/runtime/tests/lm:
post:
tags:
- runtime
summary: Test Lm Connection
description: Verify that the planner and delegate language-model configuration
can load.
operationId: test_lm_connection_api_v1_runtime_tests_lm_post
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RuntimeConnectivityTestResponse'
'401':
description: Authentication is required or the provided token is invalid.
'503':
description: Runtime services are unavailable because server startup is
incomplete.
security:
- HTTPBearer: []
/api/v1/runtime/tests/daytona:
post:
tags:
- runtime
summary: Test Daytona Connection
description: Run the Daytona preflight and connectivity check exposed in runtime
diagnostics.
operationId: test_daytona_connection_api_v1_runtime_tests_daytona_post
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RuntimeConnectivityTestResponse'
'401':
description: Authentication is required or the provided token is invalid.
'503':
description: Runtime services are unavailable because server startup is
incomplete.
security:
- HTTPBearer: []
/api/v1/runtime/status:
get:
tags:
- runtime
summary: Get Runtime Status
description: Return the combined runtime readiness, model, and provider diagnostics
snapshot.
operationId: get_runtime_status_api_v1_runtime_status_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RuntimeStatusResponse'
'401':
description: Authentication is required or the provided token is invalid.
'503':
description: Runtime services are unavailable because server startup is
incomplete.
security:
- HTTPBearer: []
/api/v1/runtime/volume/tree:
get:
tags:
- runtime
summary: Get Volume Tree
description: List the runtime volume tree for the active workspace and provider.
operationId: get_volume_tree_api_v1_runtime_volume_tree_get
security:
- HTTPBearer: []
parameters:
- name: root_path
in: query
required: false
schema:
type: string
description: Directory path to list within the selected runtime volume.
default: /
title: Root Path
description: Directory path to list within the selected runtime volume.
- name: max_depth
in: query
required: false
schema:
type: integer
maximum: 10
minimum: 1
description: Maximum directory depth to traverse while building the file
tree.
default: 3
title: Max Depth
description: Maximum directory depth to traverse while building the file tree.
- name: provider
in: query
required: false
schema:
anyOf:
- const: daytona
type: string
- type: 'null'
description: Optional runtime volume backend override. Defaults to the active
sandbox provider.
title: Provider
description: Optional runtime volume backend override. Defaults to the active
sandbox provider.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeTreeResponse'
'401':
description: Authentication is required or the provided token is invalid.
'503':
description: Runtime services are unavailable because server startup is
incomplete.
'400':
description: The requested root path is invalid.
'502':
description: The runtime volume provider failed to list the requested path.
'504':
description: Volume listing timed out before the backend returned a result.
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/runtime/volume/file:
get:
tags:
- runtime
summary: Get Volume File Content
description: Read a text preview for a single file from the runtime volume.
operationId: get_volume_file_content_api_v1_runtime_volume_file_get
security:
- HTTPBearer: []
parameters:
- name: path
in: query
required: true
schema:
type: string
minLength: 1
description: Absolute or volume-relative file path to preview from the runtime
volume.
title: Path
description: Absolute or volume-relative file path to preview from the runtime
volume.
- name: max_bytes
in: query
required: false
schema:
type: integer
maximum: 1000000
minimum: 1
description: Maximum number of bytes of text content to return in the preview
response.
default: 200000
title: Max Bytes
description: Maximum number of bytes of text content to return in the preview
response.
- name: provider
in: query
required: false
schema:
anyOf:
- const: daytona
type: string
- type: 'null'
description: Optional runtime volume backend override. Defaults to the active
sandbox provider.
title: Provider
description: Optional runtime volume backend override. Defaults to the active
sandbox provider.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeFileContentResponse'
'401':
description: Authentication is required or the provided token is invalid.
'503':
description: Runtime services are unavailable because server startup is
incomplete.
'400':
description: The requested file path is invalid or points to a directory.
'404':
description: The requested runtime volume file does not exist.
'502':
description: The runtime volume provider failed to read the requested file.
'504':
description: Volume file reading timed out before the backend returned a
result.
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/optimization/status:
get:
tags:
- optimization
summary: Get Optimization Status
description: Return GEPA optimization availability and prerequisites.
operationId: get_optimization_status_api_v1_optimization_status_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GEPAStatusResponse'
'401':
description: Authentication is required or the provided token is invalid.
security:
- HTTPBearer: []
/api/v1/optimization/modules:
get:
tags:
- optimization
summary: List Optimization Modules
description: Return the list of registered optimizable DSPy modules.
operationId: list_optimization_modules_api_v1_optimization_modules_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/GEPAModuleInfo'
type: array
title: Response List Optimization Modules Api V1 Optimization Modules
Get
'401':
description: Authentication is required or the provided token is invalid.
security:
- HTTPBearer: []
/api/v1/optimization/run:
post:
tags:
- optimization
summary: Run Optimization
description: Trigger a GEPA prompt optimization run.
operationId: run_optimization_api_v1_optimization_run_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GEPAOptimizationRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GEPAOptimizationResponse'
'401':
description: Authentication is required or the provided token is invalid.
'400':
description: Invalid optimization parameters.
'503':
description: GEPA optimization is unavailable in this environment.
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/optimization/runs:
post:
tags:
- optimization
summary: Create Optimization Run
description: 'Create a non-blocking GEPA optimization run.
Returns immediately with the run_id. The optimization executes as a
background task. Poll ``GET /runs/{run_id}`` for progress and results.'
operationId: create_optimization_run_api_v1_optimization_runs_post
security:
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GEPAOptimizationRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/OptimizationRunCreatedResponse'
'401':
description: Authentication is required or the provided token is invalid.
'400':
description: Invalid optimization parameters.
'503':
description: GEPA optimization is unavailable in this environment.
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- optimization
summary: List Runs
description: List optimization runs, most recent first.
operationId: list_runs_api_v1_optimization_runs_get
security:
- HTTPBearer: []
parameters:
- name: status
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 'Filter by status: running, completed, failed'
title: Status
description: 'Filter by status: running, completed, failed'
- name: limit
in: query
required: false
schema:
type: integer
maximum: 200
minimum: 1
description: Maximum number of runs to return.
default: 50
title: Limit
description: Maximum number of runs to return.
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset into the run list.
default: 0
title: Offset
description: Pagination offset into the run list.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OptimizationRunResponse'
title: Response List Runs Api V1 Optimization Runs Get
'401':
description: Authentication is required or the provided token is invalid.
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/optimization/transcript-datasets:
post:
tags:
- optimization
summary: Create Dataset From Transcript
description: Convert transcript turns into a GEPA dataset.
operationId: create_dataset_from_transcript_api_v1_optimization_transcript_datasets_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TranscriptDatasetRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetResponse'
'401':
description: Authentication is required or the provided token is invalid.
'400':
description: Invalid transcript dataset payload.
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/optimization/runs/compare:
get:
tags:
- optimization
summary: Compare Runs
description: Compare prompt diffs and scores across optimization runs.
operationId: compare_runs_api_v1_optimization_runs_compare_get
security:
- HTTPBearer: []
parameters:
- name: run_ids
in: query
required: true
schema:
type: string
description: Comma-separated run IDs to compare (max 5).
title: Run Ids
description: Comma-separated run IDs to compare (max 5).
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunComparisonResponse'
'401':
description: Authentication is required or the provided token is invalid.
'400':
description: Invalid run_ids parameter.
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/optimization/runs/{run_id}:
get:
tags:
- optimization
summary: Get Run
description: Get a single optimization run by ID.
operationId: get_run_api_v1_optimization_runs__run_id__get
security:
- HTTPBearer: []
parameters:
- name: run_id
in: path
required: true
schema:
type: string
description: Identifier of the optimization run to fetch.
title: Run Id
description: Identifier of the optimization run to fetch.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/OptimizationRunResponse'
'401':
description: Authentication is required or the provided token is invalid.
'404':
description: Run not found.
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/optimization/datasets:
post:
tags:
- optimization
summary: Upload Dataset
description: Upload and register a dataset file (.json or .jsonl).
operationId: upload_dataset_api_v1_optimization_datasets_post
security:
- HTTPBearer: []
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_upload_dataset_api_v1_optimization_datasets_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetResponse'
'401':
description: Authentication is required or the provided token is invalid.
'400':
description: Invalid dataset file.
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- optimization
summary: List Datasets Endpoint
description: List registered datasets with optional module filter.
operationId: list_datasets_endpoint_api_v1_optimization_datasets_get
security:
- HTTPBearer: []
parameters:
- name: module_slug
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter by module slug
title: Module Slug
description: Filter by module slug
- name: limit
in: query
required: false
schema:
type: integer
maximum: 200
minimum: 1
description: Maximum number of datasets to return.
default: 50
title: Limit
description: Maximum number of datasets to return.
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset into the dataset list.
default: 0
title: Offset
description: Pagination offset into the dataset list.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetListResponse'
'401':
description: Authentication is required or the provided token is invalid.
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/optimization/datasets/{dataset_id}:
get:
tags:
- optimization
summary: Get Dataset Detail
description: Return dataset metadata with the first 10 rows as preview.
operationId: get_dataset_detail_api_v1_optimization_datasets__dataset_id__get
security:
- HTTPBearer: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
description: Identifier of the dataset to inspect.
title: Dataset Id
description: Identifier of the dataset to inspect.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetDetailResponse'
'401':
description: Authentication is required or the provided token is invalid.
'404':
description: Dataset not found.
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/optimization/runs/{run_id}/results:
get:
tags:
- optimization
summary: Get Run Results
description: Return per-example evaluation results for an optimization run.
operationId: get_run_results_api_v1_optimization_runs__run_id__results_get
security:
- HTTPBearer: []
parameters:
- name: run_id
in: path
required: true
schema:
type: string
description: Identifier of the optimization run whose results to list.
title: Run Id
description: Identifier of the optimization run whose results to list.
- name: limit
in: query
required: false
schema:
type: integer
maximum: 500
minimum: 1
description: Maximum number of evaluation rows to return.
default: 100
title: Limit
description: Maximum number of evaluation rows to return.
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset into the evaluation results.
default: 0
title: Offset
description: Pagination offset into the evaluation results.
responses: