-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.json
More file actions
6431 lines (6431 loc) · 220 KB
/
openapi.json
File metadata and controls
6431 lines (6431 loc) · 220 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.1",
"info": {
"title": "ZHIPU AI API",
"description": "ZHIPU AI 接口提供强大的 AI 能力,包括聊天对话、工具调用和视频生成。",
"license": {
"name": "ZHIPU AI 开发者协议和政策",
"url": "https://chat.z.ai/legal-agreement/terms-of-service"
},
"version": "1.0.0",
"contact": {
"name": "Z.AI 开发者",
"url": "https://chat.z.ai/legal-agreement/privacy-policy",
"email": "user_feedback@z.ai"
}
},
"tags": [
{
"name": "对话 API",
"description": "Chat API"
},
{
"name": "嵌入 API",
"description": "Embedding API"
},
{
"name": "音频 API",
"description": "Audio API"
},
{
"name": "视频 API",
"description": "Video API"
},
{
"name": "图像 API",
"description": "Image API"
},
{
"name": "网络搜索 API",
"description": "Web Search API"
},
{
"name": "工具 API",
"description": "Tool API"
},
{
"name": "Agent API",
"description": "Agent API"
},
{
"name": "智能体 API",
"description": "Assistant API"
},
{
"name": "文件 API",
"description": "File API"
},
{
"name": "知识库 API",
"description": "Knowledge API"
},
{
"name": "清流智能体 API",
"description": "QingLiu Agent API"
},
{
"name": "实时 API",
"description": "Realtime API"
},
{
"name": "批处理 API",
"description": "Batch API"
}
],
"servers": [
{
"url": "https://open.bigmodel.cn/api/",
"description": "开放平台服务"
}
],
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/paas/v4/chat/completions": {
"post": {
"tags": ["对话 API"],
"summary": "聊天补全",
"description": "为聊天对话生成 AI 回复。支持多种应用场景对话,多模态能力。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatCompletionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatCompletionResponse"
}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/ChatCompletionChunk"
}
}
}
},
"default": {
"description": "请求失败",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/paas/v4/embeddings": {
"post": {
"tags": ["嵌入 API"],
"summary": "文本嵌入",
"description": "使用 GLM 嵌入模型将文本转换为高维向量表示,用于语义相似性和搜索。支持多语种和多种模型,兼容 OpenAI Embedding API。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmbeddingCreateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmbeddingResponse"
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/paas/v4/images/generations": {
"post": {
"tags": ["图像 API"],
"summary": "图像生成",
"description": "使用 CogView-4 系列模型从文本提示生成高质量图像。CogView-4 适用于图像生成任务,通过对用户文字描述快速、精准的理解,让AI的图像表达更加精确和个性化。支持cogview-4-250304、cogview-4、cogview-3-flash等模型。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateImageRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageGenerationResponse"
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/paas/v4/audio/speech": {
"post": {
"tags": ["音频 API"],
"summary": "文本转语音",
"description": "使用 CogTTS 将文本转换为自然语音,支持多种声音、情感控制和语调调整。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudioSpeechRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"audio/*": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/paas/v4/audio/transcriptions": {
"post": {
"tags": ["音频 API"],
"summary": "语音转文本",
"description": "使用 GLM ASR 模型将音频文件转录为文本,支持多语言和实时流式转录。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/AudioTranscriptionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudioTranscriptionResponse"
}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/AudioTranscriptionStreamResponse"
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/paas/v4/videos/generations": {
"post": {
"tags": ["视频 API"],
"summary": "生成视频",
"description": "通过文本或图像生成视频内容。支持多种视频生成方式,包括文本转视频、图像转视频等。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"title": "CogVideoX-3",
"$ref": "#/components/schemas/CogVideoX3Request"
},
{
"title": "CogVideoX",
"$ref": "#/components/schemas/CogVideoXRequest"
},
{
"title": "Vidu: Text to Video",
"$ref": "#/components/schemas/ViduText2VideoRequest"
},
{
"title": "Vidu: Image to Video",
"$ref": "#/components/schemas/ViduImage2VideoRequest"
},
{
"title": "Vidu: First & Last Frame to Video",
"$ref": "#/components/schemas/ViduFrames2VideoRequest"
},
{
"title": "Vidu: Ref to Video",
"$ref": "#/components/schemas/ViduReference2VideoRequest"
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VideoResponse"
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/paas/v4/async-result/{id}": {
"get": {
"tags": ["视频 API"],
"summary": "查询视频异步结果",
"description": "查询异步请求的处理结果和状态。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "任务 ID。"
}
}
],
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"model": {
"type": "string",
"description": "模型名称。"
},
"video_result": {
"type": "array",
"description": "视频生成结果。",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "视频链接。"
},
"cover_image_url": {
"type": "string",
"description": "视频封面链接。"
}
}
}
},
"task_status": {
"type": "string",
"description": "处理状态,`PROCESSING (处理中)`、`SUCCESS (成功)`、`FAIL (失败)`。注意:处理状态需要通过查询获取。"
},
"request_id": {
"type": "string",
"description": "客户端请求时用户提交的任务编号或平台生成的任务编号。"
}
}
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/paas/v4/web_search": {
"post": {
"tags": ["网络搜索 API"],
"summary": "网络搜索",
"description": "Web Search API 是一个专给大模型用的搜索引擎,在传统搜索引擎网页抓取、排序的能力基础上,增强了意图识别能力,返回更适合大模型处理的结果(网页标题、网页URL、网页摘要、网站名称、网站图标等)。支持意图增强检索、结构化输出和多引擎支持。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebSearchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebSearchResponse"
}
}
}
},
"default": {
"description": "请求失败。可能的错误码:1701-网络搜索并发已达上限,请稍后重试或减少并发请求;1702-系统未找到可用的搜索引擎服务,请检查配置或联系管理员;1703-搜索引擎未返回有效数据,请调整查询条件。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/v1/agents": {
"post": {
"tags": ["Agent API"],
"summary": "智能体对话",
"description": "与智能体进行对话交互。支持同步和流式调用,提供智能体的专业能力。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentResponse"
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/v1/agents/async-result": {
"post": {
"tags": ["Agent API"],
"summary": "查询异步结果",
"description": "查询智能体异步任务的处理结果和状态。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["async_id", "agent_id"],
"properties": {
"async_id": {
"type": "string",
"description": "任务ID",
"example": "VHJhbnNsYXRvckVudGl0eVRhc2s6OTI5OTY5"
},
"agent_id": {
"type": "string",
"description": "智能体ID,如 doc_translation_agent (专业文档翻译智能体)",
"example": "doc_translation_agent"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentAsyncResultResponse"
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/paas/v4/assistant": {
"post": {
"tags": ["智能体 API"],
"summary": "助手对话",
"deprecated": true,
"description": "与AI助手进行对话,支持流式和同步模式。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"name": "stream",
"in": "query",
"description": "是否启用流式响应",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssistantRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssistantResponse"
}
},
"text/event-stream": {
"schema": {
"type": "string",
"description": "流式响应数据"
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/paas/v4/assistant/list": {
"post": {
"tags": ["智能体 API"],
"deprecated": true,
"summary": "查询智能体列表",
"description": "查询指定的智能体列表信息,包括智能体的详细配置、工具和元数据。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssistantListRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true
},
"code": {
"type": "integer",
"example": 200
},
"msg": {
"type": "string",
"example": "操作成功"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssistantInfo"
}
}
}
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/paas/v4/assistant/conversation/list": {
"post": {
"tags": ["智能体 API"],
"deprecated": true,
"summary": "查询智能体会话列表",
"description": "查询指定智能体的会话列表,支持分页查询。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConversationListRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true
},
"code": {
"type": "integer",
"example": 200
},
"msg": {
"type": "string",
"example": "操作成功"
},
"data": {
"$ref": "#/components/schemas/ConversationListResponse"
}
}
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/paas/v4/files": {
"post": {
"tags": ["文件 API"],
"summary": "上传文件",
"description": "上传用于 Batch 任务、文件内容抽取等功能的文件。注意: “Try it”功能仅支持小文件上传,实际支持的文件大小请参见下文 purpose 相关说明。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/FileUploadRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileObject"
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"get": {
"tags": ["文件 API"],
"summary": "查询文件列表",
"description": "获取已上传文件的分页列表,支持按用途和排序过滤。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"name": "after",
"in": "query",
"description": "分页游标",
"schema": {
"type": "string"
}
},
{
"name": "purpose",
"in": "query",
"description": "按用途过滤文件",
"schema": {
"type": "string",
"enum": ["batch", "file-extract", "code-interpreter"]
}
},
{
"name": "order",
"in": "query",
"description": "排序方式",
"schema": {
"type": "string",
"enum": ["created_at"]
}
},
{
"name": "limit",
"in": "query",
"description": "每页返回的文件数量",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 20
}
}
],
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileListResponse"
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/paas/v4/files/{file_id}": {
"delete": {
"tags": ["文件 API"],
"summary": "删除文件",
"description": "永久删除指定文件及其所有关联数据。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"name": "file_id",
"in": "path",
"required": true,
"description": "文件唯一标识符",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileDeletedResponse"
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/paas/v4/files/{file_id}/content": {
"get": {
"tags": ["文件 API"],
"summary": "获取文件内容",
"description": "获取文件内容。只支持batch与file-extract文件类型。",
"parameters": [
{
"name": "file_id",
"in": "path",
"required": true,
"description": "文件唯一标识符",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "业务处理成功",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"default": {
"description": "请求失败。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/paas/v4/batches": {
"post": {
"tags": ["批处理 API"],
"summary": "创建批处理任务",
"description": "创建一个新的批处理任务。",
"parameters": [
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"requestBody": {