forked from Cognipeer/console
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
2146 lines (2070 loc) · 57.3 KB
/
openapi.yaml
File metadata and controls
2146 lines (2070 loc) · 57.3 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.0.3
info:
title: Cognipeer Console Client API
version: 1.0.0
description: |
Multi-tenant SaaS platform for AI and Agentic services providing LLM services,
agent orchestration, vector stores, workflow automation, and analytics.
## Authentication
All endpoints require Bearer token authentication using API tokens.
Include the token in the Authorization header: `Authorization: Bearer <token>`
## Base URL
Managed service: `https://api.cognipeer.com/api/client/v1`
Self-hosted: `http://localhost:3000/api/client/v1`
## License
This API surface is documented from the AGPL community edition of Cognipeer Console.
Commercial licensing and managed service terms may differ from self-hosted community use.
contact:
name: Cognipeer Support
url: https://github.com/Cognipeer/cognipeer-console
license:
name: AGPL-3.0-only
url: https://www.gnu.org/licenses/agpl-3.0.html
servers:
- url: http://localhost:3000/api/client/v1
description: Development server
security:
- BearerAuth: []
tags:
- name: Chat
description: OpenAI-compatible chat completions with streaming support
- name: Embeddings
description: OpenAI-compatible text embeddings
- name: Vector Providers
description: Manage vector database providers
- name: Vector Indexes
description: Manage vector indexes and operations
- name: Files
description: File storage and management
- name: Tracing
description: Agent tracing and observability
- name: Prompts
description: Prompt template management and rendering
- name: Guardrails
description: Content safety and policy evaluation
- name: Memory
description: Persistent memory stores for agents
- name: RAG
description: Retrieval-Augmented Generation modules
- name: Health
description: Liveness and readiness probes
paths:
/chat/completions:
post:
tags:
- Chat
summary: Create chat completion
description: |
OpenAI-compatible chat completion endpoint with optional streaming support.
Supports function/tool calling and all standard OpenAI parameters.
operationId: createChatCompletion
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChatCompletionRequest'
examples:
basic:
summary: Basic chat completion
value:
model: "gpt-4"
messages:
- role: "system"
content: "You are a helpful assistant."
- role: "user"
content: "Hello!"
streaming:
summary: Streaming completion
value:
model: "gpt-4"
messages:
- role: "user"
content: "Tell me a story"
stream: true
responses:
'200':
description: Successful completion
content:
application/json:
schema:
$ref: '#/components/schemas/ChatCompletionResponse'
text/event-stream:
schema:
type: string
description: Server-sent events for streaming responses
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalError'
/embeddings:
post:
tags:
- Embeddings
summary: Create embeddings
description: |
OpenAI-compatible embeddings endpoint.
Converts text into vector representations.
operationId: createEmbeddings
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EmbeddingRequest'
example:
model: "text-embedding-3-small"
input: "The quick brown fox jumps over the lazy dog"
responses:
'200':
description: Successful embedding
content:
application/json:
schema:
$ref: '#/components/schemas/EmbeddingResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalError'
/vector/providers:
get:
tags:
- Vector Providers
summary: List vector providers
description: |
List all vector database providers configured for the tenant.
Supports filtering by status and driver type.
operationId: listVectorProviders
parameters:
- name: status
in: query
schema:
type: string
enum: [active, inactive, error]
description: Filter by provider status
- name: driver
in: query
schema:
type: string
description: Filter by driver name (e.g., pinecone, chroma)
responses:
'200':
description: List of providers
content:
application/json:
schema:
type: object
properties:
providers:
type: array
items:
$ref: '#/components/schemas/VectorProvider'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalError'
post:
tags:
- Vector Providers
summary: Create vector provider
description: Create a new vector database provider configuration
operationId: createVectorProvider
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVectorProviderRequest'
example:
key: "my-pinecone-1"
driver: "pinecone"
label: "Production Pinecone"
description: "Main production vector store"
status: "active"
credentials:
apiKey: "pc-xxxx"
environment: "us-east-1"
settings: {}
metadata:
region: "us-east"
responses:
'201':
description: Provider created
content:
application/json:
schema:
type: object
properties:
provider:
$ref: '#/components/schemas/VectorProvider'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalError'
/vector/providers/{providerKey}/indexes:
get:
tags:
- Vector Indexes
summary: List vector indexes
description: List all indexes for a specific vector provider
operationId: listVectorIndexes
parameters:
- $ref: '#/components/parameters/ProviderKey'
responses:
'200':
description: List of indexes
content:
application/json:
schema:
type: object
properties:
indexes:
type: array
items:
$ref: '#/components/schemas/VectorIndex'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalError'
post:
tags:
- Vector Indexes
summary: Create vector index
description: |
Create a new vector index. If an index with the same name exists,
it will be returned instead (idempotent).
operationId: createVectorIndex
parameters:
- $ref: '#/components/parameters/ProviderKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVectorIndexRequest'
example:
name: "products"
dimension: 1536
metric: "cosine"
metadata:
description: "Product embeddings"
responses:
'200':
description: Existing index returned (reused)
content:
application/json:
schema:
type: object
properties:
index:
$ref: '#/components/schemas/VectorIndex'
reused:
type: boolean
example: true
'201':
description: New index created
content:
application/json:
schema:
type: object
properties:
index:
$ref: '#/components/schemas/VectorIndex'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalError'
/vector/providers/{providerKey}/indexes/{externalId}:
get:
tags:
- Vector Indexes
summary: Get vector index
description: Retrieve details of a specific vector index
operationId: getVectorIndex
parameters:
- $ref: '#/components/parameters/ProviderKey'
- $ref: '#/components/parameters/ExternalId'
responses:
'200':
description: Index details
content:
application/json:
schema:
type: object
properties:
index:
$ref: '#/components/schemas/VectorIndex'
provider:
$ref: '#/components/schemas/VectorProvider'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalError'
patch:
tags:
- Vector Indexes
summary: Update vector index
description: Update index name and/or metadata
operationId: updateVectorIndex
parameters:
- $ref: '#/components/parameters/ProviderKey'
- $ref: '#/components/parameters/ExternalId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateVectorIndexRequest'
example:
name: "products-v2"
metadata:
version: "2.0"
responses:
'200':
description: Index updated
content:
application/json:
schema:
type: object
properties:
index:
$ref: '#/components/schemas/VectorIndex'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalError'
delete:
tags:
- Vector Indexes
summary: Delete vector index
description: Delete a vector index and all its data
operationId: deleteVectorIndex
parameters:
- $ref: '#/components/parameters/ProviderKey'
- $ref: '#/components/parameters/ExternalId'
responses:
'200':
description: Index deleted
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalError'
/vector/providers/{providerKey}/indexes/{externalId}/upsert:
post:
tags:
- Vector Indexes
summary: Upsert vectors
description: Insert or update vectors in the index
operationId: upsertVectors
parameters:
- $ref: '#/components/parameters/ProviderKey'
- $ref: '#/components/parameters/ExternalId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertVectorsRequest'
example:
vectors:
- id: "vec1"
values: [0.1, 0.2, 0.3]
metadata:
text: "Hello world"
- id: "vec2"
values: [0.4, 0.5, 0.6]
metadata:
text: "Goodbye world"
responses:
'200':
description: Vectors upserted
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalError'
/vector/providers/{providerKey}/indexes/{externalId}/query:
post:
tags:
- Vector Indexes
summary: Query vectors
description: Search for similar vectors in the index
operationId: queryVectors
parameters:
- $ref: '#/components/parameters/ProviderKey'
- $ref: '#/components/parameters/ExternalId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryVectorsRequest'
example:
query:
vector: [0.1, 0.2, 0.3]
topK: 10
filter:
category: "electronics"
responses:
'200':
description: Query results
content:
application/json:
schema:
$ref: '#/components/schemas/QueryVectorsResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalError'
/vector/providers/{providerKey}/indexes/{externalId}/vectors:
delete:
tags:
- Vector Indexes
summary: Delete vectors
description: Delete specific vectors by ID from the index
operationId: deleteVectors
parameters:
- $ref: '#/components/parameters/ProviderKey'
- $ref: '#/components/parameters/ExternalId'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ids
properties:
ids:
type: array
items:
type: string
description: Array of vector IDs to delete
example:
ids: ["vec1", "vec2", "vec3"]
responses:
'200':
description: Vectors deleted
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalError'
/files/buckets:
get:
tags:
- Files
summary: List file buckets
description: List all file storage buckets for the tenant
operationId: listFileBuckets
responses:
'200':
description: List of buckets
content:
application/json:
schema:
type: object
properties:
buckets:
type: array
items:
$ref: '#/components/schemas/FileBucket'
count:
type: integer
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalError'
/files/buckets/{bucketKey}:
get:
tags:
- Files
summary: Get file bucket
description: Get details of a specific file bucket
operationId: getFileBucket
parameters:
- name: bucketKey
in: path
required: true
schema:
type: string
description: Unique bucket identifier
responses:
'200':
description: Bucket details
content:
application/json:
schema:
type: object
properties:
bucket:
$ref: '#/components/schemas/FileBucket'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalError'
/files/buckets/{bucketKey}/objects:
get:
tags:
- Files
summary: List files in bucket
description: List all files in a specific bucket with pagination
operationId: listFiles
parameters:
- name: bucketKey
in: path
required: true
schema:
type: string
- name: search
in: query
schema:
type: string
description: Search term to filter files
- name: limit
in: query
schema:
type: integer
default: 50
description: Maximum number of files to return
- name: cursor
in: query
schema:
type: string
description: Pagination cursor for next page
responses:
'200':
description: List of files
content:
application/json:
schema:
type: object
properties:
files:
type: array
items:
$ref: '#/components/schemas/FileObject'
count:
type: integer
nextCursor:
type: string
nullable: true
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalError'
post:
tags:
- Files
summary: Upload file
description: |
Upload a file to the bucket.
Supports base64 encoding and optional markdown conversion.
operationId: uploadFile
parameters:
- name: bucketKey
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UploadFileRequest'
example:
fileName: "document.pdf"
contentType: "application/pdf"
data: "data:application/pdf;base64,JVBERi0xLjQK..."
metadata:
category: "reports"
convertToMarkdown: true
responses:
'201':
description: File uploaded
content:
application/json:
schema:
type: object
properties:
file:
$ref: '#/components/schemas/FileObject'
message:
type: string
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalError'
/tracing/sessions:
post:
tags:
- Tracing
summary: Ingest tracing session
description: |
Ingest agent tracing session data from SDK or HTTP client.
Used for observability and monitoring of agent executions.
operationId: ingestTracingSession
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TracingSessionRequest'
example:
sessionId: "sess_123"
threadId: "thread_order-workflow-42"
agent:
name: "CustomerSupport"
version: "1.0.0"
model: "gpt-4"
status: "completed"
startedAt: "2025-10-09T10:00:00Z"
endedAt: "2025-10-09T10:02:30Z"
durationMs: 150000
summary:
totalInputTokens: 1000
totalOutputTokens: 500
totalCachedInputTokens: 100
events:
- id: "evt_1"
type: "llm_call"
timestamp: "2025-10-09T10:00:01Z"
model: "gpt-4"
inputTokens: 100
outputTokens: 50
responses:
'200':
description: Session ingested
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
sessionId:
type: string
eventsStored:
type: integer
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalError'
/traces:
post:
tags:
- Tracing
summary: Ingest OTLP traces
description: |
Ingest OpenTelemetry OTLP/HTTP JSON traces and map them into
Cognipeer tracing sessions/events.
operationId: ingestOtlpTraces
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OtlpTraceRequest'
responses:
'200':
description: OTLP traces ingested
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
sessionsIngested:
type: integer
spansProcessed:
type: integer
eventsStored:
type: integer
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'413':
description: Payload too large
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalError'
/tracing/threads:
get:
tags:
- Tracing
summary: List tracing threads
description: |
List tracing threads – logical groupings of sessions that share
the same threadId. Supports filtering, pagination, and sorting.
operationId: listTracingThreads
parameters:
- name: page
in: query
schema:
type: integer
default: 1
- name: limit
in: query
schema:
type: integer
default: 20
- name: search
in: query
schema:
type: string
description: Search by threadId or agent name
- name: status
in: query
schema:
type: string
enum: [success, error, running]
- name: sortBy
in: query
schema:
type: string
enum: [lastActivity, sessionCount]
default: lastActivity
- name: sortOrder
in: query
schema:
type: string
enum: [asc, desc]
default: desc
responses:
'200':
description: Thread list
content:
application/json:
schema:
type: object
properties:
threads:
type: array
items:
type: object
properties:
threadId:
type: string
sessionCount:
type: integer
agents:
type: array
items:
type: string
statuses:
type: array
items:
type: string
firstSeen:
type: string
format: date-time
lastActivity:
type: string
format: date-time
totalDurationMs:
type: number
totalInputTokens:
type: number
totalOutputTokens:
type: number
pagination:
type: object
properties:
page:
type: integer
limit:
type: integer
total:
type: integer
totalPages:
type: integer
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalError'
/tracing/threads/{threadId}:
get:
tags:
- Tracing
summary: Get thread detail
description: |
Retrieve full detail for a specific thread, including all sessions
that belong to it, sorted chronologically.
operationId: getTracingThreadDetail
parameters:
- name: threadId
in: path
required: true
schema:
type: string
responses:
'200':
description: Thread detail
content:
application/json:
schema:
type: object
properties:
threadId:
type: string
sessions:
type: array
items:
$ref: '#/components/schemas/TracingSessionRequest'
sessionCount:
type: integer
agents:
type: array
items:
type: string
firstSeen:
type: string
format: date-time
lastActivity:
type: string
format: date-time
totalDurationMs:
type: number
totalInputTokens:
type: number
totalOutputTokens:
type: number
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalError'
# ── Prompts ────────────────────────────────────────────────────────
/prompts:
get:
tags: [Prompts]
summary: List prompts
parameters:
- name: search
in: query
schema:
type: string
description: Filter prompts by name/key
responses:
'200':
description: List of prompts
content:
application/json:
schema:
type: object
properties:
prompts:
type: array
items:
type: object
'401':
$ref: '#/components/responses/Unauthorized'
/prompts/{key}:
get:
tags: [Prompts]
summary: Get a prompt by key
parameters:
- name: key
in: path
required: true
schema:
type: string
- name: environment
in: query
schema:
type: string
enum: [dev, staging, prod]
- name: version
in: query
schema:
type: integer
minimum: 1
responses:
'200':
description: Prompt with resolved version
content:
application/json:
schema:
type: object
properties:
prompt:
type: object
resolvedVersion:
type: object
nullable: true
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
/prompts/{key}/render:
post:
tags: [Prompts]
summary: Render a prompt template with variables