{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:tencent-yinsuda/apply-chorus":{"post":{"operationId":"cloud_tencent_yinsuda_apply_chorus","summary":"Apply Chorus","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId","RoomId","MusicId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"RoomId":{"type":"string"},"MusicId":{"type":"string"},"MaxChorusNum":{"type":"integer"},"ChorusUserIds":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/batch-describe-ktvmusic-details":{"post":{"operationId":"cloud_tencent_yinsuda_batch_describe_ktvmusic_details","summary":"Batch Describe KTVMusic Details","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId","MusicIds"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"MusicIds":{"type":"array"},"PlayScene":{"type":"string"},"GuestUserId":{"type":"string"},"RoomId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/create-ktvrobot":{"post":{"operationId":"cloud_tencent_yinsuda_create_ktvrobot","summary":"Create KTVRobot","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId","RTCSystem","JoinRoomInput"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"RTCSystem":{"type":"string"},"JoinRoomInput":{"type":"object"},"SyncRobotCommands":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/describe-ktvmatch-musics":{"post":{"operationId":"cloud_tencent_yinsuda_describe_ktvmatch_musics","summary":"Describe KTVMatch Musics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId","Rules"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"Rules":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/describe-ktvmusic-accompany-segment-url":{"post":{"operationId":"cloud_tencent_yinsuda_describe_ktvmusic_accompany_segment_url","summary":"Describe KTVMusic Accompany Segment Url","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId","MusicId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"MusicId":{"type":"string"},"PlayScene":{"type":"string"},"RoomId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/describe-ktvmusic-accompany-segment-url-vip":{"post":{"operationId":"cloud_tencent_yinsuda_describe_ktvmusic_accompany_segment_url_vip","summary":"Describe KTVMusic Accompany Segment Url Vip","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId","MusicId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"MusicId":{"type":"string"},"RoomId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/describe-ktvmusics-by-tag":{"post":{"operationId":"cloud_tencent_yinsuda_describe_ktvmusics_by_tag","summary":"Describe KTVMusics By Tag","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId","TagId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"TagId":{"type":"string"},"ScrollToken":{"type":"string"},"Limit":{"type":"integer"},"RightFilters":{"type":"array"},"MaterialFilters":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/describe-ktvplaylist-detail":{"post":{"operationId":"cloud_tencent_yinsuda_describe_ktvplaylist_detail","summary":"Describe KTVPlaylist Detail","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId","PlaylistId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"PlaylistId":{"type":"string"},"ScrollToken":{"type":"string"},"Limit":{"type":"integer"},"RightFilters":{"type":"array"},"PlayScene":{"type":"string"},"MaterialFilters":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/describe-ktvplaylists":{"post":{"operationId":"cloud_tencent_yinsuda_describe_ktvplaylists","summary":"Describe KTVPlaylists","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"Types":{"type":"array"},"Offset":{"type":"integer"},"Limit":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/describe-ktvrobots":{"post":{"operationId":"cloud_tencent_yinsuda_describe_ktvrobots","summary":"Describe KTVRobots","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"RobotIds":{"type":"array"},"Statuses":{"type":"array"},"CreateTime":{"type":"object"},"Offset":{"type":"integer"},"Limit":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/describe-ktvsuggestions":{"post":{"operationId":"cloud_tencent_yinsuda_describe_ktvsuggestions","summary":"Describe KTVSuggestions","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId","KeyWord"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"KeyWord":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/describe-ktvtags":{"post":{"operationId":"cloud_tencent_yinsuda_describe_ktvtags","summary":"Describe KTVTags","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/describe-live-vip-trade-infos":{"post":{"operationId":"cloud_tencent_yinsuda_describe_live_vip_trade_infos","summary":"Describe Live Vip Trade Infos","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"StartTime":{"type":"string"},"EndTime":{"type":"string"},"TradeSerialNos":{"type":"array"},"UserIds":{"type":"array"},"Offset":{"type":"integer"},"Limit":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/describe-user-info":{"post":{"operationId":"cloud_tencent_yinsuda_describe_user_info","summary":"Describe User Info","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/describe-vip-user-info":{"post":{"operationId":"cloud_tencent_yinsuda_describe_vip_user_info","summary":"Describe Vip User Info","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/destroy-ktvrobot":{"post":{"operationId":"cloud_tencent_yinsuda_destroy_ktvrobot","summary":"Destroy KTVRobot","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId","RobotId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"RobotId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/recharge-live-vip":{"post":{"operationId":"cloud_tencent_yinsuda_recharge_live_vip","summary":"Recharge Live Vip","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId","TradeSerialNo","RoomId","VipDays"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"TradeSerialNo":{"type":"string"},"RoomId":{"type":"string"},"VipDays":{"type":"integer"},"GiveType":{"type":"string"},"PlayScene":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/recharge-vip":{"post":{"operationId":"cloud_tencent_yinsuda_recharge_vip","summary":"Recharge Vip","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId","RoomId","VipDays","AnchorId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"RoomId":{"type":"string"},"VipDays":{"type":"integer"},"AnchorId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/search-ktvmusics":{"post":{"operationId":"cloud_tencent_yinsuda_search_ktvmusics","summary":"Search KTVMusics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId","KeyWord"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"KeyWord":{"type":"string"},"ScrollToken":{"type":"string"},"Limit":{"type":"integer"},"RightFilters":{"type":"array"},"PlayScene":{"type":"string"},"MaterialFilters":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-yinsuda/sync-ktvrobot-command":{"post":{"operationId":"cloud_tencent_yinsuda_sync_ktvrobot_command","summary":"Sync KTVRobot Command","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","UserId","RobotId","SyncRobotCommands"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AppName":{"type":"string"},"UserId":{"type":"string"},"RobotId":{"type":"string"},"SyncRobotCommands":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}