Upload openapi-lkvapi-v1.yaml

#1
Files changed (1) hide show
  1. docs/openapi-lkvapi-v1.yaml +650 -0
docs/openapi-lkvapi-v1.yaml ADDED
@@ -0,0 +1,650 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ openapi: 3.0.0
2
+ info:
3
+ title: openapi-lkvapi-v1
4
+ version: 1.0.0
5
+ paths:
6
+ /trunks/dispatch:
7
+ post:
8
+ summary: Create INBOUND dispatch
9
+ operationId: >-
10
+ users_zerog_downloads_bruno-collections_lk-vapi-migration_local_create_inbound_dispatch_bru
11
+ description: ''
12
+ tags:
13
+ - LOCAL
14
+ responses:
15
+ '200':
16
+ description: ''
17
+ parameters:
18
+ - name: Content-Type
19
+ in: header
20
+ description: ''
21
+ required: true
22
+ schema:
23
+ type: string
24
+ example: application/json
25
+ requestBody:
26
+ $ref: '#/components/requestBodies/create_inbound_dispatch'
27
+ servers:
28
+ - url: http://localhost:3000
29
+ /trunks:
30
+ post:
31
+ summary: Create OUTBOUND trunk
32
+ operationId: >-
33
+ users_zerog_downloads_bruno-collections_lk-vapi-migration_remote_create_outbound_trunk_bru
34
+ description: ''
35
+ tags:
36
+ - REMOTE
37
+ responses:
38
+ '200':
39
+ description: ''
40
+ parameters:
41
+ - name: Content-Type
42
+ in: header
43
+ description: ''
44
+ required: true
45
+ schema:
46
+ type: string
47
+ example: application/json
48
+ requestBody:
49
+ $ref: '#/components/requestBodies/create_outbound_trunk'
50
+ servers:
51
+ - url: http://localhost:3000
52
+ get:
53
+ summary: List ALL trunks (LK)
54
+ operationId: >-
55
+ users_zerog_downloads_bruno-collections_lk-vapi-migration_remote_list_all_trunks_lk_bru
56
+ description: ''
57
+ tags:
58
+ - REMOTE
59
+ responses:
60
+ '200':
61
+ description: ''
62
+ parameters:
63
+ - name: Content-Type
64
+ in: header
65
+ description: ''
66
+ required: true
67
+ schema:
68
+ type: string
69
+ example: application/json
70
+ servers:
71
+ - url: https://ins0mn1a-lk-api-v2.hf.space
72
+ /agents/dd687835-fc4c-4425-9a49-efeebe0ba361:
73
+ delete:
74
+ summary: Delete agent
75
+ operationId: >-
76
+ users_zerog_downloads_bruno-collections_lk-vapi-migration_local_delete_agent_bru
77
+ description: ''
78
+ tags:
79
+ - LOCAL
80
+ responses:
81
+ '200':
82
+ description: ''
83
+ servers:
84
+ - url: http://localhost:3000
85
+ put:
86
+ summary: Update agent
87
+ operationId: >-
88
+ users_zerog_downloads_bruno-collections_lk-vapi-migration_local_update_agent_bru
89
+ description: ''
90
+ tags:
91
+ - LOCAL
92
+ responses:
93
+ '200':
94
+ description: ''
95
+ requestBody:
96
+ $ref: '#/components/requestBodies/update_agent'
97
+ servers:
98
+ - url: http://localhost:3000
99
+ /agents:
100
+ get:
101
+ summary: List agents
102
+ operationId: >-
103
+ users_zerog_downloads_bruno-collections_lk-vapi-migration_remote_list_agents_bru
104
+ description: ''
105
+ tags:
106
+ - REMOTE
107
+ responses:
108
+ '200':
109
+ description: ''
110
+ servers:
111
+ - url: https://ins0mn1a-lk-api-v2.hf.space
112
+ post:
113
+ summary: ❌ Refcheck1 - Create agent
114
+ operationId: >-
115
+ users_zerog_downloads_bruno-collections_lk-vapi-migration_remote_refcheck1_-_create_agent_bru
116
+ description: ''
117
+ tags:
118
+ - REMOTE
119
+ responses:
120
+ '200':
121
+ description: ''
122
+ parameters:
123
+ - name: Content-Type
124
+ in: header
125
+ description: ''
126
+ required: true
127
+ schema:
128
+ type: string
129
+ example: application/json
130
+ requestBody:
131
+ $ref: '#/components/requestBodies/refcheck1_-_create_agent'
132
+ servers:
133
+ - url: https://ins0mn1a-lk-api-v1.hf.space
134
+ /agents/call:
135
+ post:
136
+ summary: Make an OUTBOUND call
137
+ operationId: >-
138
+ users_zerog_downloads_bruno-collections_lk-vapi-migration_local_make_an_outbound_call_bru
139
+ description: ''
140
+ tags:
141
+ - LOCAL
142
+ responses:
143
+ '200':
144
+ description: ''
145
+ parameters:
146
+ - name: Content-Type
147
+ in: header
148
+ description: ''
149
+ required: true
150
+ schema:
151
+ type: string
152
+ example: application/json
153
+ requestBody:
154
+ $ref: '#/components/requestBodies/make_an_outbound_call'
155
+ servers:
156
+ - url: http://localhost:3000
157
+ /agents/7decaee0-ff5e-4b65-a885-0ee7b2973c99:
158
+ delete:
159
+ summary: Delete agent
160
+ operationId: >-
161
+ users_zerog_downloads_bruno-collections_lk-vapi-migration_remote_delete_agent_bru
162
+ description: ''
163
+ tags:
164
+ - REMOTE
165
+ responses:
166
+ '200':
167
+ description: ''
168
+ servers:
169
+ - url: https://ins0mn1a-lk-api-v1.hf.space
170
+ /call:
171
+ post:
172
+ summary: Make an outbound call
173
+ operationId: >-
174
+ users_zerog_downloads_bruno-collections_lk-vapi-migration_remote_make_an_outbound_call_bru
175
+ description: ''
176
+ tags:
177
+ - REMOTE
178
+ responses:
179
+ '200':
180
+ description: ''
181
+ parameters:
182
+ - name: Content-Type
183
+ in: header
184
+ description: ''
185
+ required: true
186
+ schema:
187
+ type: string
188
+ example: application/json
189
+ requestBody:
190
+ $ref: '#/components/requestBodies/make_an_outbound_call'
191
+ servers:
192
+ - url: https://ins0mn1a-lk-api-v2.hf.space
193
+ /agents/e6ab4be9-cdfc-4cb4-b7e7-834f2ae270b2:
194
+ put:
195
+ summary: Update agent
196
+ operationId: >-
197
+ users_zerog_downloads_bruno-collections_lk-vapi-migration_remote_update_agent_bru
198
+ description: ''
199
+ tags:
200
+ - REMOTE
201
+ responses:
202
+ '200':
203
+ description: ''
204
+ requestBody:
205
+ $ref: '#/components/requestBodies/update_agent'
206
+ servers:
207
+ - url: https://ins0mn1a-lk-api-v1.hf.space
208
+ /openai/deployments/%7B%7BAZURE_DEPLOYMENT%7D%7D/chat/completions:
209
+ post:
210
+ summary: AZ Generate JSON (chatcompl)
211
+ operationId: >-
212
+ users_zerog_downloads_bruno-collections_lk-vapi-migration_structured_outputs_az_generate_json_chatcompl_bru
213
+ description: ''
214
+ tags:
215
+ - STRUCTURED OUTPUTS
216
+ responses:
217
+ '200':
218
+ description: ''
219
+ parameters:
220
+ - name: api-version
221
+ in: query
222
+ description: ''
223
+ required: true
224
+ schema:
225
+ type: string
226
+ example: 2024-12-01-preview
227
+ - name: api-key
228
+ in: header
229
+ description: ''
230
+ required: true
231
+ schema:
232
+ type: string
233
+ example: '{{AZURE_API_KEY}}'
234
+ - name: content-type
235
+ in: header
236
+ description: ''
237
+ required: true
238
+ schema:
239
+ type: string
240
+ example: application/json
241
+ requestBody:
242
+ $ref: '#/components/requestBodies/az_generate_json_chatcompl'
243
+ servers:
244
+ - url: https://{resource_name}.openai.azure.com
245
+ variables:
246
+ resource_name:
247
+ default: ''
248
+ /v1/chat/completions:
249
+ post:
250
+ summary: HF Generate JSON (chatcompl)
251
+ operationId: >-
252
+ users_zerog_downloads_bruno-collections_lk-vapi-migration_structured_outputs_hf_generate_json_chatcompl_bru
253
+ description: ''
254
+ tags:
255
+ - STRUCTURED OUTPUTS
256
+ responses:
257
+ '200':
258
+ description: ''
259
+ parameters:
260
+ - name: content-type
261
+ in: header
262
+ description: ''
263
+ required: true
264
+ schema:
265
+ type: string
266
+ example: application/json
267
+ - name: Authorization
268
+ in: header
269
+ description: ''
270
+ required: true
271
+ schema:
272
+ type: string
273
+ example: Bearer hf-api-key
274
+ requestBody:
275
+ $ref: '#/components/requestBodies/hf_generate_json_chatcompl'
276
+ servers:
277
+ - url: https://router.huggingface.co
278
+ /:
279
+ post:
280
+ summary: CF Generate JSON (chatcompl)
281
+ operationId: >-
282
+ users_zerog_downloads_bruno-collections_lk-vapi-migration_structured_outputs_cf_generate_json_chatcompl_bru
283
+ description: ''
284
+ tags:
285
+ - STRUCTURED OUTPUTS
286
+ responses:
287
+ '200':
288
+ description: ''
289
+ requestBody:
290
+ $ref: '#/components/requestBodies/cf_generate_json_chatcompl'
291
+ servers:
292
+ - url: https://wandering-morning-bdee.mohbim.workers.dev
293
+ servers: []
294
+ components:
295
+ schemas:
296
+ create_inbound_dispatch:
297
+ type: object
298
+ properties:
299
+ agentId:
300
+ type: string
301
+ sipTrunkId:
302
+ type: string
303
+ example:
304
+ agentId: a47d2ba4-4931-4dcf-99f9-ca7d4db3243c
305
+ sipTrunkId: 9c5a0ba8-903d-4597-9f68-74fe64d1de7e
306
+ create_inbound_trunk:
307
+ type: object
308
+ properties:
309
+ name:
310
+ type: string
311
+ numbers:
312
+ type: array
313
+ items:
314
+ type: string
315
+ authUsername:
316
+ type: string
317
+ authPassword:
318
+ type: string
319
+ example:
320
+ name: sip-inbound-trunk-1
321
+ numbers:
322
+ - '+919108241092'
323
+ authUsername: TEST
324
+ authPassword: '{{AUTH_PASS}}'
325
+ create_outbound_trunk:
326
+ type: object
327
+ properties:
328
+ name:
329
+ type: string
330
+ address:
331
+ type: string
332
+ numbers:
333
+ type: array
334
+ items:
335
+ type: string
336
+ authUsername:
337
+ type: string
338
+ authPassword:
339
+ type: string
340
+ example:
341
+ name: sip-outbound-trunk-1
342
+ address: livekit-outbound-123.pstn.twilio.com
343
+ numbers:
344
+ - '+17753176886'
345
+ authUsername: TEST
346
+ authPassword: '{{AUTH_PASS}}'
347
+ make_an_outbound_call:
348
+ type: object
349
+ properties:
350
+ callTo:
351
+ type: string
352
+ agentId:
353
+ type: string
354
+ variables:
355
+ type: object
356
+ properties:
357
+ applicant_name:
358
+ type: string
359
+ company:
360
+ type: string
361
+ position:
362
+ type: string
363
+ reference_name:
364
+ type: string
365
+ example:
366
+ callTo: '+917760788864'
367
+ agentId: 5afeb70a-0a3c-479f-983d-93b010a5bb31
368
+ variables:
369
+ applicant_name: Melissa Sanders
370
+ company: Acme Inc.
371
+ position: Director Operations
372
+ reference_name: Reese Snow
373
+ tampaha_-_create_agent:
374
+ type: object
375
+ properties:
376
+ name:
377
+ type: string
378
+ systemPrompt:
379
+ type: string
380
+ stt:
381
+ type: object
382
+ properties:
383
+ provider:
384
+ type: string
385
+ model:
386
+ type: string
387
+ language:
388
+ type: string
389
+ llm:
390
+ type: object
391
+ properties:
392
+ provider:
393
+ type: string
394
+ endpoint:
395
+ type: string
396
+ model:
397
+ type: string
398
+ apiKey:
399
+ type: string
400
+ apiVersion:
401
+ type: string
402
+ tts:
403
+ type: object
404
+ properties:
405
+ provider:
406
+ type: string
407
+ model:
408
+ type: string
409
+ variablesSchema:
410
+ type: object
411
+ properties:
412
+ applicant_name:
413
+ type: string
414
+ company:
415
+ type: string
416
+ position:
417
+ type: string
418
+ reference_name:
419
+ type: string
420
+ example:
421
+ name: lk-agent-workerpool-2
422
+ systemPrompt: '{{SYSTEM_PROMPT}}'
423
+ stt:
424
+ provider: deepgram
425
+ model: nova-3
426
+ language: en-US
427
+ llm:
428
+ provider: azure
429
+ endpoint: https://o247-ai-sandbox.openai.azure.com/
430
+ model: gpt-5-mini
431
+ apiKey: >-
432
+ azureopenai-api-key
433
+ apiVersion: 2024-12-01-preview
434
+ tts:
435
+ provider: deepgram
436
+ model: aura-2-andromeda-en
437
+ variablesSchema:
438
+ applicant_name: ''
439
+ company: ''
440
+ position: ''
441
+ reference_name: ''
442
+ update_agent:
443
+ type: object
444
+ properties:
445
+ name:
446
+ type: string
447
+ example:
448
+ name: updated-agent
449
+ refcheck1_-_create_agent:
450
+ type: object
451
+ properties:
452
+ name:
453
+ type: string
454
+ systemPrompt:
455
+ type: string
456
+ stt:
457
+ type: object
458
+ properties:
459
+ provider:
460
+ type: string
461
+ model:
462
+ type: string
463
+ language:
464
+ type: string
465
+ llm:
466
+ type: object
467
+ properties:
468
+ provider:
469
+ type: string
470
+ endpoint:
471
+ type: string
472
+ model:
473
+ type: string
474
+ apiKey:
475
+ type: string
476
+ apiVersion:
477
+ type: string
478
+ tts:
479
+ type: object
480
+ properties:
481
+ provider:
482
+ type: string
483
+ model:
484
+ type: string
485
+ variablesSchema:
486
+ type: object
487
+ properties:
488
+ candidate_name:
489
+ type: string
490
+ referee_name:
491
+ type: string
492
+ example:
493
+ name: lk-agent-workerpool-1
494
+ systemPrompt: '{{SYSTEM_PROMPT}}'
495
+ stt:
496
+ provider: deepgram
497
+ model: nova-3
498
+ language: en-US
499
+ llm:
500
+ provider: azure
501
+ endpoint: https://o247-ai-sandbox.openai.azure.com/
502
+ model: gpt-5-mini
503
+ apiKey: >-
504
+ azureopenai-api-key
505
+ apiVersion: 2024-12-01-preview
506
+ tts:
507
+ provider: deepgram
508
+ model: aura-2-andromeda-en
509
+ variablesSchema:
510
+ candidate_name: ''
511
+ referee_name: ''
512
+ az_generate_json_chatcompl:
513
+ type: object
514
+ properties: {}
515
+ basic_hf_-_gpt-oss-120b:
516
+ type: object
517
+ properties:
518
+ model:
519
+ type: string
520
+ messages:
521
+ type: array
522
+ items:
523
+ type: object
524
+ properties:
525
+ role:
526
+ type: string
527
+ content:
528
+ type: string
529
+ stream:
530
+ type: boolean
531
+ example:
532
+ model: openai/gpt-oss-120b:groq
533
+ messages:
534
+ - role: user
535
+ content: Say hello world
536
+ stream: false
537
+ basiccerebras-_gpt-oss-120b:
538
+ type: object
539
+ properties:
540
+ model:
541
+ type: string
542
+ messages:
543
+ type: array
544
+ items:
545
+ type: object
546
+ properties:
547
+ role:
548
+ type: string
549
+ content:
550
+ type: string
551
+ stream:
552
+ type: boolean
553
+ example:
554
+ model: gpt-oss-120b
555
+ messages:
556
+ - role: user
557
+ content: Say hello world
558
+ stream: false
559
+ cf_generate_json_chatcompl:
560
+ type: object
561
+ properties: {}
562
+ hf_generate_json_chatcompl:
563
+ type: object
564
+ properties: {}
565
+ requestBodies:
566
+ create_inbound_dispatch:
567
+ content:
568
+ application/json:
569
+ schema:
570
+ $ref: '#/components/schemas/create_inbound_dispatch'
571
+ description: ''
572
+ required: true
573
+ create_inbound_trunk:
574
+ content:
575
+ application/json:
576
+ schema:
577
+ $ref: '#/components/schemas/create_inbound_trunk'
578
+ description: ''
579
+ required: true
580
+ create_outbound_trunk:
581
+ content:
582
+ application/json:
583
+ schema:
584
+ $ref: '#/components/schemas/create_outbound_trunk'
585
+ description: ''
586
+ required: true
587
+ make_an_outbound_call:
588
+ content:
589
+ application/json:
590
+ schema:
591
+ $ref: '#/components/schemas/make_an_outbound_call'
592
+ description: ''
593
+ required: true
594
+ tampaha_-_create_agent:
595
+ content:
596
+ application/json:
597
+ schema:
598
+ $ref: '#/components/schemas/tampaha_-_create_agent'
599
+ description: ''
600
+ required: true
601
+ update_agent:
602
+ content:
603
+ application/json:
604
+ schema:
605
+ $ref: '#/components/schemas/update_agent'
606
+ description: ''
607
+ required: true
608
+ refcheck1_-_create_agent:
609
+ content:
610
+ application/json:
611
+ schema:
612
+ $ref: '#/components/schemas/refcheck1_-_create_agent'
613
+ description: ''
614
+ required: true
615
+ az_generate_json_chatcompl:
616
+ content:
617
+ application/json:
618
+ schema:
619
+ $ref: '#/components/schemas/az_generate_json_chatcompl'
620
+ description: ''
621
+ required: true
622
+ basic_hf_-_gpt-oss-120b:
623
+ content:
624
+ application/json:
625
+ schema:
626
+ $ref: '#/components/schemas/basic_hf_-_gpt-oss-120b'
627
+ description: ''
628
+ required: true
629
+ basiccerebras-_gpt-oss-120b:
630
+ content:
631
+ application/json:
632
+ schema:
633
+ $ref: '#/components/schemas/basiccerebras-_gpt-oss-120b'
634
+ description: ''
635
+ required: true
636
+ cf_generate_json_chatcompl:
637
+ content:
638
+ application/json:
639
+ schema:
640
+ $ref: '#/components/schemas/cf_generate_json_chatcompl'
641
+ description: ''
642
+ required: true
643
+ hf_generate_json_chatcompl:
644
+ content:
645
+ application/json:
646
+ schema:
647
+ $ref: '#/components/schemas/hf_generate_json_chatcompl'
648
+ description: ''
649
+ required: true
650
+ securitySchemes: {}