-
Notifications
You must be signed in to change notification settings - Fork 1
/
api.yaml
996 lines (980 loc) · 30.8 KB
/
api.yaml
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
openapi: 3.0.3
info:
title: Avatara B2B API
description: Avatara B2B API
version: 0.0.1
contact: {}
servers:
- url: https://api-sandbox.avatara.id/b2b
description: Sandbox
- url: https://staging-b2b-api.avatara.id
description: Staging avatara id
paths:
/auth:
post:
tags:
- Auth
summary: Upsert User & Get Token
description: Get or Create user and get token for authentication. JWT is returned in response body. The JWT can be used in HTTP header as bearer token
security:
- apiKeyAuth: []
requestBody:
content:
application/json:
schema:
type: object
required:
- username
- remote_id
properties:
username:
type: string
minLength: 3
maxLength: 25
description: alphanumeric and underscore
example: john_doe
remote_id:
type: string
description: client user identifier
example: "12"
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: JWT for authentication in header
example: xxzxzxzxzxzxzxz
example:
token: xxzxzxzxzxzxzxz
/users:
get:
tags:
- Auth
summary: Get profile
description: Get user profile
security:
- apiKeyAuth: []
bearerAuth: []
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
data:
uid: <string>
username: <string>
remote_id: <string>
created_at: <string>
updated_at: <string>
message: <string>
status: <string>
/stars:
get:
tags:
- Star
summary: Get all star
operationId: getAllStar
description: Get all star
security:
- apiKeyAuth: []
parameters:
- name: page
in: query
schema:
type: string
example: '1'
- name: limit
in: query
schema:
type: string
example: '10'
- name: category_id
in: query
schema:
type: string
example: '8'
- name: catalog
in: query
schema:
type: string
example: weekly-popular
description: featured,weekly-popular,new-release
responses:
'200':
description: Get all star
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
banner_pic:
type: string
example: >-
https://img.icons8.com/?size=512&id=tZuAOUGm9AuS&format=png
biography:
type: string
example: contoh
category:
type: object
properties:
id:
type: number
example: 1
name:
type: string
example: Anime
description:
type: string
example: contoh
name:
type: string
example: contoh
profile_pic:
type: string
example: >-
https://img.icons8.com/?size=512&id=tZuAOUGm9AuS&format=png
social_link:
type: array
items:
type: object
properties:
name:
type: string
example: instagram
url:
type: string
example: https://instagram.com
example:
- name: instagram
url: https://instagram.com
uid:
type: string
example: 2SPdtY6dvcB9UM6Caqj40ouk0pd
example:
- banner_pic: >-
https://img.icons8.com/?size=512&id=tZuAOUGm9AuS&format=png
biography: contoh
category:
name: Anime
description: contoh
name: contoh
profile_pic: >-
https://img.icons8.com/?size=512&id=tZuAOUGm9AuS&format=png
social_link:
- name: instagram
url: https://instagram.com
uid: 2SPdtY6dvcB9UM6Caqj40ouk0pd
message:
type: string
example: Success Get Star Data
status:
type: string
example: success
examples:
Get all star:
value:
data:
- banner_pic: >-
https://img.icons8.com/?size=512&id=tZuAOUGm9AuS&format=png
biography: contoh
category:
id: 1
name: Anime
description: contoh
name: contoh
profile_pic: >-
https://img.icons8.com/?size=512&id=tZuAOUGm9AuS&format=png
social_link:
- name: instagram
url: https://instagram.com
uid: 2SPdtY6dvcB9UM6Caqj40ouk0pd
message: Success Get Star Data
status: success
# security:
# - {}
/stars/search:
get:
tags:
- Star
summary: Search star
description: Search star
operationId: searchStar
security:
- apiKeyAuth: []
parameters:
- name: x-consumer-custom-id
in: header
schema:
type: string
example: tenantUID
- name: x-consumer-username
in: header
schema:
type: string
example: tenantSlug
- name: page
in: query
schema:
type: string
example: '1'
- name: limit
in: query
schema:
type: string
example: '10'
- name: category_id
in: query
schema:
type: string
example: '2'
- name: status
in: query
schema:
type: string
example: inactive
- name: q
in: query
schema:
type: string
example: bot
responses:
'200':
description: Get all star
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
banner_pic:
type: string
example: >-
https://avatara-assets-staging.s3.ap-southeast-3.amazonaws.com/stars/2UVvFD03r5LYZ0imAf497TMeV7R/banner
category:
type: object
properties:
id:
type: number
example: 1
name:
type: string
example: test
name:
type: string
example: Rezi Bot
profile_pic:
type: string
example: >-
https://avatara-assets-staging.s3.ap-southeast-3.amazonaws.com/stars/2UVvFD03r5LYZ0imAf497TMeV7R/avatar
status:
type: string
example: active
uid:
type: string
example: 2UVvFD03r5LYZ0imAf497TMeV7R
example:
- banner_pic: >-
https://avatara-assets-staging.s3.ap-southeast-3.amazonaws.com/stars/2UVvFD03r5LYZ0imAf497TMeV7R/banner
category:
id: 1
name: test
name: Rezi Bot
profile_pic: >-
https://avatara-assets-staging.s3.ap-southeast-3.amazonaws.com/stars/2UVvFD03r5LYZ0imAf497TMeV7R/avatar
status: active
uid: 2UVvFD03r5LYZ0imAf497TMeV7R
message:
type: string
example: Success Get Star
status:
type: string
example: success
examples:
Get all star:
value:
data:
- banner_pic: >-
https://avatara-assets-staging.s3.ap-southeast-3.amazonaws.com/stars/2UVvFD03r5LYZ0imAf497TMeV7R/banner
category:
id: 1
name: test
name: Rezi Bot
profile_pic: >-
https://avatara-assets-staging.s3.ap-southeast-3.amazonaws.com/stars/2UVvFD03r5LYZ0imAf497TMeV7R/avatar
status: active
uid: 2UVvFD03r5LYZ0imAf497TMeV7R
message: Success Get Star
status: success
/stars/{starUID}:
get:
tags:
- Star
summary: Get star by UID
description: Get star by UID
operationId: getStarByUid
security:
- apiKeyAuth: []
parameters:
- name: starUID
in: path
required: true
schema:
$ref: "#/components/schemas/KSUID"
responses:
'200':
description: Get star by UID
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
banner_pic:
type: string
example: >-
https://avatara-assets-staging.s3.ap-southeast-3.amazonaws.com/stars/2UVvFD03r5LYZ0imAf497TMeV7R/banner
biography:
type: string
example: aaa
bot:
type: object
properties:
greeting_msg:
type: string
example: a
reset_msg:
type: string
example: a
uid:
type: string
example: 2UVvFEv0Ry3apdkLPDDUIgIKsyU
category:
type: object
properties:
id:
type: number
example: 1
name:
type: string
example: test
status:
type: string
example: ''
chat_count:
type: number
example: 29
description:
type: string
example: aaa
name:
type: string
example: Rezi Bot
profile_pic:
type: string
example: >-
https://avatara-assets-staging.s3.ap-southeast-3.amazonaws.com/stars/2UVvFD03r5LYZ0imAf497TMeV7R/avatar
status:
type: string
example: active
uid:
type: string
example: 2UVvFD03r5LYZ0imAf497TMeV7R
message:
type: string
example: Success Get Star
status:
type: string
example: success
examples:
Get star by UID:
value:
data:
banner_pic: >-
https://avatara-assets-staging.s3.ap-southeast-3.amazonaws.com/stars/2UVvFD03r5LYZ0imAf497TMeV7R/banner
biography: aaa
bot:
greeting_msg: a
reset_msg: a
uid: 2UVvFEv0Ry3apdkLPDDUIgIKsyU
category:
id: 1
name: test
status: ''
chat_count: 29
description: aaa
name: Rezi Bot
profile_pic: >-
https://avatara-assets-staging.s3.ap-southeast-3.amazonaws.com/stars/2UVvFD03r5LYZ0imAf497TMeV7R/avatar
status: active
uid: 2UVvFD03r5LYZ0imAf497TMeV7R
message: Success Get Star
status: success
/conversations:
get:
tags:
- Conversation
summary: Get My Conversation By star
description: Get My Conversation By star
operationId: getMyConversationByStar
security:
- apiKeyAuth: []
bearerAuth: []
parameters:
- name: star_uid
in: query
schema:
$ref: "#/components/schemas/KSUID"
responses:
'200':
description: 'success get conversation'
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
required:
- uid
- star
properties:
uid:
$ref: "#/components/schemas/KSUID"
last_message_uid:
$ref: "#/components/schemas/KSUID"
message:
type: string
example: Success Get User Conversations
status:
type: string
example: success
post:
tags:
- Conversation
summary: Create conversation
description: Create conversation
operationId: createConversation
security:
- apiKeyAuth: []
bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
star_uid:
$ref: "#/components/schemas/KSUID"
examples:
Create conversation:
value:
star_uid: 2UVvFD03r5LYZ0imAf497TMeD2t
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
required:
- message
- status
- data
properties:
message:
type: string
example: success create conversation
status:
type: string
example: success
data:
type: array
items:
type: object
properties:
uid:
$ref: "#/components/schemas/KSUID"
session_uid:
$ref: "#/components/schemas/KSUID"
messages:
type: array
items:
$ref: "#/components/schemas/ConversationMessage"
pagination:
type: object
properties:
next_cursor:
type: string
example: eyJpZCI6IiIsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTAyVDAzOjAyOjQ0LjY0MVoiLCJwb2ludHNfbmV4dCI6dHJ1ZX0=
/conversations/{conversation_uid}/reset:
post:
tags:
- Conversation
summary: Reset conversation
description: Reset conversation
operationId: resetConversation
security:
- apiKeyAuth: []
bearerAuth: []
parameters:
- $ref: "#/components/parameters/ConversationUID"
requestBody:
content:
application/json:
schema:
type: object
properties:
star_uid:
type: string
example: 2UVvFD03r5LYZ0imAf497TMeD2t
examples:
Reset conversation:
value:
star_uid: 2UVvFD03r5LYZ0imAf497TMeD2t
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
required:
- message
- status
- data
properties:
message:
type: string
example: success reset conversation
status:
type: string
example: success
data:
type: array
items:
type: object
properties:
uid:
$ref: "#/components/schemas/KSUID"
session_uid:
$ref: "#/components/schemas/KSUID"
messages:
type: array
items:
$ref: "#/components/schemas/ConversationMessage"
pagination:
type: object
properties:
next_cursor:
type: string
example: eyJpZCI6IiIsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTAyVDAzOjAyOjQ0LjY0MVoiLCJwb2ludHNfbmV4dCI6dHJ1ZX0=
/conversations/{conversation_uid}/messages:
get:
tags:
- Conversation
summary: Get conversation message
description: Get conversation message
operationId: getConversationMessage
security:
- apiKeyAuth: []
bearerAuth: []
parameters:
- $ref: "#/components/parameters/ConversationUID"
- name: limit
in: query
schema:
type: string
example: '25'
- name: page
in: query
schema:
type: string
example: '1'
description: Not used when using sort_by and cursor
- name: sort_by
in: query
schema:
type: string
example: created_at.desc
description: 'Allowed value: created_at.desc'
- name: cursor
in: query
schema:
type: string
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
required:
- message
- status
- data
properties:
message:
type: string
example: success get conversation messages
status:
type: string
example: success
data:
type: array
items:
type: object
properties:
uid:
$ref: "#/components/schemas/KSUID"
session_uid:
$ref: "#/components/schemas/KSUID"
messages:
type: array
items:
$ref: "#/components/schemas/ConversationMessage"
pagination:
type: object
properties:
next_cursor:
type: string
example: eyJpZCI6IiIsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTAyVDAzOjAyOjQ0LjY0MVoiLCJwb2ludHNfbmV4dCI6dHJ1ZX0=
/metered/conversations/{conversation_uid}/chat/streaming:
post:
tags:
- Conversation
summary: Get Chat Reply Streaming
description: Get Streaming reply to a conversation
operationId: chat_stream_reply
security:
- apiKeyAuth: []
bearerAuth: []
parameters:
- $ref: "#/components/parameters/ConversationUID"
requestBody:
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "Haloo"
examples:
Create conversation:
value:
message: "Haloo"
responses:
'200':
description: OK
content:
text/plain:
schema:
type: string
example: >+
data: {"message_uid":null,"content":"This is warning message","message_type":"warning"}
data:
{"message_uid":"2UhpILLr5HbYOCYN4QTmCzsTR36","content":"","message_type":"ai"}
data:
{"message_uid":"2UhpILLr5HbYOCYN4QTmCzsTR36","content":"H","message_type":"ai"}
data:
{"message_uid":"2UhpILLr5HbYOCYN4QTmCzsTR36","content":"alo","message_type":"ai"}
data: {"message_uid":"2UhpILLr5HbYOCYN4QTmCzsTR36","content":"Alice","message_type":"ai"}
data:
{"message_uid":"2UhpILLr5HbYOCYN4QTmCzsTR36","content":".","message_type":"ai"}
data:
{"message_uid":"2UhpILLr5HbYOCYN4QTmCzsTR36","content":"","message_type":"ai"}
data: [DONE]
/metered/conversations/{conversation_uid}/chat:
post:
tags:
- Conversation
summary: Get Chat Reply
description: Get chat reply to a conversation
operationId: chat_reply
parameters:
- $ref: "#/components/parameters/ConversationUID"
security:
- apiKeyAuth: []
bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "Haloo"
examples:
Create conversation:
value:
message: "Haloo"
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
required:
- message
- status
- data
properties:
message:
type: string
example: success get conversation messages
status:
type: string
example: success
data:
type: object
properties:
message_uid:
$ref: "#/components/schemas/KSUID"
content:
type: string
example: "Haloo, John Doe! Ada apa nihh? 😊"
message_detail:
type: object
nullable: true
example: null
/conversations/{conversation_uid}/voice-note:
post:
tags:
- Conversation
summary: get reply voice from text
description: conversation text with voice
operationId: get_reply_with_voice
security:
- apiKeyAuth: []
bearerAuth: []
parameters:
- $ref: "#/components/parameters/ConversationUID"
requestBody:
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Haloo?
examples:
Streaming conversation:
value:
message: Haloo?
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
required:
- message
- status
- data
properties:
message:
type: string
example: Success request voice note
status:
type: string
example: success
data:
type: object
nullable: true
example: null
/conversations/{conversation_uid}/voice-note/audio:
post:
tags:
- Conversation
summary: conversation audio to audio
description: conversation audio to audio
operationId: get_reply_with_voice_from_audio
security:
- apiKeyAuth: []
bearerAuth: []
parameters:
- $ref: "#/components/parameters/ConversationUID"
requestBody:
content:
multipart/form-data:
schema:
properties:
file:
type: string
format: binary
transcription:
type: string
duration:
type: integer
reply_type:
type: string
enum: [text, audio]
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
required:
- message
- status
- data
properties:
message:
type: string
example: Success request voice note
status:
type: string
example: success
data:
type: object
nullable: true
example: null
/conversations/{conversation_uid}/messages/{msg_uid}/audio:
get:
tags:
- Conversation
summary: get audio from msg uid
description: "Get audio file from msg uid. Notes: File response is not supported in browser. Please use CuRL to try the endpoint"
operationId: get_audio_from_msg_uid
parameters:
- $ref: "#/components/parameters/ConversationUID"
- name: msg_uid
in: path
required: true
schema:
$ref: "#/components/schemas/KSUID"
responses:
'200':
description: ''
security:
- apiKeyAuth: []
bearerAuth: []
components:
schemas:
DateISO:
type: string
description: "ISO 8601"
example: "2011-06-20T14:48:00.000Z"
KSUID:
type: string
example: 0ujsswThIGTUYm2K8FjOOfXtY1K
ConversationMessage:
type: object
properties:
uid:
$ref: "#/components/schemas/KSUID"
content:
type: string
example: Haloo?
sender:
type: string
enum:
- ai
- human
example: ai
created_at:
$ref: "#/components/schemas/DateISO"
msg_type:
type: string
enum:
- text
- audio
- gift
message_detail:
type: object
properties:
say:
type: string
example: Haloo?
thought:
type: string
example: Aku senang sekali
expr:
type: string
example: Terseyum
action:
type: string
example: api_call
parameters:
ConversationUID:
name: conversation_uid
in: path
description: Conversation UID
required: true
schema:
$ref: "#/components/schemas/KSUID"
StarUID:
name: star_uid
in: path
description: Star UID
required: true
schema:
$ref: "#/components/schemas/KSUID"
Page:
name: page
in: query
description: Page that should be returned
required: false
schema:
type: number
example: 1
default: 1
Limit:
name: limit
in: query
description: Number of objects to return
required: false
schema:
type: number
example: 20
default: 10
maximum: 50
securitySchemes:
bearerAuth:
type: http
scheme: bearer
apiKeyAuth:
type: apiKey
in: header
name: apikey
tags:
- name: Auth
- name: Star
- name: Conversation