id
stringlengths
53
86
api_name
stringlengths
2
76
api_description
stringlengths
1
500
api_score
float64
0
10
endpoint_name
stringlengths
1
190
endpoint_description
stringlengths
0
500
response_status_code
int64
100
505
response_summary
stringlengths
1
68
response_json
stringlengths
6
50k
response_json_schema
stringlengths
14
150k
796435d8-e836-44f9-9b58-252b1d45c351/d44e151c-967e-4189-9a12-1753a551f906/0/0
AI Face Enhance
Enhance facial clarity by recovering lost details with advanced generative adversarial network
6.3
Main
Main function endpoint
200
New Example
{"job_id": "fc49e3a3-cebd-4911-841c-852b153ae3e9", "output_url": "https://vpai-demo-portal-shanghai.oss-accelerate.aliyuncs.com/intelligent-crop%2Ffc49e3a3-cebd-4911-841c-852b153ae3e9-061304.0496_20220815061304.png?OSSAccessKeyId=LTAI5tGgUWzx5gZopTcAvNtp&Expires=1660544044&Signature=4QpVOMsfAH3ddZTpEor9AhkSxM8%3D", "url_expiry": "2022/08/15 06:14:04"}
{"type": "object", "properties": {"job_id": {"type": "string"}, "output_url": {"type": "string"}, "url_expiry": {"type": "string"}}}
6ae553d0-08de-4d73-8260-84601007b8f9/84c05dba-a737-4de9-8ff6-0e7e41cfac58/0/0
TikTok - Download video no watermark
Get TikTok/Douyin video with/without watermark, high quality, fast, simple. TikTok Downloader No Watermark
9.6
get tiktok/douyin video info
Get TikTok/Douyin public videos full info (video no watermark included)
200
Response
{"url": "https://vt.tiktok.com/ZGJBQHoHA/", "data": {"id": "6985792919672229146", "type": "tiktok", "desc": "#CapCut Download TikTok video high quality without watermark #tipsandtricks #tut #tutorial #thuthuat #huongdan #youshouldknow #website #tiktokdownload", "create_time": 1626506664, "video_duration": 59301, "cover": "https://p16-sign-va.tiktokcdn.com/tos-useast2a-p-0037-aiso/e55ec229c68e477ead86d7538dd8235e~c5_300x400.webp?x-expires=1653944400&x-signature=dpcI65CKYO9OjlhhbxVo50%2FBA5s%3D", "cover_origin": "https://p16-sign-va.tiktokcdn.com/tos-useast2a-p-0037-aiso/5fc51440fbec4ecaa415b732be48a069_1626506668~tplv-tiktokx-360p.webp?x-expires=1653944400&x-signature=KHsxuzyCSrV5p0fFQ0krN%2BXI4p0%3D", "cover_dynamic": "https://p16-sign-va.tiktokcdn.com/obj/tos-useast2a-p-0037-aiso/f4d89512f1fd4fbfb17bb40efdb7cd0a_1626506668?x-expires=1653944400&x-signature=h6Jk6ZdR5IJSYKJXeOw9dcHX7S0%3D", "author_unique_id": "godownloader", "author_nickname": "godownloader", "author_uid": "6979798531235251202", "author_avatar": "https://p16-sign-va.tiktokcdn.com/tos-useast2a-avt-0068-aiso/469d9e90a72c34fe713123cc2f1ecb68~c5_1080x1080.webp?x-expires=1654009200&x-signature=teENDJptiy%2BnFuKRVDl5FBh6jrw%3D", "video_id": "v0f025gc0000c3p87f3c77u9jsatltig", "video_link_wm": "https://v16.tiktokcdn.com/dcf18a1cac221c3282743fe8561758bb/629538ec/video/tos/useast2a/tos-useast2a-pve-0037-aiso/34bc936cc5864e56812fe3ad3be979e1/?a=1180&ch=0&cr=3&dr=0&lr=all&cd=0%7C0%7C0%7C3&cv=1&br=918&bt=459&btag=80000&cs=0&ds=3&ft=btGwH-qMMD8ZmoMy1Vx_vjguYv.bLr&mime_type=video_mp4&qs=0&rc=ZmZlaTk4Ozg4M2ZnMzQ1PEBpand3djw6Zmk7NjMzZjgzM0AvYy02MzViNS4xYjAwNV4xYSNmaV5ncjQwNG1gLS1kL2Nzcw%3D%3D&l=202205301535450102440030260F3CF049", "video_link_nwm": "https://v16.tiktokcdn.com/f275e7b12f26a93a6be51fc91f8f8876/629538ec/video/tos/useast2a/tos-useast2a-pve-0037-aiso/3b7779af2b574b8e8bedb8ef6b73e78f/?a=1180&ch=0&cr=3&dr=0&lr=all&cd=0%7C0%7C0%7C3&cv=1&br=720&bt=360&btag=80000&cs=0&ds=6&ft=btGwH-qMMD8ZmoMy1Vx_vjguYv.bLr&mime_type=video_mp4&qs=0&rc=OjtoZWQ4OGU7aDRkOzNnOEBpand3djw6Zmk7NjMzZjgzM0AwM2JhYDRjXy0xNl9jNGIwYSNmaV5ncjQwNG1gLS1kL2Nzcw%3D%3D&l=202205301535450102440030260F3CF049", "music": {"id": 6985792925946891000, "title": "original sound - godownloader", "cover": "https://p16-sign-va.tiktokcdn.com/tos-useast2a-avt-0068-aiso/469d9e90a72c34fe713123cc2f1ecb68~c5_100x100.webp?x-expires=1654009200&x-signature=KgEWENZsx1NbgG5pB%2FyddcQIj%2Bk%3D", "author": "godownloader", "uri": "https://sf16-ies-music.tiktokcdn.com/obj/ies-music-aiso/6985792883437685531.mp3"}, "video_link_nwm_hd": "https://v16.tiktokcdn.com/eb4753753a9d4fab4b82e5944b941bb2/629538ec/video/tos/useast2a/tos-useast2a-pv-0037-aiso/da97e2564b414c4fbfd08165886967aa/?a=1180&ch=0&cr=0&dr=0&cd=0%7C0%7C0%7C0&cv=1&br=15558&bt=7779&btag=40000&cs=0&ds=4&ft=tiXQhgM6BMyqWHo2QJD1~jH_7mXt&mime_type=video_mp4&qs=13&rc=and3djw6Zmk7NjMzZjgzM0Bpand3djw6Zmk7NjMzZjgzM0BmaV5ncjQwNG1gLS1kL2NzYSNmaV5ncjQwNG1gLS1kL2Nzcw%3D%3D&l=202205301535450102451551101E3DB66A"}}
{"type": "object", "properties": {"url": {"type": "string"}, "data": {"type": "object", "properties": {"id": {"type": "string"}, "type": {"type": "string"}, "desc": {"type": "string"}, "create_time": {"type": "integer"}, "video_duration": {"type": "integer"}, "cover": {"type": "string"}, "cover_origin": {"type": "string"}, "cover_dynamic": {"type": "string"}, "author_unique_id": {"type": "string"}, "author_nickname": {"type": "string"}, "author_uid": {"type": "string"}, "author_avatar": {"type": "string"}, "video_id": {"type": "string"}, "video_link_wm": {"type": "string"}, "video_link_nwm": {"type": "string"}, "music": {"type": "object", "properties": {"id": {"type": "integer"}, "title": {"type": "string"}, "cover": {"type": "string"}, "author": {"type": "string"}, "uri": {"type": "string"}}}, "video_link_nwm_hd": {"type": "string"}}}}}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/7215719c-b83b-48e9-a681-d5b57967d1ee/3/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AssetsController_update
200
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/media/content.m3u8", "backupIp": "9.9.9.9", "id": 42, "format": "DASH"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}, "backupIp": {"type": "string", "description": "(Optional) Backup IP of the source, only allowed when the source url is specified with an IP"}, "id": {"type": "number", "description": "Id of the source, assigned by broadpeak.io"}, "format": {"type": "string", "description": "Format of the source (DASH, HLS), based on provided URL"}}, "required": ["name", "url", "id", "format"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/5cd7b020-56f8-473b-9ca1-37674e5a97db/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
TranscodingProfileController_get
200
null
{"name": "Profile1", "content": "{\"field\": \"data\", ...}", "id": 42}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the transcoding profile"}, "content": {"type": "string", "description": "Content of the profile in the JSON format"}, "id": {"type": "number", "description": "Id of the transcoding profile"}}, "required": ["name", "content", "id"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/6f30c204-4517-4d03-9e0e-11c6338c81cd/2/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AssetsController_delete
204
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/media/content.m3u8", "backupIp": "9.9.9.9", "id": 42, "format": "DASH"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}, "backupIp": {"type": "string", "description": "(Optional) Backup IP of the source, only allowed when the source url is specified with an IP"}, "id": {"type": "number", "description": "Id of the source, assigned by broadpeak.io"}, "format": {"type": "string", "description": "Format of the source (DASH, HLS), based on provided URL"}}, "required": ["name", "url", "id", "format"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/57075b6f-c30d-4e1b-b81e-ae19ef6dd837/2/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AssetsCatalogController_update
200
null
{"name": "ABC", "description": "A description of the source", "url": "https://example.io/vod/", "backupIp": "9.9.9.9", "assetSample": "default/sample.mpd", "id": 42}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "Url of an asset catalog folder, must end with a slash"}, "backupIp": {"type": "string", "description": "(Optional) Backup IP of the source, only allowed when the source url is specified with an IP"}, "assetSample": {"type": "string", "description": "relative path of an asset from the asset catalog url"}, "id": {"type": "number", "description": "Id of the source, assigned by broadpeak.io"}}, "required": ["name", "url", "assetSample", "id"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/d1e3f679-34b2-48fb-8465-79b98f63e0d0/2/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AssetsController_create
201
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/media/content.m3u8", "backupIp": "9.9.9.9", "id": 42, "format": "DASH"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}, "backupIp": {"type": "string", "description": "(Optional) Backup IP of the source, only allowed when the source url is specified with an IP"}, "id": {"type": "number", "description": "Id of the source, assigned by broadpeak.io"}, "format": {"type": "string", "description": "Format of the source (DASH, HLS), based on provided URL"}}, "required": ["name", "url", "id", "format"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/6a498f54-e20d-4fba-ae75-e51ca7bb8333/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
ConsumptionsController_getTenantConsumption
200
null
[{"tenantId": "24", "from": "2022-01-01T12:30:00Z", "to": "2022-01-01T12:30:00Z", "egress": "500", "virtualChannel": "500", "contentReplacement": "500", "insertedAds": "500"}]
{"type": "array", "items": {"type": "object", "properties": {"tenantId": {"type": "number", "description": "Tenant Id"}, "from": {"format": "date-time", "type": "string", "description": "Start time (format ISO 8601)"}, "to": {"format": "date-time", "type": "string", "description": "End time (format ISO 8601)"}, "egress": {"type": "number", "description": "Egress consumption in GB"}, "virtualChannel": {"type": "number", "description": "Virtual channel consumption in hours"}, "contentReplacement": {"type": "number", "description": "Content replacement consumption in hours"}, "insertedAds": {"type": "number", "description": "Inserted ads consumption"}}, "required": ["tenantId", "to", "egress", "virtualChannel", "contentReplacement", "insertedAds"]}}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/d2694b5b-d966-4bce-903d-63ba6cb533ab/2/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AdInsertionController_update
200
null
{"name": "Service A", "environmentTags": [], "state": ["enabled", "paused"], "liveAdPreRoll": {"adServer": {"id": 42, "name": "ad-server", "url": "https://example/server/ads", "queries": "Some queries specific to the ad server"}, "maxDuration": 360, "offset": 0}, "liveAdReplacement": {"adServer": {"id": 42, "name": "ad-server", "url": "https://example/server/ads", "queries": "Some queries specific to the ad server"}, "gapFiller": {"id": 42, "name": "ABC", "type": "asset", "url": "https://example/video/source"}}, "vodAdInsertion": {"adServer": {"id": 42, "name": "ad-server", "url": "https://example/server/ads", "queries": "Some queries specific to the ad server"}}, "transcodingProfile": {"name": "Profile1", "content": "{\"field\": \"data\", ...}", "id": 42}, "enableAdTranscoding": false, "serverSideAdTracking": {"enable": false, "checkAdMediaSegmentAvailability": false}, "source": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "id": 42, "creationDate": "2022-01-18T09:00:00.000Z", "updateDate": "2022-02-22T22:22:22.955Z", "url": "https://stream.broadpeak.io/68b329da9893e34099c7d8ad5cb9c940/path/resource.mpd"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the service"}, "environmentTags": {"description": "Environment tags associated with the service (Deprecated)", "type": "array", "items": {"type": "string"}}, "state": {"type": "string", "description": "State of the service"}, "liveAdPreRoll": {"description": "Configuration of live pre-roll", "allOf": [{"type": "object", "properties": {"adServer": {"description": "Ad server", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the ad server"}, "name": {"type": "string", "description": "Name of the ad server"}, "url": {"type": "string", "description": "URL of the ad server"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server"}}, "required": ["id", "name", "url"]}]}, "maxDuration": {"type": "number", "description": "Pre-roll maximum duration (in seconds)"}, "offset": {"type": "number", "description": "Pre-roll relative start time (in seconds)"}}, "required": ["adServer", "maxDuration"]}]}, "liveAdReplacement": {"description": "Configuration of live ad-replacement", "allOf": [{"type": "object", "properties": {"adServer": {"description": "Ad server", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the ad server"}, "name": {"type": "string", "description": "Name of the ad server"}, "url": {"type": "string", "description": "URL of the ad server"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server"}}, "required": ["id", "name", "url"]}]}, "gapFiller": {"description": "Asset or slate source used as a gap filler (if the ads are not long enough for the available ad slot)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source used as a gap filler"}, "name": {"type": "string", "description": "Name of the source used as a gap filler"}, "type": {"type": "string", "description": "Type of the source used as a gap filler"}, "url": {"type": "string", "description": "URL for the source used as a gap filler"}}, "required": ["id", "name", "type", "url"]}]}}, "required": ["adServer"]}]}, "vodAdInsertion": {"description": "Configuration of VoD ad-insertion", "allOf": [{"type": "object", "properties": {"adServer": {"description": "Ad server", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the ad server"}, "name": {"type": "string", "description": "Name of the ad server"}, "url": {"type": "string", "description": "URL of the ad server"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server"}}, "required": ["id", "name", "url"]}]}}, "required": ["adServer"]}]}, "transcodingProfile": {"description": "Transcoding profile", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the transcoding profile"}, "content": {"type": "string", "description": "Content of the profile in the JSON format"}, "id": {"type": "number", "description": "Id of the transcoding profile"}}, "required": ["name", "content", "id"]}]}, "enableAdTranscoding": {"type": "boolean", "description": "Enable the transcoding of the ads", "default": false}, "serverSideAdTracking": {"description": "Server side ad tracking", "allOf": [{"type": "object", "properties": {"enable": {"type": "boolean", "description": "Enable server side ad tracking", "default": false}, "checkAdMediaSegmentAvailability": {"type": "boolean", "description": "Enable ad segments availability checks", "default": false}}}]}, "source": {"description": "Source", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "id": {"type": "number", "description": "Id of the ad-insertion service"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the ad-insertion service"}, "updateDate": {"format": "date-time", "type": "string", "description": "Update date of the ad-insertion service"}, "url": {"type": "string", "description": "URL of the ad-insertion service"}}, "required": ["name", "source", "id", "creationDate", "updateDate", "url"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/9aa2b667-26fe-43bd-869c-59d329f29c87/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
TranscodingProfileController_findAll
200
null
[{"name": "Profile1", "content": "{\"field\": \"data\", ...}", "id": 42}]
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the transcoding profile"}, "content": {"type": "string", "description": "Content of the profile in the JSON format"}, "id": {"type": "number", "description": "Id of the transcoding profile"}}, "required": ["name", "content", "id"]}}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/fe7ff98f-1c64-46fa-9361-ce3e8c5781bd/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AssetsController_get
200
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/media/content.m3u8", "backupIp": "9.9.9.9", "id": 42, "format": "DASH"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}, "backupIp": {"type": "string", "description": "(Optional) Backup IP of the source, only allowed when the source url is specified with an IP"}, "id": {"type": "number", "description": "Id of the source, assigned by broadpeak.io"}, "format": {"type": "string", "description": "Format of the source (DASH, HLS), based on provided URL"}}, "required": ["name", "url", "id", "format"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/308b01bf-18fa-42e4-b70d-a8cf9fe0d2c3/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AdInsertionController_getById
200
null
{"name": "Service A", "environmentTags": [], "state": ["enabled", "paused"], "liveAdPreRoll": {"adServer": {"id": 42, "name": "ad-server", "url": "https://example/server/ads", "queries": "Some queries specific to the ad server"}, "maxDuration": 360, "offset": 0}, "liveAdReplacement": {"adServer": {"id": 42, "name": "ad-server", "url": "https://example/server/ads", "queries": "Some queries specific to the ad server"}, "gapFiller": {"id": 42, "name": "ABC", "type": "asset", "url": "https://example/video/source"}}, "vodAdInsertion": {"adServer": {"id": 42, "name": "ad-server", "url": "https://example/server/ads", "queries": "Some queries specific to the ad server"}}, "transcodingProfile": {"name": "Profile1", "content": "{\"field\": \"data\", ...}", "id": 42}, "enableAdTranscoding": false, "serverSideAdTracking": {"enable": false, "checkAdMediaSegmentAvailability": false}, "source": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "id": 42, "creationDate": "2022-01-18T09:00:00.000Z", "updateDate": "2022-02-22T22:22:22.955Z", "url": "https://stream.broadpeak.io/68b329da9893e34099c7d8ad5cb9c940/path/resource.mpd"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the service"}, "environmentTags": {"description": "Environment tags associated with the service (Deprecated)", "type": "array", "items": {"type": "string"}}, "state": {"type": "string", "description": "State of the service"}, "liveAdPreRoll": {"description": "Configuration of live pre-roll", "allOf": [{"type": "object", "properties": {"adServer": {"description": "Ad server", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the ad server"}, "name": {"type": "string", "description": "Name of the ad server"}, "url": {"type": "string", "description": "URL of the ad server"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server"}}, "required": ["id", "name", "url"]}]}, "maxDuration": {"type": "number", "description": "Pre-roll maximum duration (in seconds)"}, "offset": {"type": "number", "description": "Pre-roll relative start time (in seconds)"}}, "required": ["adServer", "maxDuration"]}]}, "liveAdReplacement": {"description": "Configuration of live ad-replacement", "allOf": [{"type": "object", "properties": {"adServer": {"description": "Ad server", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the ad server"}, "name": {"type": "string", "description": "Name of the ad server"}, "url": {"type": "string", "description": "URL of the ad server"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server"}}, "required": ["id", "name", "url"]}]}, "gapFiller": {"description": "Asset or slate source used as a gap filler (if the ads are not long enough for the available ad slot)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source used as a gap filler"}, "name": {"type": "string", "description": "Name of the source used as a gap filler"}, "type": {"type": "string", "description": "Type of the source used as a gap filler"}, "url": {"type": "string", "description": "URL for the source used as a gap filler"}}, "required": ["id", "name", "type", "url"]}]}}, "required": ["adServer"]}]}, "vodAdInsertion": {"description": "Configuration of VoD ad-insertion", "allOf": [{"type": "object", "properties": {"adServer": {"description": "Ad server", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the ad server"}, "name": {"type": "string", "description": "Name of the ad server"}, "url": {"type": "string", "description": "URL of the ad server"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server"}}, "required": ["id", "name", "url"]}]}}, "required": ["adServer"]}]}, "transcodingProfile": {"description": "Transcoding profile", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the transcoding profile"}, "content": {"type": "string", "description": "Content of the profile in the JSON format"}, "id": {"type": "number", "description": "Id of the transcoding profile"}}, "required": ["name", "content", "id"]}]}, "enableAdTranscoding": {"type": "boolean", "description": "Enable the transcoding of the ads", "default": false}, "serverSideAdTracking": {"description": "Server side ad tracking", "allOf": [{"type": "object", "properties": {"enable": {"type": "boolean", "description": "Enable server side ad tracking", "default": false}, "checkAdMediaSegmentAvailability": {"type": "boolean", "description": "Enable ad segments availability checks", "default": false}}}]}, "source": {"description": "Source", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "id": {"type": "number", "description": "Id of the ad-insertion service"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the ad-insertion service"}, "updateDate": {"format": "date-time", "type": "string", "description": "Update date of the ad-insertion service"}, "url": {"type": "string", "description": "URL of the ad-insertion service"}}, "required": ["name", "source", "id", "creationDate", "updateDate", "url"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/edee88fa-1df6-460d-8c12-6e060a6a9d7a/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AssetsCatalogController_get
200
null
{"name": "ABC", "description": "A description of the source", "url": "https://example.io/vod/", "backupIp": "9.9.9.9", "assetSample": "default/sample.mpd", "id": 42}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "Url of an asset catalog folder, must end with a slash"}, "backupIp": {"type": "string", "description": "(Optional) Backup IP of the source, only allowed when the source url is specified with an IP"}, "assetSample": {"type": "string", "description": "relative path of an asset from the asset catalog url"}, "id": {"type": "number", "description": "Id of the source, assigned by broadpeak.io"}}, "required": ["name", "url", "assetSample", "id"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/23579ef8-6e3c-4802-a047-b964ea1d20f7/2/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
VirtualChannelController_update
200
null
{"name": "Service A", "environmentTags": [], "state": ["enabled", "paused"], "adBreakInsertion": {"adServer": {"id": 42, "name": "ad-server", "url": "https://example/server/ads", "queries": "Some queries specific to the ad server"}, "gapFiller": {"id": 42, "name": "ABC", "type": "asset", "url": "https://example/video/source"}}, "transcodingProfile": {"name": "Profile1", "content": "{\"field\": \"data\", ...}", "id": 42}, "serverSideAdTracking": {"enable": false, "checkAdMediaSegmentAvailability": false}, "enableAdTranscoding": false, "baseLive": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "id": 42, "url": "https://stream.broadpeak.io/79c43aeba9a4f451aad8e9be6dcada51/path/resource.mpd", "creationDate": "2021-08-23T13:35:47.955Z", "updateDate": "2022-02-22T22:22:22.955Z"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the service"}, "environmentTags": {"description": "Environment tags associated with the service (Deprecated)", "type": "array", "items": {"type": "string"}}, "state": {"type": "string", "description": "State of the service"}, "adBreakInsertion": {"description": "Configuration of ad-break insertion", "allOf": [{"type": "object", "properties": {"adServer": {"description": "Ad server", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the ad server"}, "name": {"type": "string", "description": "Name of the ad server"}, "url": {"type": "string", "description": "URL of the ad server"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server"}}, "required": ["id", "name", "url"]}]}, "gapFiller": {"description": "Asset or slate source used as a gap filler (if the ads are not long enough for the available ad slot)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source used as a gap filler"}, "name": {"type": "string", "description": "Name of the source used as a gap filler"}, "type": {"type": "string", "description": "Type of the source used as a gap filler"}, "url": {"type": "string", "description": "URL for the source used as a gap filler"}}, "required": ["id", "name", "type", "url"]}]}}, "required": ["adServer"]}]}, "transcodingProfile": {"description": "Transcoding profile", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the transcoding profile"}, "content": {"type": "string", "description": "Content of the profile in the JSON format"}, "id": {"type": "number", "description": "Id of the transcoding profile"}}, "required": ["name", "content", "id"]}]}, "serverSideAdTracking": {"description": "Server side ad tracking", "allOf": [{"type": "object", "properties": {"enable": {"type": "boolean", "description": "Enable server side ad tracking", "default": false}, "checkAdMediaSegmentAvailability": {"type": "boolean", "description": "Enable ad segments availability checks", "default": false}}}]}, "enableAdTranscoding": {"type": "boolean", "description": "Enable the transcoding of the ads", "default": false}, "baseLive": {"description": "Base live for the virtual channel", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "id": {"type": "number", "description": "Id of the virtual-channel service"}, "url": {"type": "string", "description": "URL of the virtual-channel service"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the virtual-channel service"}, "updateDate": {"format": "date-time", "type": "string", "description": "Update date of the virtual-channel service"}}, "required": ["name", "baseLive", "id", "url", "creationDate", "updateDate"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/9d632f2c-a812-49fa-8b95-76dcca1b6008/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AssetsCatalogController_create
201
null
{"name": "ABC", "description": "A description of the source", "url": "https://example.io/vod/", "backupIp": "9.9.9.9", "assetSample": "default/sample.mpd", "id": 42}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "Url of an asset catalog folder, must end with a slash"}, "backupIp": {"type": "string", "description": "(Optional) Backup IP of the source, only allowed when the source url is specified with an IP"}, "assetSample": {"type": "string", "description": "relative path of an asset from the asset catalog url"}, "id": {"type": "number", "description": "Id of the source, assigned by broadpeak.io"}}, "required": ["name", "url", "assetSample", "id"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/585eafc5-73c7-4ba2-ac0a-27bf37079a3f/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AdInsertionController_create
201
null
{"name": "Service A", "environmentTags": [], "state": ["enabled", "paused"], "liveAdPreRoll": {"adServer": {"id": 42, "name": "ad-server", "url": "https://example/server/ads", "queries": "Some queries specific to the ad server"}, "maxDuration": 360, "offset": 0}, "liveAdReplacement": {"adServer": {"id": 42, "name": "ad-server", "url": "https://example/server/ads", "queries": "Some queries specific to the ad server"}, "gapFiller": {"id": 42, "name": "ABC", "type": "asset", "url": "https://example/video/source"}}, "vodAdInsertion": {"adServer": {"id": 42, "name": "ad-server", "url": "https://example/server/ads", "queries": "Some queries specific to the ad server"}}, "transcodingProfile": {"name": "Profile1", "content": "{\"field\": \"data\", ...}", "id": 42}, "enableAdTranscoding": false, "serverSideAdTracking": {"enable": false, "checkAdMediaSegmentAvailability": false}, "source": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "id": 42, "creationDate": "2022-01-18T09:00:00.000Z", "updateDate": "2022-02-22T22:22:22.955Z", "url": "https://stream.broadpeak.io/68b329da9893e34099c7d8ad5cb9c940/path/resource.mpd"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the service"}, "environmentTags": {"description": "Environment tags associated with the service (Deprecated)", "type": "array", "items": {"type": "string"}}, "state": {"type": "string", "description": "State of the service"}, "liveAdPreRoll": {"description": "Configuration of live pre-roll", "allOf": [{"type": "object", "properties": {"adServer": {"description": "Ad server", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the ad server"}, "name": {"type": "string", "description": "Name of the ad server"}, "url": {"type": "string", "description": "URL of the ad server"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server"}}, "required": ["id", "name", "url"]}]}, "maxDuration": {"type": "number", "description": "Pre-roll maximum duration (in seconds)"}, "offset": {"type": "number", "description": "Pre-roll relative start time (in seconds)"}}, "required": ["adServer", "maxDuration"]}]}, "liveAdReplacement": {"description": "Configuration of live ad-replacement", "allOf": [{"type": "object", "properties": {"adServer": {"description": "Ad server", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the ad server"}, "name": {"type": "string", "description": "Name of the ad server"}, "url": {"type": "string", "description": "URL of the ad server"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server"}}, "required": ["id", "name", "url"]}]}, "gapFiller": {"description": "Asset or slate source used as a gap filler (if the ads are not long enough for the available ad slot)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source used as a gap filler"}, "name": {"type": "string", "description": "Name of the source used as a gap filler"}, "type": {"type": "string", "description": "Type of the source used as a gap filler"}, "url": {"type": "string", "description": "URL for the source used as a gap filler"}}, "required": ["id", "name", "type", "url"]}]}}, "required": ["adServer"]}]}, "vodAdInsertion": {"description": "Configuration of VoD ad-insertion", "allOf": [{"type": "object", "properties": {"adServer": {"description": "Ad server", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the ad server"}, "name": {"type": "string", "description": "Name of the ad server"}, "url": {"type": "string", "description": "URL of the ad server"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server"}}, "required": ["id", "name", "url"]}]}}, "required": ["adServer"]}]}, "transcodingProfile": {"description": "Transcoding profile", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the transcoding profile"}, "content": {"type": "string", "description": "Content of the profile in the JSON format"}, "id": {"type": "number", "description": "Id of the transcoding profile"}}, "required": ["name", "content", "id"]}]}, "enableAdTranscoding": {"type": "boolean", "description": "Enable the transcoding of the ads", "default": false}, "serverSideAdTracking": {"description": "Server side ad tracking", "allOf": [{"type": "object", "properties": {"enable": {"type": "boolean", "description": "Enable server side ad tracking", "default": false}, "checkAdMediaSegmentAvailability": {"type": "boolean", "description": "Enable ad segments availability checks", "default": false}}}]}, "source": {"description": "Source", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "id": {"type": "number", "description": "Id of the ad-insertion service"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the ad-insertion service"}, "updateDate": {"format": "date-time", "type": "string", "description": "Update date of the ad-insertion service"}, "url": {"type": "string", "description": "URL of the ad-insertion service"}}, "required": ["name", "source", "id", "creationDate", "updateDate", "url"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/b5ca3bf0-3830-4550-9e93-ef749366829b/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AssetsCatalogController_delete
204
null
{"name": "ABC", "description": "A description of the source", "url": "https://example.io/vod/", "backupIp": "9.9.9.9", "assetSample": "default/sample.mpd", "id": 42}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "Url of an asset catalog folder, must end with a slash"}, "backupIp": {"type": "string", "description": "(Optional) Backup IP of the source, only allowed when the source url is specified with an IP"}, "assetSample": {"type": "string", "description": "relative path of an asset from the asset catalog url"}, "id": {"type": "number", "description": "Id of the source, assigned by broadpeak.io"}}, "required": ["name", "url", "assetSample", "id"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/6ca131fc-68d5-4997-8b5b-8e002d1b2e2a/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
VirtualChannelController_getById
200
null
{"name": "Service A", "environmentTags": [], "state": ["enabled", "paused"], "adBreakInsertion": {"adServer": {"id": 42, "name": "ad-server", "url": "https://example/server/ads", "queries": "Some queries specific to the ad server"}, "gapFiller": {"id": 42, "name": "ABC", "type": "asset", "url": "https://example/video/source"}}, "transcodingProfile": {"name": "Profile1", "content": "{\"field\": \"data\", ...}", "id": 42}, "serverSideAdTracking": {"enable": false, "checkAdMediaSegmentAvailability": false}, "enableAdTranscoding": false, "baseLive": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "id": 42, "url": "https://stream.broadpeak.io/79c43aeba9a4f451aad8e9be6dcada51/path/resource.mpd", "creationDate": "2021-08-23T13:35:47.955Z", "updateDate": "2022-02-22T22:22:22.955Z"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the service"}, "environmentTags": {"description": "Environment tags associated with the service (Deprecated)", "type": "array", "items": {"type": "string"}}, "state": {"type": "string", "description": "State of the service"}, "adBreakInsertion": {"description": "Configuration of ad-break insertion", "allOf": [{"type": "object", "properties": {"adServer": {"description": "Ad server", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the ad server"}, "name": {"type": "string", "description": "Name of the ad server"}, "url": {"type": "string", "description": "URL of the ad server"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server"}}, "required": ["id", "name", "url"]}]}, "gapFiller": {"description": "Asset or slate source used as a gap filler (if the ads are not long enough for the available ad slot)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source used as a gap filler"}, "name": {"type": "string", "description": "Name of the source used as a gap filler"}, "type": {"type": "string", "description": "Type of the source used as a gap filler"}, "url": {"type": "string", "description": "URL for the source used as a gap filler"}}, "required": ["id", "name", "type", "url"]}]}}, "required": ["adServer"]}]}, "transcodingProfile": {"description": "Transcoding profile", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the transcoding profile"}, "content": {"type": "string", "description": "Content of the profile in the JSON format"}, "id": {"type": "number", "description": "Id of the transcoding profile"}}, "required": ["name", "content", "id"]}]}, "serverSideAdTracking": {"description": "Server side ad tracking", "allOf": [{"type": "object", "properties": {"enable": {"type": "boolean", "description": "Enable server side ad tracking", "default": false}, "checkAdMediaSegmentAvailability": {"type": "boolean", "description": "Enable ad segments availability checks", "default": false}}}]}, "enableAdTranscoding": {"type": "boolean", "description": "Enable the transcoding of the ads", "default": false}, "baseLive": {"description": "Base live for the virtual channel", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "id": {"type": "number", "description": "Id of the virtual-channel service"}, "url": {"type": "string", "description": "URL of the virtual-channel service"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the virtual-channel service"}, "updateDate": {"format": "date-time", "type": "string", "description": "Update date of the virtual-channel service"}}, "required": ["name", "baseLive", "id", "url", "creationDate", "updateDate"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/edd63120-e83a-4194-9647-c71a92d805b2/2/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
ContentReplacementSlotController_update
200
null
{"name": "Slot A", "startTime": "2022-01-01T12:30:00Z", "endTime": "2022-01-01T12:32:00Z", "duration": 120, "replacement": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "categories": {"name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}], "id": 42}, "category": {"id": 42, "name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}]}, "id": 314}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the slot"}, "startTime": {"format": "date-time", "type": "string", "description": "Start time (format ISO 8601)"}, "endTime": {"format": "date-time", "type": "string", "description": "End time (format ISO 8601), mutually exclusive with duration"}, "duration": {"type": "number", "description": "Duration in seconds, mutually exclusive with endTime"}, "replacement": {"description": "Replacement source (if unspecified, default replacement is applied)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "categories": {"description": "Deprecated, use category instead", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the category"}, "subcategories": {"description": "Optional subcategories for the category", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}, "id": {"type": "number", "description": "Id of the Category"}}, "required": ["name", "subcategories", "id"]}]}, "category": {"description": "Optional category for the slot (if unspecified, the slot applies to all)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the Category"}, "name": {"type": "string", "description": "Name of the category for a slot"}, "subcategories": {"description": "Optional subcategories for the category attached to a slot", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}}, "required": ["id", "name", "subcategories"]}]}, "id": {"type": "number", "description": "Id of the slot"}}, "required": ["startTime", "id"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/a68757bf-daa7-4df6-86b0-c1e7ff8ef573/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
ContentReplacementSlotController_create
201
null
{"name": "Slot A", "startTime": "2022-01-01T12:30:00Z", "endTime": "2022-01-01T12:32:00Z", "duration": 120, "replacement": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "categories": {"name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}], "id": 42}, "category": {"id": 42, "name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}]}, "id": 314}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the slot"}, "startTime": {"format": "date-time", "type": "string", "description": "Start time (format ISO 8601)"}, "endTime": {"format": "date-time", "type": "string", "description": "End time (format ISO 8601), mutually exclusive with duration"}, "duration": {"type": "number", "description": "Duration in seconds, mutually exclusive with endTime"}, "replacement": {"description": "Replacement source (if unspecified, default replacement is applied)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "categories": {"description": "Deprecated, use category instead", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the category"}, "subcategories": {"description": "Optional subcategories for the category", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}, "id": {"type": "number", "description": "Id of the Category"}}, "required": ["name", "subcategories", "id"]}]}, "category": {"description": "Optional category for the slot (if unspecified, the slot applies to all)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the Category"}, "name": {"type": "string", "description": "Name of the category for a slot"}, "subcategories": {"description": "Optional subcategories for the category attached to a slot", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}}, "required": ["id", "name", "subcategories"]}]}, "id": {"type": "number", "description": "Id of the slot"}}, "required": ["startTime", "id"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/0500abdc-d14d-4ca2-8547-ec59e9265c8e/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
ContentReplacementSlotController_getById
200
null
{"name": "Slot A", "startTime": "2022-01-01T12:30:00Z", "endTime": "2022-01-01T12:32:00Z", "duration": 120, "replacement": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "categories": {"name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}], "id": 42}, "category": {"id": 42, "name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}]}, "id": 314}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the slot"}, "startTime": {"format": "date-time", "type": "string", "description": "Start time (format ISO 8601)"}, "endTime": {"format": "date-time", "type": "string", "description": "End time (format ISO 8601), mutually exclusive with duration"}, "duration": {"type": "number", "description": "Duration in seconds, mutually exclusive with endTime"}, "replacement": {"description": "Replacement source (if unspecified, default replacement is applied)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "categories": {"description": "Deprecated, use category instead", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the category"}, "subcategories": {"description": "Optional subcategories for the category", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}, "id": {"type": "number", "description": "Id of the Category"}}, "required": ["name", "subcategories", "id"]}]}, "category": {"description": "Optional category for the slot (if unspecified, the slot applies to all)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the Category"}, "name": {"type": "string", "description": "Name of the category for a slot"}, "subcategories": {"description": "Optional subcategories for the category attached to a slot", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}}, "required": ["id", "name", "subcategories"]}]}, "id": {"type": "number", "description": "Id of the slot"}}, "required": ["startTime", "id"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/41f1a423-cbbb-458d-847b-19e6564bb252/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
ContentReplacementSlotController_findAll
200
null
[{"name": "Slot A", "startTime": "2022-01-01T12:30:00Z", "endTime": "2022-01-01T12:32:00Z", "duration": 120, "replacement": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "categories": {"name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}], "id": 42}, "category": {"id": 42, "name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}]}, "id": 314}]
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the slot"}, "startTime": {"format": "date-time", "type": "string", "description": "Start time (format ISO 8601)"}, "endTime": {"format": "date-time", "type": "string", "description": "End time (format ISO 8601), mutually exclusive with duration"}, "duration": {"type": "number", "description": "Duration in seconds, mutually exclusive with endTime"}, "replacement": {"description": "Replacement source (if unspecified, default replacement is applied)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "categories": {"description": "Deprecated, use category instead", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the category"}, "subcategories": {"description": "Optional subcategories for the category", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}, "id": {"type": "number", "description": "Id of the Category"}}, "required": ["name", "subcategories", "id"]}]}, "category": {"description": "Optional category for the slot (if unspecified, the slot applies to all)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the Category"}, "name": {"type": "string", "description": "Name of the category for a slot"}, "subcategories": {"description": "Optional subcategories for the category attached to a slot", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}}, "required": ["id", "name", "subcategories"]}]}, "id": {"type": "number", "description": "Id of the slot"}}, "required": ["startTime", "id"]}}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/c8e8ef26-4841-410a-b110-e4677d7024f8/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
VirtualChannelController_create
201
null
{"name": "Service A", "environmentTags": [], "state": ["enabled", "paused"], "adBreakInsertion": {"adServer": {"id": 42, "name": "ad-server", "url": "https://example/server/ads", "queries": "Some queries specific to the ad server"}, "gapFiller": {"id": 42, "name": "ABC", "type": "asset", "url": "https://example/video/source"}}, "transcodingProfile": {"name": "Profile1", "content": "{\"field\": \"data\", ...}", "id": 42}, "serverSideAdTracking": {"enable": false, "checkAdMediaSegmentAvailability": false}, "enableAdTranscoding": false, "baseLive": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "id": 42, "url": "https://stream.broadpeak.io/79c43aeba9a4f451aad8e9be6dcada51/path/resource.mpd", "creationDate": "2021-08-23T13:35:47.955Z", "updateDate": "2022-02-22T22:22:22.955Z"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the service"}, "environmentTags": {"description": "Environment tags associated with the service (Deprecated)", "type": "array", "items": {"type": "string"}}, "state": {"type": "string", "description": "State of the service"}, "adBreakInsertion": {"description": "Configuration of ad-break insertion", "allOf": [{"type": "object", "properties": {"adServer": {"description": "Ad server", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the ad server"}, "name": {"type": "string", "description": "Name of the ad server"}, "url": {"type": "string", "description": "URL of the ad server"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server"}}, "required": ["id", "name", "url"]}]}, "gapFiller": {"description": "Asset or slate source used as a gap filler (if the ads are not long enough for the available ad slot)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source used as a gap filler"}, "name": {"type": "string", "description": "Name of the source used as a gap filler"}, "type": {"type": "string", "description": "Type of the source used as a gap filler"}, "url": {"type": "string", "description": "URL for the source used as a gap filler"}}, "required": ["id", "name", "type", "url"]}]}}, "required": ["adServer"]}]}, "transcodingProfile": {"description": "Transcoding profile", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the transcoding profile"}, "content": {"type": "string", "description": "Content of the profile in the JSON format"}, "id": {"type": "number", "description": "Id of the transcoding profile"}}, "required": ["name", "content", "id"]}]}, "serverSideAdTracking": {"description": "Server side ad tracking", "allOf": [{"type": "object", "properties": {"enable": {"type": "boolean", "description": "Enable server side ad tracking", "default": false}, "checkAdMediaSegmentAvailability": {"type": "boolean", "description": "Enable ad segments availability checks", "default": false}}}]}, "enableAdTranscoding": {"type": "boolean", "description": "Enable the transcoding of the ads", "default": false}, "baseLive": {"description": "Base live for the virtual channel", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "id": {"type": "number", "description": "Id of the virtual-channel service"}, "url": {"type": "string", "description": "URL of the virtual-channel service"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the virtual-channel service"}, "updateDate": {"format": "date-time", "type": "string", "description": "Update date of the virtual-channel service"}}, "required": ["name", "baseLive", "id", "url", "creationDate", "updateDate"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/23ad14b8-0551-4d27-bb96-b63c52f1dd45/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
TokensController_findAll
200
null
[{"name": "", "expirationDate": "", "creationDate": "2021-08-23T13:35:47.955Z", "suffix": "ycdJfd41"}]
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the token"}, "expirationDate": {"format": "date-time", "type": "string", "description": "Expiration date of the token"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the token"}, "suffix": {"type": "string", "description": "Last characters of the token"}}, "required": ["name", "expirationDate", "creationDate", "suffix"]}}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/9ff937b9-2925-40fa-a50b-70d40d2f20c5/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
SlatesController_update
200
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/media/content.jpg", "id": 42, "format": "JPEG"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the slate (must be a JPEG image or a MP4 video)"}, "id": {"type": "number", "description": "Id of the slate, assigned by broadpeak.io"}, "format": {"type": "string", "description": "Format of the slate (JPEG, MP4)"}}, "required": ["name", "url", "id", "format"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/4af40bcc-e5a7-46b2-b6a5-d7090e0a1e22/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
SlatesController_create
201
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/media/content.jpg", "id": 42, "format": "JPEG"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the slate (must be a JPEG image or a MP4 video)"}, "id": {"type": "number", "description": "Id of the slate, assigned by broadpeak.io"}, "format": {"type": "string", "description": "Format of the slate (JPEG, MP4)"}}, "required": ["name", "url", "id", "format"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/bfdea7b6-0a91-4a47-8635-7b2a8dc2a0ff/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
TokensController_create
201
null
{"name": "", "expirationDate": "", "creationDate": "2021-08-23T13:35:47.955Z", "token": "fd4132312"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the token"}, "expirationDate": {"format": "date-time", "type": "string", "description": "Expiration date of the token"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the token"}, "token": {"type": "string", "description": "The token (only returned when created)"}}, "required": ["name", "expirationDate", "creationDate", "token"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/2bded3b2-fe40-4eaa-aea8-03818c8288eb/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
SlatesController_get
200
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/media/content.jpg", "id": 42, "format": "JPEG"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the slate (must be a JPEG image or a MP4 video)"}, "id": {"type": "number", "description": "Id of the slate, assigned by broadpeak.io"}, "format": {"type": "string", "description": "Format of the slate (JPEG, MP4)"}}, "required": ["name", "url", "id", "format"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/29344ef0-524a-4bd0-8ee1-8b44b862e67c/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
ServicesController_findAll
200
null
[{"name": "Service A", "environmentTags": [], "state": ["enabled", "paused"], "id": 42, "type": ["ad-insertion", "content-replacement", "virtual-channel"], "url": "https://stream.broadpeak.io/68b329da9893e34099c7d8ad5cb9c940/path/resource.mpd", "creationDate": "2022-01-18T09:00:00.000Z", "updateDate": "2022-02-22T22:22:22.955Z"}]
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the service"}, "environmentTags": {"description": "Environment tags associated with the service (Deprecated)", "type": "array", "items": {"type": "string"}}, "state": {"type": "string", "description": "State of the service"}, "id": {"type": "number", "description": "Id of the service"}, "type": {"type": "string", "description": "Type of the service"}, "url": {"type": "string", "description": "URL of the service"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the service"}, "updateDate": {"format": "date-time", "type": "string", "description": "Update date of the service"}}, "required": ["name", "id", "type", "url", "creationDate", "updateDate"]}}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/96c8994c-3d46-4849-b79c-eab72fdd8ffb/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
UsersController_update
200
null
{"firstName": "John", "lastName": "Smith", "email": "[email protected]", "id": 42, "creationDate": "2023-01-02T03:04:05.000Z", "updateDate": "2023-01-03T04:05:06.000Z"}
{"type": "object", "properties": {"firstName": {"type": "string", "description": "First name of the user"}, "lastName": {"type": "string", "description": "Last name of the user"}, "email": {"type": "string", "description": "Email of the user"}, "id": {"type": "number", "description": "Id of the user"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the user"}, "updateDate": {"format": "date-time", "type": "string", "description": "Update date of the user"}}, "required": ["firstName", "lastName", "email", "id", "creationDate", "updateDate"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/3e74d271-d4e8-4f06-ad79-5e3a6478fb2d/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
UsersController_get
200
null
{"firstName": "John", "lastName": "Smith", "email": "[email protected]", "id": 42, "creationDate": "2023-01-02T03:04:05.000Z", "updateDate": "2023-01-03T04:05:06.000Z"}
{"type": "object", "properties": {"firstName": {"type": "string", "description": "First name of the user"}, "lastName": {"type": "string", "description": "Last name of the user"}, "email": {"type": "string", "description": "Email of the user"}, "id": {"type": "number", "description": "Id of the user"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the user"}, "updateDate": {"format": "date-time", "type": "string", "description": "Update date of the user"}}, "required": ["firstName", "lastName", "email", "id", "creationDate", "updateDate"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/533fd4d0-6aae-4147-8b31-691423a3374d/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
UsersController_findAll
200
null
[{"firstName": "John", "lastName": "Smith", "email": "[email protected]", "id": 42, "creationDate": "2023-01-02T03:04:05.000Z", "updateDate": "2023-01-03T04:05:06.000Z"}]
{"type": "array", "items": {"type": "object", "properties": {"firstName": {"type": "string", "description": "First name of the user"}, "lastName": {"type": "string", "description": "Last name of the user"}, "email": {"type": "string", "description": "Email of the user"}, "id": {"type": "number", "description": "Id of the user"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the user"}, "updateDate": {"format": "date-time", "type": "string", "description": "Update date of the user"}}, "required": ["firstName", "lastName", "email", "id", "creationDate", "updateDate"]}}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/6dfb9806-3023-4751-8850-fc23cdb9fb36/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
UsersController_invite
200
null
{"firstName": "John", "lastName": "Smith", "email": "[email protected]", "id": 42, "creationDate": "2023-01-02T03:04:05.000Z", "updateDate": "2023-01-03T04:05:06.000Z"}
{"type": "object", "properties": {"firstName": {"type": "string", "description": "First name of the user"}, "lastName": {"type": "string", "description": "Last name of the user"}, "email": {"type": "string", "description": "Email of the user"}, "id": {"type": "number", "description": "Id of the user"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the user"}, "updateDate": {"format": "date-time", "type": "string", "description": "Update date of the user"}}, "required": ["firstName", "lastName", "email", "id", "creationDate", "updateDate"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/a3afe4d0-b82a-44e3-9383-48f986b90944/2/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
LivesController_delete
204
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/media/content.m3u8", "backupIp": "9.9.9.9", "id": 42, "format": "DASH"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}, "backupIp": {"type": "string", "description": "(Optional) Backup IP of the source, only allowed when the source url is specified with an IP"}, "id": {"type": "number", "description": "Id of the source, assigned by broadpeak.io"}, "format": {"type": "string", "description": "Format of the source (DASH, HLS), based on provided URL"}}, "required": ["name", "url", "id", "format"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/d314fda6-1ccc-4f11-ab2e-4394c7576e83/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
LivesController_get
200
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/media/content.m3u8", "backupIp": "9.9.9.9", "id": 42, "format": "DASH"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}, "backupIp": {"type": "string", "description": "(Optional) Backup IP of the source, only allowed when the source url is specified with an IP"}, "id": {"type": "number", "description": "Id of the source, assigned by broadpeak.io"}, "format": {"type": "string", "description": "Format of the source (DASH, HLS), based on provided URL"}}, "required": ["name", "url", "id", "format"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/f39389a0-5665-4e37-9b69-8e848010f886/2/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
LivesController_create
201
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/media/content.m3u8", "backupIp": "9.9.9.9", "id": 42, "format": "DASH"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}, "backupIp": {"type": "string", "description": "(Optional) Backup IP of the source, only allowed when the source url is specified with an IP"}, "id": {"type": "number", "description": "Id of the source, assigned by broadpeak.io"}, "format": {"type": "string", "description": "Format of the source (DASH, HLS), based on provided URL"}}, "required": ["name", "url", "id", "format"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/30d4029d-086b-405f-8c8c-f5e48d4bb23e/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
ContentReplacementController_getById
200
null
{"name": "Service A", "environmentTags": [], "state": ["enabled", "paused"], "replacement": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "source": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "id": 42, "url": "https://stream.broadpeak.io/68b329da9893e34099c7d8ad5cb9c940/path/resource.mpd", "creationDate": "2021-08-23T13:35:47.955Z", "updateDate": "2022-02-22T22:22:22.955Z"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the service"}, "environmentTags": {"description": "Environment tags associated with the service (Deprecated)", "type": "array", "items": {"type": "string"}}, "state": {"type": "string", "description": "State of the service"}, "replacement": {"description": "Replacement source", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "source": {"description": "Origin source", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "id": {"type": "number", "description": "Id of the content-replacement service"}, "url": {"type": "string", "description": "URL of the content-replacement service"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the content-replacement service"}, "updateDate": {"format": "date-time", "type": "string", "description": "Update date of the content-replacement service"}}, "required": ["name", "replacement", "source", "id", "url", "creationDate", "updateDate"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/9bc6d6e4-5f97-403f-bca7-ce7ee4347acb/2/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
ContentReplacementController_update
200
null
{"name": "Service A", "environmentTags": [], "state": ["enabled", "paused"], "replacement": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "source": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "id": 42, "url": "https://stream.broadpeak.io/68b329da9893e34099c7d8ad5cb9c940/path/resource.mpd", "creationDate": "2021-08-23T13:35:47.955Z", "updateDate": "2022-02-22T22:22:22.955Z"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the service"}, "environmentTags": {"description": "Environment tags associated with the service (Deprecated)", "type": "array", "items": {"type": "string"}}, "state": {"type": "string", "description": "State of the service"}, "replacement": {"description": "Replacement source", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "source": {"description": "Origin source", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "id": {"type": "number", "description": "Id of the content-replacement service"}, "url": {"type": "string", "description": "URL of the content-replacement service"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the content-replacement service"}, "updateDate": {"format": "date-time", "type": "string", "description": "Update date of the content-replacement service"}}, "required": ["name", "replacement", "source", "id", "url", "creationDate", "updateDate"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/bc596db9-17c6-4226-b5da-e890056eeaad/2/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
LivesController_update
200
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/media/content.m3u8", "backupIp": "9.9.9.9", "id": 42, "format": "DASH"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}, "backupIp": {"type": "string", "description": "(Optional) Backup IP of the source, only allowed when the source url is specified with an IP"}, "id": {"type": "number", "description": "Id of the source, assigned by broadpeak.io"}, "format": {"type": "string", "description": "Format of the source (DASH, HLS), based on provided URL"}}, "required": ["name", "url", "id", "format"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/9eb4684f-723a-43f8-b9f1-d2cb2d4d5aba/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
ContentReplacementController_create
201
null
{"name": "Service A", "environmentTags": [], "state": ["enabled", "paused"], "replacement": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "source": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "id": 42, "url": "https://stream.broadpeak.io/68b329da9893e34099c7d8ad5cb9c940/path/resource.mpd", "creationDate": "2021-08-23T13:35:47.955Z", "updateDate": "2022-02-22T22:22:22.955Z"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the service"}, "environmentTags": {"description": "Environment tags associated with the service (Deprecated)", "type": "array", "items": {"type": "string"}}, "state": {"type": "string", "description": "State of the service"}, "replacement": {"description": "Replacement source", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "source": {"description": "Origin source", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "id": {"type": "number", "description": "Id of the content-replacement service"}, "url": {"type": "string", "description": "URL of the content-replacement service"}, "creationDate": {"format": "date-time", "type": "string", "description": "Creation date of the content-replacement service"}, "updateDate": {"format": "date-time", "type": "string", "description": "Update date of the content-replacement service"}}, "required": ["name", "replacement", "source", "id", "url", "creationDate", "updateDate"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/f9225946-fb13-4054-b50c-2d4ba4e38234/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
SamplesController_create
201
null
[{"name": "Live pre-roll sample (DASH)", "type": "live", "status": ["CREATED", "ALREADY_EXISTS", "FAILED"], "reason": "Cannot create a source with a duplicate name and URL", "url": "https://origin.broadpeak.io/bpk-tv/bpkiofficial/default/index.mpd"}]
{"type": "array", "items": {"oneOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the sample"}, "type": {"type": "string", "description": "Type of the sample"}, "status": {"type": "string", "description": "Status of the sample"}, "reason": {"type": "string", "description": "Reason if the sample creation failed"}, "url": {"type": "string", "description": "Url of the sample"}}, "required": ["name", "type", "status", "reason", "url"]}, {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the sample"}, "type": {"type": "string", "description": "Type of the sample"}, "status": {"type": "string", "description": "Status of the sample"}, "reason": {"type": "string", "description": "Reason if the sample creation failed"}, "url": {"type": "string", "description": "Url of the sample"}, "assetSample": {"type": "string", "description": "Relative path of an asset from the asset catalog url"}}, "required": ["name", "type", "status", "reason", "url", "assetSample"]}, {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the sample"}, "type": {"type": "string", "description": "Type of the sample"}, "status": {"type": "string", "description": "Status of the sample"}, "reason": {"type": "string", "description": "Reason if the sample creation failed"}, "content": {"type": "string", "description": "Content of the sample"}}, "required": ["name", "type", "status", "reason", "content"]}]}}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/3c094e5f-4206-43fe-8565-d59a479c8723/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AdServersController_get
200
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/adsapi", "queries": "max_pod_duration=$_MMVAR_LIVEAR_SLOTDURATION&cb=$MMVAR_CACHE_BUSTER&ip=$MAP_REMOTE_ADDR", "template": "custom", "id": 42}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the ad server source, required when \"template\" is custom"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server source. See https://developers.broadpeak.io/docs/ad-macros"}, "template": {"type": "string", "description": "(Optional) Template of the ad server (ad-proxy-vmap-generator, custom). See https://developers.broadpeak.io/docs/ad-proxy"}, "id": {"type": "number", "description": "Id of the ad server source, assigned by broadpeak.io"}}, "required": ["name", "id"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/0bb04abe-d090-4076-9b26-6a08177c092b/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
VirtualChannelSlotController_findAll
200
null
[{"name": "Slot A", "startTime": "2022-01-01T12:30:00Z", "endTime": "2022-01-01T12:32:00Z", "duration": 120, "replacement": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "categories": {"name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}], "id": 42}, "category": {"id": 42}, "type": "content"}]
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the slot"}, "startTime": {"format": "date-time", "type": "string", "description": "Start time (format ISO 8601)"}, "endTime": {"format": "date-time", "type": "string", "description": "End time (format ISO 8601), mutually exclusive with duration"}, "duration": {"type": "number", "description": "Duration in seconds, mutually exclusive with endTime"}, "replacement": {"description": "Replacement content for virtual channel slot", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "categories": {"description": "Deprecated, use category instead", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the category"}, "subcategories": {"description": "Optional subcategories for the category", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}, "id": {"type": "number", "description": "Id of the Category"}}, "required": ["name", "subcategories", "id"]}]}, "category": {"description": "Optional category for the slot (if unspecified, the slot applies to all)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the Category"}}, "required": ["id"]}]}, "type": {"type": "string", "description": "Type of the slot (content, ad-break)"}}, "required": ["startTime"]}}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/433a5c0c-2aec-4e3e-90c6-813d6945f025/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
VirtualChannelSlotController_getById
200
null
{"name": "Slot A", "startTime": "2022-01-01T12:30:00Z", "endTime": "2022-01-01T12:32:00Z", "duration": 120, "replacement": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "categories": {"name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}], "id": 42}, "category": {"id": 42}, "type": "content"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the slot"}, "startTime": {"format": "date-time", "type": "string", "description": "Start time (format ISO 8601)"}, "endTime": {"format": "date-time", "type": "string", "description": "End time (format ISO 8601), mutually exclusive with duration"}, "duration": {"type": "number", "description": "Duration in seconds, mutually exclusive with endTime"}, "replacement": {"description": "Replacement content for virtual channel slot", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "categories": {"description": "Deprecated, use category instead", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the category"}, "subcategories": {"description": "Optional subcategories for the category", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}, "id": {"type": "number", "description": "Id of the Category"}}, "required": ["name", "subcategories", "id"]}]}, "category": {"description": "Optional category for the slot (if unspecified, the slot applies to all)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the Category"}}, "required": ["id"]}]}, "type": {"type": "string", "description": "Type of the slot (content, ad-break)"}}, "required": ["startTime"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/150b2053-76c7-4bb0-80ec-0836e23725c9/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AdServersController_update
200
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/adsapi", "queries": "max_pod_duration=$_MMVAR_LIVEAR_SLOTDURATION&cb=$MMVAR_CACHE_BUSTER&ip=$MAP_REMOTE_ADDR", "template": "custom", "id": 42}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the ad server source, required when \"template\" is custom"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server source. See https://developers.broadpeak.io/docs/ad-macros"}, "template": {"type": "string", "description": "(Optional) Template of the ad server (ad-proxy-vmap-generator, custom). See https://developers.broadpeak.io/docs/ad-proxy"}, "id": {"type": "number", "description": "Id of the ad server source, assigned by broadpeak.io"}}, "required": ["name", "id"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/2c35ba5a-51c0-4c5d-ab61-993341790ebc/2/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AdServersController_create
201
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/adsapi", "queries": "max_pod_duration=$_MMVAR_LIVEAR_SLOTDURATION&cb=$MMVAR_CACHE_BUSTER&ip=$MAP_REMOTE_ADDR", "template": "custom", "id": 42}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the ad server source, required when \"template\" is custom"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server source. See https://developers.broadpeak.io/docs/ad-macros"}, "template": {"type": "string", "description": "(Optional) Template of the ad server (ad-proxy-vmap-generator, custom). See https://developers.broadpeak.io/docs/ad-proxy"}, "id": {"type": "number", "description": "Id of the ad server source, assigned by broadpeak.io"}}, "required": ["name", "id"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/c5affda5-3bf0-47ee-a095-4cf2f4533f3a/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
VirtualChannelSlotController_create
201
null
{"name": "Slot A", "startTime": "2022-01-01T12:30:00Z", "endTime": "2022-01-01T12:32:00Z", "duration": 120, "replacement": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "categories": {"name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}], "id": 42}, "category": {"id": 42}, "type": "content"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the slot"}, "startTime": {"format": "date-time", "type": "string", "description": "Start time (format ISO 8601)"}, "endTime": {"format": "date-time", "type": "string", "description": "End time (format ISO 8601), mutually exclusive with duration"}, "duration": {"type": "number", "description": "Duration in seconds, mutually exclusive with endTime"}, "replacement": {"description": "Replacement content for virtual channel slot", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "categories": {"description": "Deprecated, use category instead", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the category"}, "subcategories": {"description": "Optional subcategories for the category", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}, "id": {"type": "number", "description": "Id of the Category"}}, "required": ["name", "subcategories", "id"]}]}, "category": {"description": "Optional category for the slot (if unspecified, the slot applies to all)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the Category"}}, "required": ["id"]}]}, "type": {"type": "string", "description": "Type of the slot (content, ad-break)"}}, "required": ["startTime"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/cbbf8c17-739c-4f95-bd56-37250952f8fc/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
VirtualChannelSlotController_update
200
null
{"name": "Slot A", "startTime": "2022-01-01T12:30:00Z", "endTime": "2022-01-01T12:32:00Z", "duration": 120, "replacement": {"id": 42, "name": "ABC", "type": "live", "url": "https://example/media/content.m3u8"}, "categories": {"name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}], "id": 42}, "category": {"id": 42}, "type": "content"}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the slot"}, "startTime": {"format": "date-time", "type": "string", "description": "Start time (format ISO 8601)"}, "endTime": {"format": "date-time", "type": "string", "description": "End time (format ISO 8601), mutually exclusive with duration"}, "duration": {"type": "number", "description": "Duration in seconds, mutually exclusive with endTime"}, "replacement": {"description": "Replacement content for virtual channel slot", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source"}, "url": {"type": "string", "description": "URL of the source (HLS or DASH)"}}, "required": ["id", "name", "type", "url"]}]}, "categories": {"description": "Deprecated, use category instead", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the category"}, "subcategories": {"description": "Optional subcategories for the category", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}, "id": {"type": "number", "description": "Id of the Category"}}, "required": ["name", "subcategories", "id"]}]}, "category": {"description": "Optional category for the slot (if unspecified, the slot applies to all)", "allOf": [{"type": "object", "properties": {"id": {"type": "number", "description": "Id of the Category"}}, "required": ["id"]}]}, "type": {"type": "string", "description": "Type of the slot (content, ad-break)"}}, "required": ["startTime"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/58e87c04-f68a-4196-847b-46de7531fdad/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
AdServersController_delete
204
null
{"name": "ABC", "description": "A description of the source", "url": "https://example/adsapi", "queries": "max_pod_duration=$_MMVAR_LIVEAR_SLOTDURATION&cb=$MMVAR_CACHE_BUSTER&ip=$MAP_REMOTE_ADDR", "template": "custom", "id": 42}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the source"}, "description": {"type": "string", "description": "(Optional) Description of the source"}, "url": {"type": "string", "description": "URL of the ad server source, required when \"template\" is custom"}, "queries": {"type": "string", "description": "(Optional) Queries of the ad server source. See https://developers.broadpeak.io/docs/ad-macros"}, "template": {"type": "string", "description": "(Optional) Template of the ad server (ad-proxy-vmap-generator, custom). See https://developers.broadpeak.io/docs/ad-proxy"}, "id": {"type": "number", "description": "Id of the ad server source, assigned by broadpeak.io"}}, "required": ["name", "id"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/bfa9cef5-c5bf-42f4-916b-068579ea47c8/2/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
UrlStatusSourceController_checkSource
200
null
[{"messageText": "Status Ok", "severityLevel": "info"}]
{"type": "array", "items": {"type": "object", "properties": {"messageText": {"type": "string", "description": "Source analysis message"}, "severityLevel": {"type": "string", "description": "Severity level of the message"}}, "required": ["messageText", "severityLevel"]}}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/a79cea8c-ae96-460e-9144-cc8231ff1a36/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
SourcesController_findAll
200
null
[{"id": 42, "name": "live-A", "type": "live", "url": "https://example/media/content.m3u8", "format": "DASH"}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "number", "description": "Id of the source, assigned by broadpeak.io"}, "name": {"type": "string", "description": "Name of the source"}, "type": {"type": "string", "description": "Type of the source (live, asset, ad-server...)"}, "url": {"type": "string", "description": "URL of the source"}, "format": {"type": "string", "description": "Format of the source (DASH, HLS), based on provided URL. Only applicable to live and asset sources."}}, "required": ["id", "name", "type", "url"]}}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/c5d08161-2efa-46e6-8a68-2ff3f36fdd19/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
CategoryController_findAll
200
null
[{"name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}], "id": 42}]
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the category"}, "subcategories": {"description": "Optional subcategories for the category", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}, "id": {"type": "number", "description": "Id of the Category"}}, "required": ["name", "subcategories", "id"]}}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/76fe2a80-fe68-4300-93d3-7aa8d0d7838f/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
CategoryController_getById
200
null
{"name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}], "id": 42}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the category"}, "subcategories": {"description": "Optional subcategories for the category", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}, "id": {"type": "number", "description": "Id of the Category"}}, "required": ["name", "subcategories", "id"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/7354f741-e5e9-4066-8203-ba1ea3be2484/0/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
CategoryController_update
200
null
{"name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}], "id": 42}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the category"}, "subcategories": {"description": "Optional subcategories for the category", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}, "id": {"type": "number", "description": "Id of the Category"}}, "required": ["name", "subcategories", "id"]}
dbf13c74-3f91-41d3-bfab-4e3dab761e78/e23a1605-2227-4af1-982b-00185d7c2047/1/0
broadpeak.io
APIs to manipulate HLS or DASH ABR feeds for Dynamic Ad Insertion, Content Replacement and VOD2Live.
null
CategoryController_create
201
null
{"name": "Nevada", "subcategories": [{"key": "zip", "value": "35000"}], "id": 42}
{"type": "object", "properties": {"name": {"type": "string", "description": "Name of the category"}, "subcategories": {"description": "Optional subcategories for the category", "type": "array", "items": {"type": "object", "properties": {"key": {"type": "string", "description": "Key for the subcategory, can only be zip for now"}, "value": {"type": "string", "description": "Value for the subcategory"}}, "required": ["key", "value"]}}, "id": {"type": "number", "description": "Id of the Category"}}, "required": ["name", "subcategories", "id"]}
c0657a6e-460f-4392-bff3-95ae95f720e5/3b3881f8-3458-4d14-921a-cab7d5917cad/0/0
TikTok
its an api for shares
7.8
tikapi
test
240
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
56e678e5-a15c-4ef6-8b06-190f4abf17f2/619045c8-95e0-470b-8843-8a358bda2867/0/0
Abyssale
Auto-generate on-brand images at scale
null
Generate images from your templates
Automatically generate on-brand images at scale from your Abyssale templates.
200
Successful generation
{"banner": {"id": "/797a854f-5b94-421d-a9d6-c3270d47650a"}, "image": {"type": "png", "url": "https://public-url.com/banner-id.png"}}
{"properties": {"banner": {"properties": {"id": {"type": "string"}}, "type": "object"}, "image": {"properties": {"type": {"type": "string"}, "url": {"type": "string"}}, "type": "object"}}, "type": "object"}
39bc4281-f5b1-4bab-a17b-d7c0779d429a/00c92f68-4061-4d16-8172-926a3384dcbd/0/0
Image Functions 1001 APIs FX
Introducing our comprehensive 1001fx-APIs & ImageFunctions collection, a powerful suite of image manipulation tools designed to enhance your website's visual appeal and optimize your content for search engines. This collection includes a wide range of functionalities such as extracting EXIF data, applying various image transformations like blurring, sharpening, flipping, cropping, and resizing, as well as advanced image conversion and overlay capabilities. Easily access our collection using ...
null
Blur Image
Blur Image
200
Response
{"url": "https://files.1saas.co/3ebc6376d55267d35053e54433cdf2910812df82/c64efc9adaedbf446f328698e8b67388.jpg"}
{"type": "object", "properties": {"url": {"type": "string"}, "sigma": {"type": "integer"}, "getAsUrl": {"type": "boolean"}}}
39bc4281-f5b1-4bab-a17b-d7c0779d429a/7dcaedbb-534d-45a8-90a3-e597422d6f0f/0/0
Image Functions 1001 APIs FX
Introducing our comprehensive 1001fx-APIs & ImageFunctions collection, a powerful suite of image manipulation tools designed to enhance your website's visual appeal and optimize your content for search engines. This collection includes a wide range of functionalities such as extracting EXIF data, applying various image transformations like blurring, sharpening, flipping, cropping, and resizing, as well as advanced image conversion and overlay capabilities. Easily access our collection using ...
null
Sharpen Image
Sharpen Image
200
Response
{"url": "https://files.1saas.co/3ebc6376d55267d35053e54433cdf2910812df82/c64efc9adaedbf446f328698e8b67388.jpg"}
{"type": "object", "properties": {"url": {"type": "string"}}}
39bc4281-f5b1-4bab-a17b-d7c0779d429a/6a419438-73b3-421c-a022-fb3a18433a62/0/0
Image Functions 1001 APIs FX
Introducing our comprehensive 1001fx-APIs & ImageFunctions collection, a powerful suite of image manipulation tools designed to enhance your website's visual appeal and optimize your content for search engines. This collection includes a wide range of functionalities such as extracting EXIF data, applying various image transformations like blurring, sharpening, flipping, cropping, and resizing, as well as advanced image conversion and overlay capabilities. Easily access our collection using ...
null
Resize Image
Resize Image
200
Response
{"url": "https://files.1saas.co/3ebc6376d55267d35053e54433cdf2910812df82/c64efc9adaedbf446f328698e8b67388.jpg"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"url": {"type": "string"}}, "required": ["url"]}
39bc4281-f5b1-4bab-a17b-d7c0779d429a/3f238113-f7cd-4cb8-8a45-c45420d57e1f/0/0
Image Functions 1001 APIs FX
Introducing our comprehensive 1001fx-APIs & ImageFunctions collection, a powerful suite of image manipulation tools designed to enhance your website's visual appeal and optimize your content for search engines. This collection includes a wide range of functionalities such as extracting EXIF data, applying various image transformations like blurring, sharpening, flipping, cropping, and resizing, as well as advanced image conversion and overlay capabilities. Easily access our collection using ...
null
FlipImageAxis
Flip the image axis by x or y
200
Response
{"url": "https://files.1saas.co/3ebc6376d55267d35053e54433cdf2910812df82/c64efc9adaedbf446f328698e8b67388.jpg"}
{"type": "object", "properties": {"url": {"type": "string"}}}
39bc4281-f5b1-4bab-a17b-d7c0779d429a/e43de9bf-6d16-40c9-93ae-2dd3885b3908/0/0
Image Functions 1001 APIs FX
Introducing our comprehensive 1001fx-APIs & ImageFunctions collection, a powerful suite of image manipulation tools designed to enhance your website's visual appeal and optimize your content for search engines. This collection includes a wide range of functionalities such as extracting EXIF data, applying various image transformations like blurring, sharpening, flipping, cropping, and resizing, as well as advanced image conversion and overlay capabilities. Easily access our collection using ...
null
Crop Image
This endpoint can be used to crop images. The image can be passed as a URL or Buffer. To receive the response in a URL, the getAsUrl attribute has to be set to true. The options attribute takes an object specifying height and width of the final image, and top and left coordinates where the cropping should start. Image in the example request: Image in the example response:
200
Example_1
{"url": "https://i.pinimg.com/originals/c6/4e/fc/c64efc9adaedbf446f328698e8b67388.jpg", "options": {"left": 20, "top": 50, "width": 500, "height": 500}, "getAsUrl": true}
{"type": "object", "properties": {"url": {"type": "string"}, "options": {"type": "object", "properties": {"left": {"type": "integer"}, "top": {"type": "integer"}, "width": {"type": "integer"}, "height": {"type": "integer"}}}, "getAsUrl": {"type": "boolean"}}}
39bc4281-f5b1-4bab-a17b-d7c0779d429a/9bef8b78-cef3-43d3-9062-fbcf9dc108f5/0/0
Image Functions 1001 APIs FX
Introducing our comprehensive 1001fx-APIs & ImageFunctions collection, a powerful suite of image manipulation tools designed to enhance your website's visual appeal and optimize your content for search engines. This collection includes a wide range of functionalities such as extracting EXIF data, applying various image transformations like blurring, sharpening, flipping, cropping, and resizing, as well as advanced image conversion and overlay capabilities. Easily access our collection using ...
null
Rotate Image
Rotates the given image
200
Response
{"url": "https://files.1saas.co/3ebc6376d55267d35053e54433cdf2910812df82/c64efc9adaedbf446f328698e8b67388.jpg"}
{"type": "object", "properties": {"url": {"type": "string"}}}
39bc4281-f5b1-4bab-a17b-d7c0779d429a/013afa73-8e52-444b-a448-19b6e1151276/0/0
Image Functions 1001 APIs FX
Introducing our comprehensive 1001fx-APIs & ImageFunctions collection, a powerful suite of image manipulation tools designed to enhance your website's visual appeal and optimize your content for search engines. This collection includes a wide range of functionalities such as extracting EXIF data, applying various image transformations like blurring, sharpening, flipping, cropping, and resizing, as well as advanced image conversion and overlay capabilities. Easily access our collection using ...
null
Convert Image
Convert Image
200
Example_1
{"url": "https://pngimg.com/uploads/gorilla/gorilla_PNG18712.png", "outputFormat": "webp", "options": {"quality": 40}, "getAsUrl": true}
{"type": "object", "properties": {"url": {"type": "string"}, "outputFormat": {"type": "string"}, "options": {"type": "object", "properties": {"quality": {"type": "integer"}}}, "getAsUrl": {"type": "boolean"}}}
61cb7017-6021-4b39-9fcc-00f8da804248/dc6563b6-3264-49c1-b3c4-f3da99300df8/0/0
Moovly Automator
An API to easily automate video creation via the Moovly Automator.
0
Get templates
Get a list of available templates
200
200
[{"category": null, "clips": [{"id": "843010b0cd3a28a6c027", "name": "Facebook scene "}, {"id": "f8215e7b280a28d8ee2c", "name": "Find us on Facebook"}, {"id": "06b5cef1acbf28b51e48", "name": "text"}], "duration": 10.79, "id": "310e10ef-fd53-11e8-a17f-0a3aae3eefbc", "name": "Facebook Status", "original_project_id": "0wJjEMyd6118zvv6lGzLaBWr", "preview": "https://renders.moovly.com/moov0b48b8c5-fd57-11e8-a17f-0a3aae3eefbc74909video.mp4", "public": true, "tags": ["Marketing", "Announcement", "Social Media"], "thumb": "https://assets.moovly.com/converted/images/thumb_b927a79e7949dbbd9108b35cda1484c6.png", "variables": [{"clip_id": "843010b0cd3a28a6c027", "default": "https://assets.moovly.com/converted/video/video-render_9c768265-d227-4b7a-866b-2ec16e2bb55d-05af6b60-fd9e-11e7-bb81-0a36b0bef4d6-1080p.mp4", "id": "1079cb58-01f2-11e9-a17f-0a3aae3eefbc", "name": "Upload a background clip", "requirements": {"height": 462, "maximum_duration": 7.59, "minimum_duration": 7.59, "width": 854}, "type": "video", "weight": 2}, {"clip_id": "f8215e7b280a28d8ee2c", "default": "https://assets.moovly.com/converted/images/sprite_d5de775179162e71bf4a2d6cbff46c87.png", "id": "1079e173-01f2-11e9-a17f-0a3aae3eefbc", "name": "Add your logo", "requirements": {"height": 248, "width": 797}, "type": "image", "weight": 3}, {"clip_id": "06b5cef1acbf28b51e48", "default": "TEAM UPDATE DAY 1: MARCHING ON TO NEW HEIGHTS", "id": "1079f589-01f2-11e9-a17f-0a3aae3eefbc", "name": "Add a status update", "requirements": {"maximum_length": 50, "minimum_length": 1, "multiline": true}, "type": "text", "weight": 1}]}]
{"items": {"type": "object"}, "type": "array"}
61cb7017-6021-4b39-9fcc-00f8da804248/0a33e09c-da29-42de-bb44-d603db488ba1/0/0
Moovly Automator
An API to easily automate video creation via the Moovly Automator.
0
Get a template by id
Get more information on a particular template. With this information, you'll be able to create a Job. A Job will create the actual MP4 file with your data. Refer to the Job documentation for more information.
403
403
{"message": "Access Denied."}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"message": {"type": "string"}}, "required": ["message"]}
61cb7017-6021-4b39-9fcc-00f8da804248/0a33e09c-da29-42de-bb44-d603db488ba1/1/0
Moovly Automator
An API to easily automate video creation via the Moovly Automator.
0
Get a template by id
Get more information on a particular template. With this information, you'll be able to create a Job. A Job will create the actual MP4 file with your data. Refer to the Job documentation for more information.
404
404
{"message": "Template not found"}
{"properties": {"message": {"type": "string"}}, "type": "object"}
61cb7017-6021-4b39-9fcc-00f8da804248/0a33e09c-da29-42de-bb44-d603db488ba1/2/0
Moovly Automator
An API to easily automate video creation via the Moovly Automator.
0
Get a template by id
Get more information on a particular template. With this information, you'll be able to create a Job. A Job will create the actual MP4 file with your data. Refer to the Job documentation for more information.
200
200
{"category": null, "clips": [{"id": "843010b0cd3a28a6c027", "name": "Facebook scene "}, {"id": "f8215e7b280a28d8ee2c", "name": "Find us on Facebook"}, {"id": "06b5cef1acbf28b51e48", "name": "text"}], "duration": 10.79, "id": "310e10ef-fd53-11e8-a17f-0a3aae3eefbc", "name": "Facebook Status", "original_project_id": "0wJjEMyd6118zvv6lGzLaBWr", "preview": "https://renders.moovly.com/moov0b48b8c5-fd57-11e8-a17f-0a3aae3eefbc74909video.mp4", "public": true, "tags": ["Marketing", "Announcement", "Social Media"], "thumb": "https://assets.moovly.com/converted/images/thumb_b927a79e7949dbbd9108b35cda1484c6.png", "variables": [{"clip_id": "843010b0cd3a28a6c027", "default": "https://assets.moovly.com/converted/video/video-render_9c768265-d227-4b7a-866b-2ec16e2bb55d-05af6b60-fd9e-11e7-bb81-0a36b0bef4d6-1080p.mp4", "id": "1079cb58-01f2-11e9-a17f-0a3aae3eefbc", "name": "Upload a background clip", "requirements": {"height": 462, "maximum_duration": 7.59, "minimum_duration": 7.59, "width": 854}, "type": "video", "weight": 2}, {"clip_id": "f8215e7b280a28d8ee2c", "default": "https://assets.moovly.com/converted/images/sprite_d5de775179162e71bf4a2d6cbff46c87.png", "id": "1079e173-01f2-11e9-a17f-0a3aae3eefbc", "name": "Add your logo", "requirements": {"height": 248, "width": 797}, "type": "image", "weight": 3}, {"clip_id": "06b5cef1acbf28b51e48", "default": "TEAM UPDATE DAY 1: MARCHING ON TO NEW HEIGHTS", "id": "1079f589-01f2-11e9-a17f-0a3aae3eefbc", "name": "Add a status update", "requirements": {"maximum_length": 50, "minimum_length": 1, "multiline": true}, "type": "text", "weight": 1}]}
{"properties": {"category": {"type": "null"}, "clips": {"items": {"properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "type": "object"}, "type": "array"}, "duration": {"type": "number"}, "id": {"type": "string"}, "name": {"type": "string"}, "original_project_id": {"type": "string"}, "preview": {"type": "string"}, "public": {"type": "boolean"}, "tags": {"items": {"type": "string"}, "type": "array"}, "thumb": {"type": "string"}, "variables": {"items": {"properties": {"clip_id": {"type": "string"}, "default": {"type": "string"}, "id": {"type": "string"}, "name": {"type": "string"}, "requirements": {"type": "object"}, "type": {"type": "string"}, "weight": {"type": "integer"}}, "type": "object"}, "type": "array"}}, "type": "object"}
eb0974e7-d8df-43be-af2e-6fd546cc8148/609f7dfc-1be8-42bb-beaf-957715f29027/0/0
Free AI Smart Enhance Image Color
Free AI Smart Enhance Image Color
null
/enhance-image-color
200
null
{"status": 1, "url": "http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/generative-cartoon/2023-09-09/1d73851a-7d53-416b-8606-01dc2f09db52/20230909_235408006889_dmbpxu56o3.jpg?Expires=1694276651&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRpDvh1&Signature=%2FcT4QU5F7%2FIR2J9Z9a3lvUnwdbI%3D"}
{"type": "object", "properties": {"status": {"type": "integer"}, "url": {"type": "string"}}, "required": ["status", "url"], "x-apifox-ignore-properties": [], "x-apifox-orders": ["status", "url"]}
29102921-4f08-43d3-8aac-092db80affd4/4ef08132-4839-49e8-88ff-d9661ccae8c1/0/0
GIF Overlay
A Flask application that overlays a PNG image on top of an animated GIF image. Given the URLs of an animated GIF and a PNG image, the application resizes the PNG image to 250x250, calculates the x and y coordinates to place the PNG image in the center of the GIF image, iterates through the frames of the GIF image, pastes the PNG image on top of each frame, appends the new frame to a list, and returns the final image as an animated GIF using the first frame as the starting point and appending ...
0
Overlay PNG on GIF
This endpoint allows you to overlay a PNG image on top of a GIF image. The PNG image will be resized to 250x250 and placed in the center of the GIF. The resulting image will be returned as an animated GIF. Accepts image files in gif and png formats. Required headers include 'Content-Type' and 'Content-Disposition'. It returns the final image as an animated gi
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
995ddf28-da22-4aa7-97b7-dcc0e903cd58/b2e82aee-4d08-4c23-8912-045287afbc35/0/0
AI Composition
By evaluating the aesthetics of the input image, the bounding box is intelligently output, and according to these bounding boxes the original image can be cropped into a better image.
null
AI Composition
AI Composition
401
Example
{"message": "Invalid API key in request"}
{"type": "object", "properties": {"message": {"type": "string", "required": true, "example": "Invalid API key in request", "description": "Error Message."}}}
995ddf28-da22-4aa7-97b7-dcc0e903cd58/b2e82aee-4d08-4c23-8912-045287afbc35/1/0
AI Composition
By evaluating the aesthetics of the input image, the bounding box is intelligently output, and according to these bounding boxes the original image can be cropped into a better image.
null
AI Composition
AI Composition
200
Success
{"request_id": "3A9BFC5E-3F7C-4D9A-9445-908C6D14AB5B", "log_id": "3A9BFC5E-3F7C-4D9A-9445-908C6D14AB5B", "error_code": 0, "data": {"elements": [{"min_x": 50, "max_x": 100, "min_y": 10, "max_y": 100, "score": 3.8}]}}
{"request_id": {"type": "string", "required": false, "description": "Request ID."}, "log_id": {"type": "string", "required": false, "description": "Log ID."}, "error_code": {"type": "integer", "required": false, "description": "Error Code."}, "error_code_str": {"type": "string", "required": false, "description": "Error Code."}, "error_msg": {"type": "string", "required": false, "description": "Error Message."}, "data": {"type": "object", "required": false, "description": "The content of the result data returned.", "properties": {"elements": {"type": "array", "required": true, "properties": {"min_x": {"type": "integer", "required": true, "description": "The abscissa of the upper left corner of the output box."}, "max_x": {"type": "integer", "required": true, "description": "The abscissa of the lower right corner of the output box."}, "min_y": {"type": "integer", "required": true, "description": "The ordinate of the upper left corner of the output box."}, "max_y": {"type": "integer", "required": true, "description": "The vertical coordinate of the lower right corner of the output box."}, "score": {"type": "double", "required": true, "description": "The score of the output box, ranging from 0 to 5. The higher the score, the better the composition effect, and a better composition score is recommended above 3.8."}}}}}}
995ddf28-da22-4aa7-97b7-dcc0e903cd58/b2e82aee-4d08-4c23-8912-045287afbc35/1/1
AI Composition
By evaluating the aesthetics of the input image, the bounding box is intelligently output, and according to these bounding boxes the original image can be cropped into a better image.
null
AI Composition
AI Composition
200
Error
{"request_id": "3A9BFC5E-3F7C-4D9A-9445-908C6D14AB5B", "log_id": "3A9BFC5E-3F7C-4D9A-9445-908C6D14AB5B", "error_code": 400, "error_code_str": "ERROR_PARAMETERS", "error_msg": "image cannot be empty"}
{"request_id": {"type": "string", "required": false, "description": "Request ID."}, "log_id": {"type": "string", "required": false, "description": "Log ID."}, "error_code": {"type": "integer", "required": false, "description": "Error Code."}, "error_code_str": {"type": "string", "required": false, "description": "Error Code."}, "error_msg": {"type": "string", "required": false, "description": "Error Message."}, "data": {"type": "object", "required": false, "description": "The content of the result data returned.", "properties": {"elements": {"type": "array", "required": true, "properties": {"min_x": {"type": "integer", "required": true, "description": "The abscissa of the upper left corner of the output box."}, "max_x": {"type": "integer", "required": true, "description": "The abscissa of the lower right corner of the output box."}, "min_y": {"type": "integer", "required": true, "description": "The ordinate of the upper left corner of the output box."}, "max_y": {"type": "integer", "required": true, "description": "The vertical coordinate of the lower right corner of the output box."}, "score": {"type": "double", "required": true, "description": "The score of the output box, ranging from 0 to 5. The higher the score, the better the composition effect, and a better composition score is recommended above 3.8."}}}}}}
009a1a6f-1a1a-4929-a1a5-7b6fa3633ba2/e8e90d77-dab7-489f-96ce-e6bd03294057/0/0
C6- Multi Files Transcoder Photo, Audio, Video (MP4, HLS)
This is the master api to convert all files together in an array. For example you can send 3 photo, 1 gif, 3 songs, 2 video files, and you can convert to 50 versions in a single call as a bulk process. This is the most easy method if your APP has multiple media versions. It combines all other transcoding endpoints. You can send multiple files with different formats. You can target multiple versions. (Like 360p and 1080p video outputs from the same video.) Object structure is same. Uplo...
0.1
C6- Multi Files Transcoder Photo, Audio, Video (MP4, HLS)
This is the most easy method to convert multiple files at once. Just add all your files in an array. you must have AWS IAM user credentials with "putObject" if you don't have, then check our A series APIs, they returns temporary download link. Please read the "introduction" section in the document for more info on our docs.
201
New Example
{"now": 1694537296395, "message": {"step1_platformTranscodeKeyAuthorization": "SUCCESS", "step2_payloadValidation": "SUCCESS", "step3_downloadAllFiles": "SUCCESS", "step4_transcodingQueue": "SUCCESS", "step5_transcodingFilesOneByOne": "STARTING", "step6_uploadTranscodedFiles": "WAITING", "step7_triggerSuccessOrErrorApiCall": "WAITING", "infoMessages": ["Your request is in progress. There is no problem so far.", "Since transcoding may take too long, we return a response on this step, before transcoding starts.", "Whether error or success, your callback function will be called will be called upon completion.", "Your transcoded files will be uploaded to cloud you provided"]}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"now": {"type": "integer"}, "message": {"type": "object", "properties": {"step1_platformTranscodeKeyAuthorization": {"type": "string"}, "step2_payloadValidation": {"type": "string"}, "step3_downloadAllFiles": {"type": "string"}, "step4_transcodingQueue": {"type": "string"}, "step5_transcodingFilesOneByOne": {"type": "string"}, "step6_uploadTranscodedFiles": {"type": "string"}, "step7_triggerSuccessOrErrorApiCall": {"type": "string"}, "infoMessages": {"type": "array", "items": {"type": "string"}}}, "required": ["infoMessages", "step1_platformTranscodeKeyAuthorization", "step2_payloadValidation", "step3_downloadAllFiles", "step4_transcodingQueue", "step5_transcodingFilesOneByOne", "step6_uploadTranscodedFiles", "step7_triggerSuccessOrErrorApiCall"]}}, "required": ["message", "now"]}
e4e9a6a1-0d04-41cc-968a-b499fda3fdd2/e3e13774-e5f1-40ab-bce1-b4fdf1c596e7/0/0
Background removal
The simplest way to remove image backgrounds through API
9
Check Status
Use this endpoint to check if the server is up and running.
200
Response
{"status": true}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "boolean"}}, "required": ["status"]}
a9aa3667-3b1b-4fe6-be52-8ba7096490a1/cc67e2f6-9057-477c-9893-eb85f12237cc/0/0
Download all TikTok videos by user, tag, or music.
"Retrieve video details and download videos using their URL, user, tag, or music."
0
Get video by music
"Retrieve video details related to specific music."
200
New Example
[{"id": 7270797158645992000, "title": "I can't imagine how happy I'd be inside#CapCut #relax #comfortable #bed #bedroom #furniture #foruyou #crush ", "url": "https://www.tiktok.com/@visual_artt/video/7270797158645992750", "created_at": "24 Aug 2023, 3:06 PM", "stats": {"likeCount": "4.9 M", "commentCount": "27.5 K", "shareCount": "602.7 K", "playCount": "44.6 M", "saveCount": "588.6 K"}, "images": [{"url": "https://p16-sign-va.tiktokcdn.com/tos-maliva-i-photomode-us/0b27892deedf40c793d06cd52b622959~tplv-photomode-image.webp?from=photomode.FEED&x-expires=1697295600&x-signature=4GEVURr0aqVAOtMVKTB8Av38Lho%3D", "width": 928, "height": 1232}, {"url": "https://p16-sign-va.tiktokcdn.com/tos-maliva-i-photomode-us/65f70a7acc3d427b9c2f66afa38cf5be~tplv-photomode-image.webp?from=photomode.FEED&x-expires=1697295600&x-signature=wlRvp2xPARL1W5csqSKZQWoXpZs%3D", "width": 928, "height": 1232}, {"url": "https://p16-sign-va.tiktokcdn.com/tos-maliva-i-photomode-us/9af4f34033be4c41b60e8b128e78ea91~tplv-photomode-image.webp?from=photomode.FEED&x-expires=1697295600&x-signature=c8YOGc8mX9E%2BJXhYo4puvV5HmtE%3D", "width": 928, "height": 1232}, {"url": "https://p16-sign-va.tiktokcdn.com/tos-maliva-i-photomode-us/38d32eba881c471097a944bddc4f55dd~tplv-photomode-image.webp?from=photomode.FEED&x-expires=1697295600&x-signature=WHhxRPSU0ckflC2lWedx9Jq%2BOV8%3D", "width": 928, "height": 1231}, {"url": "https://p16-sign-va.tiktokcdn.com/tos-maliva-i-photomode-us/6efa9cfd2bc84862a32e916d7f40e042~tplv-photomode-image.webp?from=photomode.FEED&x-expires=1697295600&x-signature=xrs%2BYdsmnvk%2B18b6HTq5YbeW6Hc%3D", "width": 928, "height": 1231}], "music": {"id": 7211414788142795000, "title": "Cruel Summer", "author": "Taylor Swift", "cover_hd": null, "cover_large": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_720x720.jpeg", "cover_medium": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_200x200.jpeg", "cover_thumb": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_100x100.jpeg", "durationFormatted": "00:01:00", "duration": 60, "play_url": "https://sf16-ies-music-va.tiktokcdn.com/obj/tos-useast2a-ve-2774/o0DImqFiAzKCgoaUGLfswUUhsBNhOhytW1AyDh"}, "author": {"id": "7268215907213739050", "name": "visual home", "unique_id": "visual_artt", "signature": "Hey! Dear friends, Welcome to the secret base\n\ud83d\udc95\ud83d\udc95\ud83d\udc95", "avatar": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/0d10c52e9ef364a622d619024655cf5e~c5_720x720.webp?x-expires=1696086000&x-signature=01hNgViGf4KO9RJfSSddBz5eibM%3D", "avatar_thumb": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/0d10c52e9ef364a622d619024655cf5e~c5_100x100.webp?x-expires=1696086000&x-signature=d7r3FcDF33ZywzxmQQBe2uJcbRA%3D"}}, {"id": 7252417540603923000, "title": "Always takes them a couple days to warm up to each other \ud83d\ude42 @j.der #catsoftiktok #dogsoftiktok #aussie ", "url": "https://www.tiktok.com/@kingaling721/video/7252417540603923754", "created_at": "06 Jul 2023, 2:24 AM", "stats": {"likeCount": "4.8 M", "commentCount": 8946, "shareCount": "203.1 K", "playCount": "25.9 M", "saveCount": "402.8 K"}, "video": {"noWatermark": "https://v16m-default.akamaized.net/c86c9d07a5b72d6e542f53b0488aa2cf/6517425d/video/tos/maliva/tos-maliva-ve-0068c799-us/o0bJLjjOIInSfltDgweQfI32HIF0UACI4lQk9A/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2322&bt=1161&bti=Ozk3QGo4dik7OzlmMzAuYCM6bS4xMDo%3D&cs=0&ds=6&ft=iJOG.y54Zff0PD1qXPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=ODs8ZjQ6O2g8NWhlOzRmZkBpMzh4aDc6Zjp2bDMzZzczNEAtNmJiLmEzXjYxYzI2XmJfYSMxNGdjcjRvMWZgLS1kMS9zcw%3D%3D&l=202309291531309A85536FC2DAA9463561&btag=e00088000", "watermark": "https://v16m-default.akamaized.net/cdb71ac1be7ca099b1b5872dab0d6d78/6517425d/video/tos/maliva/tos-maliva-ve-0068c799-us/ogQSnbRfIDvkothK7gJA8CpLQej4ARHQFHmMf8/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2428&bt=1214&bti=Ozk3QGo4dik7OzlmMzAuYCM6bS4xMDo%3D&cs=0&ds=3&ft=iJOG.y54Zff0PD1qXPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=NDNoZDlmNDU2NGc7NTRoZEBpMzh4aDc6Zjp2bDMzZzczNEBiLl4xXzQtXmAxLi9eNGEvYSMxNGdjcjRvMWZgLS1kMS9zcw%3D%3D&l=202309291531309A85536FC2DAA9463561&btag=e00088000", "cover": "https://p16-sign.tiktokcdn-us.com/large/tos-useast5-p-0068-tx/64e60385b9014a63a7916bc96c599513_1688585056.jpeg?x-expires=1696086000&x-signature=LCyC2J7FcapYXjSpzfFYzssjkgc%3D&s=FEED&se=false&sh=&sc=cover&l=202309291531309A85536FC2DAA9463561", "dynamic_cover": "https://p16-sign.tiktokcdn-us.com/obj/tos-useast5-p-0068-tx/0af03b07df514f23a2b91b80c6a4b604_1688585055?x-expires=1696086000&x-signature=f14p%2BXTw4SEO1I79D2BptsSsz4Q%3D&s=FEED&se=false&sh=&sc=dynamic_cover&l=202309291531309A85536FC2DAA9463561", "origin_cover": "https://p19-sign.tiktokcdn-us.com/tos-useast5-p-0068-tx/595612e6e42240069972ae2e25ffab8b_1688585054~tplv-tiktokx-360p.jpeg?x-expires=1696086000&x-signature=Hk0Ot7IFEZKQnPxCpWzSJEkOBH4%3D&s=FEED&se=false&sh=&sc=feed_cover&l=202309291531309A85536FC2DAA9463561", "width": 1080, "height": 1920, "durationFormatted": "00:00:41", "duration": 41, "ratio": "540p"}, "music": {"id": 7211414788142795000, "title": "Cruel Summer", "author": "Taylor Swift", "cover_hd": null, "cover_large": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_720x720.jpeg", "cover_medium": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_200x200.jpeg", "cover_thumb": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_100x100.jpeg", "durationFormatted": "00:01:00", "duration": 60, "play_url": "https://sf16-ies-music-va.tiktokcdn.com/obj/tos-useast2a-ve-2774/o0DImqFiAzKCgoaUGLfswUUhsBNhOhytW1AyDh"}, "author": {"id": "6809790781622010885", "name": "King\ud83e\udd20", "unique_id": "kingaling721", "signature": "\ud83c\udf06 NYC & FL \ud83c\udf34\n\ud83d\udce9 or DM for collab", "avatar": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/64962c1503c7a9d7dad115af60c23202~c5_720x720.webp?x-expires=1696086000&x-signature=oVyelRuDHxZYmt0D8y0UoLL0M0M%3D", "avatar_thumb": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/64962c1503c7a9d7dad115af60c23202~c5_100x100.webp?x-expires=1696086000&x-signature=P9GbJxucGf%2BeMLDDpodDzJKbMjo%3D"}}, {"id": 7250825876013714000, "title": "a big fleeeex", "url": "https://www.tiktok.com/@iamgladpo/video/7250825876013714693", "created_at": "01 Jul 2023, 7:27 PM", "stats": {"likeCount": "4.8 M", "commentCount": "25.4 K", "shareCount": "279.6 K", "playCount": "20.4 M", "saveCount": "260.3 K"}, "video": {"noWatermark": "https://v16m-default.akamaized.net/d77413337a9423618c8226c49855b748/6517424d/video/tos/useast2a/tos-useast2a-ve-0068c003/o0intAzU9G2g7fIOyu2R3QkCoINgAn9UD0IAhN/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2986&bt=1493&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=6&ft=iJOG.y54Zff0PD1RXPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=Zjc1ZmY3N2Q1ZWU8NjU8O0BpanByPDs6Zjs0bDMzNzczM0BiMDUwXjIwNS0xYjEtLjNgYSNyb21rcjRva2RgLS1kMTZzcw%3D%3D&l=20230929153133D340702577FB72455BF7&btag=e00088000", "watermark": "https://v16m-default.akamaized.net/5c0fe237687d01f37590b5926b534049/6517424d/video/tos/useast2a/tos-useast2a-ve-0068c002/oIBBFbjb1ChkeBARQuM6RYtnQDeEJSgOdcoCoL/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2022&bt=1011&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=6&ft=iJOG.y54Zff0PD1RXPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=11&rc=Nzk2NTM6ZWk1ZjY4NjczNkBpanByPDs6Zjs0bDMzNzczM0A2NTVgNmFjXmAxL2AuMDI1YSNyb21rcjRva2RgLS1kMTZzcw%3D%3D&l=20230929153133D340702577FB72455BF7&btag=e00088000", "cover": "https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/oodIEZf6DeAdKoCQQR0nJjcbBtNMuRkABBObB3~noop.image?x-expires=1696086000&x-signature=o23nGlJEWPfz7FsqITX6dLct2BE%3D&s=FEED&se=false&sh=&sc=cover&l=20230929153133D340702577FB72455BF7", "dynamic_cover": "https://p16-sign-va.tiktokcdn.com/obj/tos-maliva-p-0068/31295c9c007944cf97dfdf1fcc418be5_1688214460?x-expires=1696086000&x-signature=VSyas1INWx%2BEF7cCiXbOLFKo7nY%3D&s=FEED&se=false&sh=&sc=dynamic_cover&l=20230929153133D340702577FB72455BF7", "origin_cover": "https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/20b1afe63f14417598c7bae3bd8cd146_1688214459~tplv-tiktokx-360p.image?x-expires=1696086000&x-signature=CMGODbu9P79mQh7%2B%2Bcx72DmKhIw%3D&s=FEED&se=false&sh=&sc=feed_cover&l=20230929153133D340702577FB72455BF7", "width": 720, "height": 1280, "durationFormatted": "00:00:20", "duration": 20, "ratio": "540p"}, "music": {"id": 7211414788142795000, "title": "Cruel Summer", "author": "Taylor Swift", "cover_hd": null, "cover_large": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_720x720.jpeg", "cover_medium": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_200x200.jpeg", "cover_thumb": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_100x100.jpeg", "durationFormatted": "00:01:00", "duration": 60, "play_url": "https://sf16-ies-music-va.tiktokcdn.com/obj/tos-useast2a-ve-2774/o0DImqFiAzKCgoaUGLfswUUhsBNhOhytW1AyDh"}, "author": {"id": "7094761038621721601", "name": "gladyscivil", "unique_id": "iamgladpo", "signature": "", "avatar": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/30618ee7bfa7e7af40fba308428f2c87~c5_720x720.webp?x-expires=1696086000&x-signature=ine9gEFO2214%2FNEvg1oagOZcEyA%3D", "avatar_thumb": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/30618ee7bfa7e7af40fba308428f2c87~c5_100x100.webp?x-expires=1696086000&x-signature=VJcaJZJFuu%2FkJEAd0DC%2BpQeqL8s%3D"}}, {"id": 7252384609730711000, "title": "Shit #fyp #dogsoftiktok #staffy ", "url": "https://www.tiktok.com/@vidajad2/video/7252384609730710810", "created_at": "06 Jul 2023, 12:16 AM", "stats": {"likeCount": "4.3 M", "commentCount": 9694, "shareCount": "78.9 K", "playCount": "27.1 M", "saveCount": "190.6 K"}, "video": {"noWatermark": "https://v16m-default.akamaized.net/b9e63b563aaa9a02f149c8dbd57187e7/65174244/video/tos/useast2a/tos-useast2a-ve-0068c001-euttp/owCdMUIon9AfIhtpGKIiNUNkOKz8hABEZQXycl/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=1958&bt=979&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=6&ft=iJOG.y54Zff0PD1AXPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=OWkzOjloaGk5OWk6PDwzaEBpMzVvPGc6ZmR0bDMzZjczM0AzNC8yYi4uNi4xYy0vNTRfYSMxZzBicjQwXmZgLS1kMWNzcw%3D%3D&l=20230929153136D340702577FB72455D15&btag=e00088000", "watermark": "https://v16m-default.akamaized.net/29034a949eea5ba19849a1c96a5f97fc/65174244/video/tos/useast2a/tos-useast2a-ve-0068c001-euttp/ooPzpQSREQ56ESIDDkaQjUnaeobgABuCtIfLk1/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2064&bt=1032&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=3&ft=iJOG.y54Zff0PD1AXPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=ZjY1ZjhkNjg8aDg1aDppNEBpMzVvPGc6ZmR0bDMzZjczM0BjLV4vLS1hX2IxLWIwMzBhYSMxZzBicjQwXmZgLS1kMWNzcw%3D%3D&l=20230929153136D340702577FB72455D15&btag=e00088000", "cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-euttp/oEIK7AnzyApNiiZfhuUtkAEcChdlNUnokIIWqU~noop.image?x-expires=1696086000&x-signature=jitlO%2FoX2nVMG4kIbpZc7mEcdYY%3D&s=FEED&se=false&sh=&sc=cover&l=20230929153136D340702577FB72455D15", "dynamic_cover": "https://p16-sign-useast2a.tiktokcdn.com/obj/tos-useast2a-p-0037-euttp/ffdc73bdfc7b4e59a58b8053eab6ad9a_1688577389?x-expires=1696086000&x-signature=VS4LS8CDC1gIU0uuXk0JxWkR%2Bjc%3D&s=FEED&se=false&sh=&sc=dynamic_cover&l=20230929153136D340702577FB72455D15", "origin_cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-euttp/984c50a2ef1c4caa806f5221ecaa28c0_1688577388~tplv-tiktokx-360p.image?x-expires=1696086000&x-signature=cFhgLAubZFMi5DOKM7dUJW3rBDM%3D&s=FEED&se=false&sh=&sc=feed_cover&l=20230929153136D340702577FB72455D15", "width": 720, "height": 1280, "durationFormatted": "00:00:10", "duration": 10, "ratio": "540p"}, "music": {"id": 7211414788142795000, "title": "Cruel Summer", "author": "Taylor Swift", "cover_hd": null, "cover_large": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_720x720.jpeg", "cover_medium": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_200x200.jpeg", "cover_thumb": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_100x100.jpeg", "durationFormatted": "00:01:00", "duration": 60, "play_url": "https://sf16-ies-music-va.tiktokcdn.com/obj/tos-useast2a-ve-2774/o0DImqFiAzKCgoaUGLfswUUhsBNhOhytW1AyDh"}, "author": {"id": "6805538305004962821", "name": "vidajad2", "unique_id": "vidajad2", "signature": "Instagram : vidajad2", "avatar": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-euttp/344380c89121f21d1375164e035fb7fa~c5_720x720.webp?x-expires=1696086000&x-signature=8bPOcS%2FqInwCp2WDmG84L0BLhHI%3D", "avatar_thumb": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-euttp/344380c89121f21d1375164e035fb7fa~c5_100x100.webp?x-expires=1696086000&x-signature=N9Lq2n5rTATCDTisGa8GUBBI%2BGE%3D"}}, {"id": 7252395080236027000, "title": "nas\u0131 olabilir", "url": "https://www.tiktok.com/@airemkorkmaz/video/7252395080236027142", "created_at": "06 Jul 2023, 12:56 AM", "stats": {"likeCount": "3.7 M", "commentCount": 7890, "shareCount": "18.7 K", "playCount": "39 M", "saveCount": "139 K"}, "video": {"noWatermark": "https://v16m-default.akamaized.net/8a0e055980f218dfa9e181af214bd4bc/65174245/video/tos/useast2a/tos-useast2a-pve-0068/oIRB7eB7QUPbOIpvukHWAfJlPcIEEB9znaroDQ/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2840&bt=1420&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=6&ft=iJOG.y54Zff0PD1PXPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=OzM7NGc3ZTYzNDdoOmdpOUBpam46dDc6Zm10bDMzNzczM0AyXzVfNDVhXzExMmBeX18uYSNjcWdfcjRvcWZgLS1kMTZzcw%3D%3D&l=202309291531398668D804C946C74736CD&btag=e00088000", "watermark": "https://v16m-default.akamaized.net/087aa25c0f305ef42139a3284bcdfef2/65174245/video/tos/useast2a/tos-useast2a-pve-0068/owQoUPfbRkD4CJB6Bznl97eadvmpQAIIvErBUE/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2864&bt=1432&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=3&ft=iJOG.y54Zff0PD1PXPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=MzhpNjM7ZDQzNzk3NjVpO0Bpam46dDc6Zm10bDMzNzczM0BfXl8wMTVhNjExX2E0NWM2YSNjcWdfcjRvcWZgLS1kMTZzcw%3D%3D&l=202309291531398668D804C946C74736CD&btag=e00088000", "cover": "https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o0rIoevEDIuEQZp9alb7f1PARoUoknJzBA1uBB~noop.image?x-expires=1696086000&x-signature=glp2m8d4LORuIhJlGwNmqGJXWwc%3D&s=FEED&se=false&sh=&sc=cover&l=202309291531398668D804C946C74736CD", "dynamic_cover": "https://p16-sign-va.tiktokcdn.com/obj/tos-maliva-p-0068/b3b5fba154d6479fa6f29473dc6ebb72_1688579820?x-expires=1696086000&x-signature=k8q4zwaZ1wZ09XLjtJ5ALQk%2FQhI%3D&s=FEED&se=false&sh=&sc=dynamic_cover&l=202309291531398668D804C946C74736CD", "origin_cover": "https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/4f577493a7fb46c9aa9acc79b56cc1db_1688579820~tplv-tiktokx-360p.image?x-expires=1696086000&x-signature=29CcB6iRc2o29zkFtflx6nzeG9Q%3D&s=FEED&se=false&sh=&sc=feed_cover&l=202309291531398668D804C946C74736CD", "width": 720, "height": 1280, "durationFormatted": "00:00:08", "duration": 8, "ratio": "540p"}, "music": {"id": 7211414788142795000, "title": "Cruel Summer", "author": "Taylor Swift", "cover_hd": null, "cover_large": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_720x720.jpeg", "cover_medium": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_200x200.jpeg", "cover_thumb": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_100x100.jpeg", "durationFormatted": "00:01:00", "duration": 60, "play_url": "https://sf16-ies-music-va.tiktokcdn.com/obj/tos-useast2a-ve-2774/o0DImqFiAzKCgoaUGLfswUUhsBNhOhytW1AyDh"}, "author": {"id": "6990047422106698753", "name": "irem", "unique_id": "airemkorkmaz", "signature": "adana", "avatar": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/b29d1d1c0e017688383f7a448ffb8edd~c5_720x720.webp?x-expires=1696086000&x-signature=vRsQsf%2F4%2FjxDSkxUrEayxGtv4bc%3D", "avatar_thumb": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/b29d1d1c0e017688383f7a448ffb8edd~c5_100x100.webp?x-expires=1696086000&x-signature=%2BkarTjvQmax3DlkunELVwM6b7k4%3D"}}]
{"$schema": "http://json-schema.org/schema#", "type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer"}, "title": {"type": "string"}, "url": {"type": "string"}, "created_at": {"type": "string"}, "stats": {"type": "object", "properties": {"likeCount": {"type": "string"}, "commentCount": {"type": ["integer", "string"]}, "shareCount": {"type": "string"}, "playCount": {"type": "string"}, "saveCount": {"type": "string"}}, "required": ["commentCount", "likeCount", "playCount", "saveCount", "shareCount"]}, "images": {"type": "array", "items": {"type": "object", "properties": {"url": {"type": "string"}, "width": {"type": "integer"}, "height": {"type": "integer"}}, "required": ["height", "url", "width"]}}, "music": {"type": "object", "properties": {"id": {"type": "integer"}, "title": {"type": "string"}, "author": {"type": "string"}, "cover_hd": {"type": "null"}, "cover_large": {"type": "string"}, "cover_medium": {"type": "string"}, "cover_thumb": {"type": "string"}, "durationFormatted": {"type": "string"}, "duration": {"type": "integer"}, "play_url": {"type": "string"}}, "required": ["author", "cover_hd", "cover_large", "cover_medium", "cover_thumb", "duration", "durationFormatted", "id", "play_url", "title"]}, "author": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "unique_id": {"type": "string"}, "signature": {"type": "string"}, "avatar": {"type": "string"}, "avatar_thumb": {"type": "string"}}, "required": ["avatar", "avatar_thumb", "id", "name", "signature", "unique_id"]}, "video": {"type": "object", "properties": {"noWatermark": {"type": "string"}, "watermark": {"type": "string"}, "cover": {"type": "string"}, "dynamic_cover": {"type": "string"}, "origin_cover": {"type": "string"}, "width": {"type": "integer"}, "height": {"type": "integer"}, "durationFormatted": {"type": "string"}, "duration": {"type": "integer"}, "ratio": {"type": "string"}}, "required": ["cover", "duration", "durationFormatted", "dynamic_cover", "height", "noWatermark", "origin_cover", "ratio", "watermark", "width"]}}, "required": ["author", "created_at", "id", "music", "stats", "title", "url"]}}
a9aa3667-3b1b-4fe6-be52-8ba7096490a1/9061099b-d7a5-417b-9116-83080506a96b/0/0
Download all TikTok videos by user, tag, or music.
"Retrieve video details and download videos using their URL, user, tag, or music."
0
Get video by tag
"Retrieve video details with tag"
200
New Example
[{"id": 6797294685082619000, "title": "Ara Woah #woah #woahchallenge #foryou #fyp #meme #\uc774\uc544\ub77c #\ud2f1\ud1a1 #tiktok", "url": "https://www.tiktok.com/@miso_ara/video/6797294685082619137", "created_at": "25 Feb 2020, 7:11 PM", "stats": {"likeCount": "19.6 M", "commentCount": "62.7 K", "shareCount": "381.2 K", "playCount": "206.8 M", "saveCount": "404.2 K"}, "video": {"noWatermark": "https://v16m-default.akamaized.net/00217de64db7ffb850b5b6f8849ea8d4/65174069/video/n/v0102/b33106b6974d4b20974bf59454a02234/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=1488&bt=744&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=6&ft=iJOG.y54Zff0PD1lHPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=Njs8MzlpOWg8Ozw5ZTU5O0BpM286bGxvazZqczMzPDgzM0A0YjYwLi8uX18xM2FhNTReYSNvNTFkZm1rcF5fLS00LzRzcw%3D%3D&l=2023092915233414899C795B9540446E22&btag=e00088000", "watermark": "https://v16m-default.akamaized.net/c6a24b5d2e6d23a110f6ac4f89c25232/65174069/video/n/v0102/e99ec24738854b7985d2926c1410767d/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=1492&bt=746&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=3&ft=iJOG.y54Zff0PD1lHPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=NDplM2VlNTY4NDNoPGRkN0BpM286bGxvazZqczMzPDgzM0BgLjIxLy9iXjAxY2EzXmAvYSNvNTFkZm1rcF5fLS00LzRzcw%3D%3D&l=2023092915233414899C795B9540446E22&btag=e00088000", "cover": "https://p16-sign-sg.tiktokcdn.com/large/v0201/ebd1ec28dc234e3eaf2e2a0e28877418_1582632693.jpeg?x-expires=1696086000&x-signature=7ap6BEpGCUCpo3isHDO5P2u8ZaE%3D&s=FEED&se=false&sh=&sc=cover&l=2023092915233414899C795B9540446E22", "dynamic_cover": "https://p16-sign-sg.tiktokcdn.com/obj/v0201/9d59bae0660648a4b4106ec0fbd3ed13_1582632690?x-expires=1696086000&x-signature=xcgx8lyzuR2Imf8%2FHaF%2Fewb6uXs%3D&s=FEED&se=false&sh=&sc=dynamic_cover&l=2023092915233414899C795B9540446E22", "origin_cover": "https://p16-sign-sg.tiktokcdn.com/v0201/9378e876caf549deb6fc288271cc71fe_1582632681~tplv-tiktokx-360p.jpeg?x-expires=1696086000&x-signature=4Num4%2B5cXUJ93A2ECOTvykiF88Q%3D&s=FEED&se=false&sh=&sc=feed_cover&l=2023092915233414899C795B9540446E22", "width": 2160, "height": 3840, "durationFormatted": "00:00:17", "duration": 17, "ratio": "540p"}, "music": {"id": 6797287773716942000, "title": "original sound - \ubbf8\uc18c\uc544\ub77c Miso_Ara", "author": "\ubbf8\uc18c\uc544\ub77c Miso_Ara", "cover_hd": null, "cover_large": "https://p16-sign-sg.tiktokcdn.com/aweme/1080x1080/tos-alisg-avt-0068/3d7f8d376e2ae1e5bf2d5d34ce4227cf.webp?x-expires=1696086000&x-signature=%2B0pMnDomMdPph8MTrMCvHrdW1NY%3D", "cover_medium": "https://p16-sign-sg.tiktokcdn.com/aweme/720x720/tos-alisg-avt-0068/3d7f8d376e2ae1e5bf2d5d34ce4227cf.webp?x-expires=1696086000&x-signature=rKoN%2B5opxKJedpz2gwmqwXZEP5g%3D", "cover_thumb": "https://p16-sign-sg.tiktokcdn.com/aweme/100x100/tos-alisg-avt-0068/3d7f8d376e2ae1e5bf2d5d34ce4227cf.webp?x-expires=1696086000&x-signature=Pemud2CGut8TbXaGsLP6RvtUyTg%3D", "durationFormatted": "00:00:17", "duration": 17, "play_url": "https://sf53-ies-music-sg.tiktokcdn.com/obj/tiktok-obj/1659493776138258.mp3"}, "author": {"id": "6713126981665686530", "name": "\ubbf8\uc18c\uc544\ub77c Miso_Ara", "unique_id": "miso_ara", "signature": "\ud83d\udce7 [email protected]\n\n\n\ud83d\udc47\ud83c\udffb", "avatar": "https://p16-sign-sg.tiktokcdn.com/aweme/720x720/tos-alisg-avt-0068/3d7f8d376e2ae1e5bf2d5d34ce4227cf.webp?x-expires=1696086000&x-signature=rKoN%2B5opxKJedpz2gwmqwXZEP5g%3D", "avatar_thumb": "https://p16-sign-sg.tiktokcdn.com/aweme/100x100/tos-alisg-avt-0068/3d7f8d376e2ae1e5bf2d5d34ce4227cf.webp?x-expires=1696086000&x-signature=Pemud2CGut8TbXaGsLP6RvtUyTg%3D"}}, {"id": 7234939825651043000, "title": "Bro going crazy \ud83d\ude02\ud83d\ude02\ud83d\ude02 #baby #funny #food #funny #fyp\u30c4foryoupage #entertainment #memes #\ud83d\ude02\ud83d\ude02\ud83d\ude02 #taste #meme #\ud83d\ude02\ud83d\ude02\ud83d\ude02 #meme #foryoupage #fyp\u30b7 #makethisviral #viral #\ud83d\ude02 #fyp #trending #foryou #fyppppppppppppppppppppppp ", "url": "https://www.tiktok.com/@_vip.memes_/video/7234939825651043610", "created_at": "20 May 2023, 12:01 AM", "stats": {"likeCount": "17.7 M", "commentCount": "87.3 K", "shareCount": "1.8 M", "playCount": "152.6 M", "saveCount": "2 M"}, "video": {"noWatermark": "https://v16m-default.akamaized.net/4b2dec1eb5da291b463dcadc3ce82076/6517406d/video/tos/useast2a/tos-useast2a-pve-0037-aiso/oshInEqmoAWLhvIsIfNW9yzANBMjrhCa4N8IQn/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=1050&bt=525&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=6&ft=iJOG.y54Zff0PD1LHPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=OmlpZDk8ODw5OmQ4OTVmOUBpamZrbzs6Zjd0azMzZjczM0BeLWI1Li5jNmMxM2M2NjIyYSNpaWtrcjQwamdgLS1kMWNzcw%3D%3D&l=202309291523363B3329C178406C463DA7&btag=e00088000", "watermark": "https://v16m-default.akamaized.net/1df74fdb1d7c5f1bfd70d3f504576067/6517406d/video/tos/useast2a/tos-useast2a-pve-0037-aiso/oAQPIgDqRV4ZAonke8LlbZDtWsiEQDCQP16wBe/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=1154&bt=577&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=3&ft=iJOG.y54Zff0PD1LHPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=Ozw7OjQ8OzRmM2Y3Zzo7Z0BpamZrbzs6Zjd0azMzZjczM0AyXjIvMzU0Xl8xYDU0MDIyYSNpaWtrcjQwamdgLS1kMWNzcw%3D%3D&l=202309291523363B3329C178406C463DA7&btag=e00088000", "cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-aiso/oIUsC4nhInWNaWlrqoA9sIwMEAvy8Iz5GI3hfA~noop.image?x-expires=1696086000&x-signature=Jcscu%2BzxGdtrwlSRiYIzE7xpRHw%3D&s=FEED&se=false&sh=&sc=cover&l=202309291523363B3329C178406C463DA7", "dynamic_cover": "https://p16-sign-useast2a.tiktokcdn.com/obj/tos-useast2a-p-0037-aiso/e171d0d38f9b4a49a6bb20b6b214bf34_1684515710?x-expires=1696086000&x-signature=3MI0UVIs6SSwUsYfGlo6tmo86V0%3D&s=FEED&se=false&sh=&sc=dynamic_cover&l=202309291523363B3329C178406C463DA7", "origin_cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-aiso/61e2546505304e70bc856a459d8e147f_1684515710~tplv-tiktokx-360p.image?x-expires=1696086000&x-signature=zfhsFB3TYgTRT3pp3Nx%2Blul2qmQ%3D&s=FEED&se=false&sh=&sc=feed_cover&l=202309291523363B3329C178406C463DA7", "width": 1080, "height": 1920, "durationFormatted": "00:00:18", "duration": 18, "ratio": "540p"}, "music": {"id": 7234939802964086000, "title": "original sound - \ud83d\udc51 vip memes \ud83d\udc51", "author": "\ud83d\udc51 vip memes \ud83d\udc51", "cover_hd": null, "cover_large": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/2d850f594647fd54a1865a19a46a14cd~c5_1080x1080.webp?x-expires=1696086000&x-signature=9MjylifWL2gaNTn8BapA6hKkA%2FA%3D", "cover_medium": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/2d850f594647fd54a1865a19a46a14cd~c5_720x720.webp?x-expires=1696086000&x-signature=9KtJdJPRRI2b8c%2B4JHbcaXrTxP4%3D", "cover_thumb": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/2d850f594647fd54a1865a19a46a14cd~c5_100x100.webp?x-expires=1696086000&x-signature=7uqP%2BcYrhG%2F1uN%2B%2BiWQJYtIY3MM%3D", "durationFormatted": "00:00:18", "duration": 18, "play_url": "https://sf16-ies-music.tiktokcdn.com/obj/ies-music-aiso/7234939817983855386.mp3"}, "author": {"id": "6807859262041490437", "name": "\ud83d\udc51 vip memes \ud83d\udc51", "unique_id": "_vip.memes_", "signature": "Road to 2 million!\ud83e\udd1e\ud83c\udffb\u2764\ufe0f\ud83d\ude33\nFollow to become a VIP \ud83e\udd29\ud83c\udfc6\nEven MORE on my YT ->", "avatar": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/2d850f594647fd54a1865a19a46a14cd~c5_720x720.webp?x-expires=1696086000&x-signature=9KtJdJPRRI2b8c%2B4JHbcaXrTxP4%3D", "avatar_thumb": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/2d850f594647fd54a1865a19a46a14cd~c5_100x100.webp?x-expires=1696086000&x-signature=7uqP%2BcYrhG%2F1uN%2B%2BiWQJYtIY3MM%3D"}}, {"id": 6958603581675032000, "title": "#fyp #meme #funny #meme #vine", "url": "https://www.tiktok.com/@crinka11/video/6958603581675031814", "created_at": "05 May 2021, 7:56 AM", "stats": {"likeCount": "15.4 M", "commentCount": "146 K", "shareCount": "205.6 K", "playCount": "80 M", "saveCount": "580.8 K"}, "video": {"noWatermark": "https://v16m-default.akamaized.net/04ac00d729de313dde671141dc08a520/65174068/video/tos/useast2a/tos-useast2a-ve-0068c003/b8b16296a7614121a7503a15dabdbc32/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=1346&bt=673&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=6&ft=iJOG.y54Zff0PD1MHPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=aGY3ZDs0NmRpNGk5OGU0Z0BpanVpc3U7dTh4NTMzNzczM0AxLTBfMl5jNmIxYDYxNDUvYSNmYzJsM2xebjVgLS1kMTZzcw%3D%3D&l=202309291523388ABB242F74A4CC45603C&btag=e00088000", "watermark": "https://v16m-default.akamaized.net/95dfe34f0e7745e69123c37358dd6f74/65174068/video/tos/maliva/tos-maliva-ve-0068c799-us/oodV03gKQe3X9UCCeFBIwEeCIoNJSvkWgAjGNj/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=1328&bt=664&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=3&ft=iJOG.y54Zff0PD1MHPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=PDYzNzRoaTM6NjlmNDtoNEBpanVpc3U7dTh4NTMzNzczM0AxMWE1YTMzNjUxYDFgLjZgYSNmYzJsM2xebjVgLS1kMTZzcw%3D%3D&l=202309291523388ABB242F74A4CC45603C&btag=e00088000", "cover": "https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/21c38688f0364187bb7d80376abc6d42~noop.image?x-expires=1696086000&x-signature=PtHFvGwbuDiDtYBcHTISmMDnItk%3D&s=FEED&se=false&sh=&sc=cover&l=202309291523388ABB242F74A4CC45603C", "dynamic_cover": "https://p16-sign-va.tiktokcdn.com/obj/tos-maliva-p-0068/97441e4a9d5c46b1a24173ad7069cb0f_1620176165?x-expires=1696086000&x-signature=jlCvE7kqbUkT1HzuIrq0j6EhDko%3D&s=FEED&se=false&sh=&sc=dynamic_cover&l=202309291523388ABB242F74A4CC45603C", "origin_cover": "https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/5001465e243b43b383cf36908643d09c_1620176164~tplv-tiktokx-360p.image?x-expires=1696086000&x-signature=M75AFCmn2NwQtgeh4odvQFK3b2Q%3D&s=FEED&se=false&sh=&sc=feed_cover&l=202309291523388ABB242F74A4CC45603C", "width": 720, "height": 1280, "durationFormatted": "00:00:11", "duration": 11, "ratio": "540p"}, "music": {"id": 6958603467573497000, "title": "original sound - Chris Rinker", "author": "Chris Rinker", "cover_hd": null, "cover_large": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/481098764045c3ce40803bbb7a4ce8f5~c5_1080x1080.webp?x-expires=1696086000&x-signature=KUy5BMH7F5Uhis%2Fio0%2FcnrhbDJ4%3D", "cover_medium": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/481098764045c3ce40803bbb7a4ce8f5~c5_720x720.webp?x-expires=1696086000&x-signature=qmkYw713cnNuqnhTspXCuxXCUk8%3D", "cover_thumb": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/481098764045c3ce40803bbb7a4ce8f5~c5_100x100.webp?x-expires=1696086000&x-signature=hgLRSu7TyGCwOll04FikDZokHuM%3D", "durationFormatted": "00:00:11", "duration": 11, "play_url": "https://sf53-ies-music-va.tiktokcdn.com/obj/musically-maliva-obj/6958603596321655557.mp3"}, "author": {"id": "6929583089811522566", "name": "Chris Rinker", "unique_id": "crinka11", "signature": "insta: chrisrinker73", "avatar": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/481098764045c3ce40803bbb7a4ce8f5~c5_720x720.webp?x-expires=1696086000&x-signature=qmkYw713cnNuqnhTspXCuxXCUk8%3D", "avatar_thumb": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/481098764045c3ce40803bbb7a4ce8f5~c5_100x100.webp?x-expires=1696086000&x-signature=hgLRSu7TyGCwOll04FikDZokHuM%3D"}}, {"id": 7242350233621892000, "title": "The water's just too powerful, you can't go against the flow \ud83c\udf0a\ud83c\udfca\u200d\u2642\ufe0f #trend #viral #fyp #foryoupage #meme #relatable #humor #childhood #childhoodmemories #swimmingpool #whirlpool ", "url": "https://www.tiktok.com/@_ianstnr_/video/7242350233621892379", "created_at": "08 Jun 2023, 11:17 PM", "stats": {"likeCount": "15.3 M", "commentCount": "205.6 K", "shareCount": "2 M", "playCount": "84.8 M", "saveCount": "1.3 M"}, "video": {"noWatermark": "https://v16m-default.akamaized.net/e23eef54e24b16791b227a060df7727d/6517406a/video/tos/useast2a/tos-useast2a-pve-0037c001-aiso/o0jgvGbD3gAzJXYeMIE8jnAhEeQg8HILnqMffD/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2956&bt=1478&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=6&ft=iJOG.y54Zff0PD1YHPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=NWYzZDc8ZmU3ODtoPDg8NkBpM3FpbWQ6Zjh5bDMzZjczM0AxLTVjX14tX2ExM2EzLS8tYSNqNGxlcjRvci1gLS1kMWNzcw%3D%3D&l=202309291523416B13BAC5136EA345287E&btag=e00088000", "watermark": "https://v16m-default.akamaized.net/65f732248798f68fb2651ec2275f7dad/6517406a/video/tos/useast2a/tos-useast2a-ve-0068-euttp/ocfIeAgcM8nYAEe0HJqXjFgE8DQCbGvnIDfzok/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=3426&bt=1713&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=3&ft=iJOG.y54Zff0PD1YHPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=ZDY2ZTs3ZWU4ZDtlZmg1Z0BpM3FpbWQ6Zjh5bDMzZjczM0A1NWItLTVeXy0xNF5hMGNgYSNqNGxlcjRvci1gLS1kMWNzcw%3D%3D&l=202309291523416B13BAC5136EA345287E&btag=e00088000", "cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-aiso/4659e81c315b472ba6cca09366e6bcbf_1686241074~noop.image?x-expires=1696086000&x-signature=HNROn9HsGD4F3PyUP48x8XuwbEo%3D&s=FEED&se=false&sh=&sc=cover&l=202309291523416B13BAC5136EA345287E", "dynamic_cover": "https://p16-sign-useast2a.tiktokcdn.com/obj/tos-useast2a-p-0037-euttp/bee2ce0cb0fa4f6aab793973b4a2d6a4_1686241075?x-expires=1696086000&x-signature=iSQffF3h3ID9Hx6pN599aGLZYwI%3D&s=FEED&se=false&sh=&sc=dynamic_cover&l=202309291523416B13BAC5136EA345287E", "origin_cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-aiso/677b8d1ba61a4bdab6c28395502324fe_1686241074~tplv-tiktokx-360p.image?x-expires=1696086000&x-signature=9Jpstb9j8yqHQqXfjHwprtmqW8w%3D&s=FEED&se=false&sh=&sc=feed_cover&l=202309291523416B13BAC5136EA345287E", "width": 1080, "height": 1920, "durationFormatted": "00:00:11", "duration": 11, "ratio": "540p"}, "music": {"id": 7242350198411120000, "title": "original sound - ianstnr", "author": "ianstnr", "cover_hd": null, "cover_large": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-euttp/0e00447cc917289cc1cf3bdb66a7a10f~c5_1080x1080.webp?x-expires=1696086000&x-signature=oPD3fQAc6QiHHkQAmIO13%2FH4Eg0%3D", "cover_medium": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-euttp/0e00447cc917289cc1cf3bdb66a7a10f~c5_720x720.webp?x-expires=1696086000&x-signature=OjmAXQAmlR9ChbJfpQtf1%2BHYNv0%3D", "cover_thumb": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-euttp/0e00447cc917289cc1cf3bdb66a7a10f~c5_100x100.webp?x-expires=1696086000&x-signature=unAXGoz%2Bq63LeuvFrSnhf47CYno%3D", "durationFormatted": "00:00:11", "duration": 11, "play_url": "https://sf16-ies-music.tiktokcdn.com/obj/ies-music-euttp/7242350237967207194.mp3"}, "author": {"id": "7179323675320288262", "name": "ianstnr", "unique_id": "_ianstnr_", "signature": "IAN STEINER\n22 | \ud83c\udde8\ud83c\udded\nI post stuff.\nMail : [email protected]", "avatar": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-euttp/0e00447cc917289cc1cf3bdb66a7a10f~c5_720x720.webp?x-expires=1696086000&x-signature=OjmAXQAmlR9ChbJfpQtf1%2BHYNv0%3D", "avatar_thumb": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-euttp/0e00447cc917289cc1cf3bdb66a7a10f~c5_100x100.webp?x-expires=1696086000&x-signature=unAXGoz%2Bq63LeuvFrSnhf47CYno%3D"}}, {"id": 7227189158882692000, "title": "This is us being serious\ud83d\ude02\ud83d\ude02 #fyp #bestfriend #viral #riverdalecast #interview #fyp\u30b7 #fyp\u30b7\u309aviral #kjapa #markconsuelos #foryou #funnyvideos #meme #shakira #relatable #serious #funny ", "url": "https://www.tiktok.com/@invisibledrax2/video/7227189158882692378", "created_at": "29 Apr 2023, 2:45 AM", "stats": {"likeCount": "14.4 M", "commentCount": "238.8 K", "shareCount": "1.3 M", "playCount": "124.9 M", "saveCount": "1.5 M"}, "video": {"noWatermark": "https://v16m-default.akamaized.net/233d3a32b8c0412769bf61f8383a4820/65174069/video/tos/useast2a/tos-useast2a-pve-0037c001-aiso/o8CETTQ5eekkABPGXkCDRUQBJDI2bDMnEMIlHg/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2326&bt=1163&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=6&ft=iJOG.y54Zff0PD11qPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=Zzg0ZDM7ZTpoOGg0ZzdlOUBpM2Z4NzQ6Zmo1azMzZjczM0BeXzIuNDFfNV8xY2JgYmMyYSNmNW5jcjRvMTNgLS1kMWNzcw%3D%3D&l=202309291523433B3329C178406C464136&btag=e00088000", "watermark": "https://v16m-default.akamaized.net/d18a3c7bc9cb35eef88e032098ecdc4a/65174069/video/tos/useast2a/tos-useast2a-pve-0037c001-aiso/oM9lRkC8TimDEfo9DAIzZCJbDvEQ5eQngIPBIC/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=1952&bt=976&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=3&ft=iJOG.y54Zff0PD11qPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=NmZoPGc4Ozw1ZzxmZ2VpNEBpM2Z4NzQ6Zmo1azMzZjczM0A2NDE1LTQtNl4xXmAxMDY2YSNmNW5jcjRvMTNgLS1kMWNzcw%3D%3D&l=202309291523433B3329C178406C464136&btag=e00088000", "cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-aiso/o4LDJCDIIDZvyWADCIkEMnkBTQBmPIfbQA8e1R~noop.image?x-expires=1696086000&x-signature=qWYLuZDhRSvygmI9pKjUkLqbtKk%3D&s=FEED&se=false&sh=&sc=cover&l=202309291523433B3329C178406C464136", "dynamic_cover": "https://p16-sign-useast2a.tiktokcdn.com/obj/tos-useast2a-p-0037-aiso/c60677a52fa241f5964a8978c4ec4801_1682711119?x-expires=1696086000&x-signature=UjWceLLvSXtnallejGJYJcXBoSM%3D&s=FEED&se=false&sh=&sc=dynamic_cover&l=202309291523433B3329C178406C464136", "origin_cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-aiso/de99ada9e1de40fc8790781ff7507641_1682711118~tplv-tiktokx-360p.image?x-expires=1696086000&x-signature=nrizJEWI%2Bv4jmASjZ4TcbCDBMN8%3D&s=FEED&se=false&sh=&sc=feed_cover&l=202309291523433B3329C178406C464136", "width": 1080, "height": 1920, "durationFormatted": "00:00:07", "duration": 7, "ratio": "540p"}, "music": {"id": 6696417251534342000, "title": "Whenever, Wherever", "author": "Shakira", "cover_hd": null, "cover_large": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/38bc4f7b1a5840bbaf80ba70d1dbc324~c5_720x720.jpeg", "cover_medium": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/38bc4f7b1a5840bbaf80ba70d1dbc324~c5_200x200.jpeg", "cover_thumb": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/38bc4f7b1a5840bbaf80ba70d1dbc324~c5_100x100.jpeg", "durationFormatted": "00:01:00", "duration": 60, "play_url": "https://sf16-ies-music-va.tiktokcdn.com/obj/tos-useast2a-ve-2774/oshsNpUdJvQZiEztAwN2fiBoOqIRQ1lBAr7xdW"}, "author": {"id": "7021257806595867653", "name": "Da\u0107eTuckiju", "unique_id": "invisibledrax2", "signature": "Trying to make you laugh\ud83d\ude00\n\ud83c\udde7\ud83c\udde6\ud83c\udded\ud83c\uddf7\ud83c\udde9\ud83c\uddea\nMemes, Edits and more...", "avatar": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/4d55eabb38e70022c565dc7f5e03a4d9~c5_720x720.webp?x-expires=1696086000&x-signature=duOeKg8UMwid1pTG3HFAlgY2UjU%3D", "avatar_thumb": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/4d55eabb38e70022c565dc7f5e03a4d9~c5_100x100.webp?x-expires=1696086000&x-signature=amdFYB3RKh4%2BJFKptPftJJBOT%2BI%3D"}}]
{"$schema": "http://json-schema.org/schema#", "type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer"}, "title": {"type": "string"}, "url": {"type": "string"}, "created_at": {"type": "string"}, "stats": {"type": "object", "properties": {"likeCount": {"type": "string"}, "commentCount": {"type": "string"}, "shareCount": {"type": "string"}, "playCount": {"type": "string"}, "saveCount": {"type": "string"}}, "required": ["commentCount", "likeCount", "playCount", "saveCount", "shareCount"]}, "video": {"type": "object", "properties": {"noWatermark": {"type": "string"}, "watermark": {"type": "string"}, "cover": {"type": "string"}, "dynamic_cover": {"type": "string"}, "origin_cover": {"type": "string"}, "width": {"type": "integer"}, "height": {"type": "integer"}, "durationFormatted": {"type": "string"}, "duration": {"type": "integer"}, "ratio": {"type": "string"}}, "required": ["cover", "duration", "durationFormatted", "dynamic_cover", "height", "noWatermark", "origin_cover", "ratio", "watermark", "width"]}, "music": {"type": "object", "properties": {"id": {"type": "integer"}, "title": {"type": "string"}, "author": {"type": "string"}, "cover_hd": {"type": "null"}, "cover_large": {"type": "string"}, "cover_medium": {"type": "string"}, "cover_thumb": {"type": "string"}, "durationFormatted": {"type": "string"}, "duration": {"type": "integer"}, "play_url": {"type": "string"}}, "required": ["author", "cover_hd", "cover_large", "cover_medium", "cover_thumb", "duration", "durationFormatted", "id", "play_url", "title"]}, "author": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "unique_id": {"type": "string"}, "signature": {"type": "string"}, "avatar": {"type": "string"}, "avatar_thumb": {"type": "string"}}, "required": ["avatar", "avatar_thumb", "id", "name", "signature", "unique_id"]}}, "required": ["author", "created_at", "id", "music", "stats", "title", "url", "video"]}}
a9aa3667-3b1b-4fe6-be52-8ba7096490a1/51a89552-ed17-4b58-9b49-7b7953004742/0/0
Download all TikTok videos by user, tag, or music.
"Retrieve video details and download videos using their URL, user, tag, or music."
0
Get user posted videos
"Retrieve all video details of an user"
200
New Example
[{"id": 7273319881833991000, "title": "You need this!!!\ud83d\ude1c#gift #giftideas #giftforhim #trending #giftforher ", "url": "https://www.tiktok.com/@charmingworlds/video/7273319881833991457", "created_at": "31 Aug 2023, 10:16 AM", "stats": {"likeCount": 240, "commentCount": 7, "shareCount": 21, "playCount": 8174, "saveCount": 51}, "video": {"noWatermark": "https://v16m-default.akamaized.net/9f39f5b7fb4a068a7ab9dd82347834b7/651735c1/video/tos/useast2a/tos-useast2a-ve-0068c001-euttp/oMjZGsbneg16j9JImCiAf4qAgEfAbDpK8AGeRg/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2570&bt=1285&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=6&ft=iJOG.y54Zff0PD1VYPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=ZmQzOGU7N2c2aDg4NTc7NEBpM3Rmc2c6ZmkzbTMzZjczM0BhYTVjMTAvXzExNDU0NS1eYSNkcmdgcjRnXmxgLS1kMWNzcw%3D%3D&l=20230929143813F4D0789DAD69B63EEF50&btag=e00088000", "watermark": "https://v16m-default.akamaized.net/dfb79cb7f418f9a63972a405625a614b/651735c1/video/tos/useast2a/tos-useast2a-ve-0068c001-euttp/o4EkAC14r8vDmIAgQJDn1fbAIYk9gpsZGegeej/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2824&bt=1412&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=3&ft=iJOG.y54Zff0PD1VYPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=NDtlOjg0aWdpZzg4ZDQ2O0BpM3Rmc2c6ZmkzbTMzZjczM0AtNF4uL2ItNWAxMl5eM2NjYSNkcmdgcjRnXmxgLS1kMWNzcw%3D%3D&l=20230929143813F4D0789DAD69B63EEF50&btag=e00088000", "cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-euttp/oInpIeDntmbGe1DCCJAgI1AQfv8LZjA4seEt5g~noop.image?x-expires=1696082400&x-signature=Cmdp1vBZiFB7VnLhCw%2BhSA5TRdg%3D&s=FEED&se=false&sh=&sc=cover&l=20230929143813F4D0789DAD69B63EEF50", "dynamic_cover": "https://p16-sign-useast2a.tiktokcdn.com/obj/tos-useast2a-p-0037-euttp/736e082d526a41adb012ca141cbebf45_1693451766?x-expires=1696082400&x-signature=5nuxUBt1BUgoPKP01Yv5Nh%2FkDgk%3D&s=FEED&se=false&sh=&sc=dynamic_cover&l=20230929143813F4D0789DAD69B63EEF50", "origin_cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-euttp/95652e3c74e24474a8b5e0a903c66b10_1693451765~tplv-tiktokx-360p.image?x-expires=1696082400&x-signature=2lIpBdBTjPffHkq1yOjjwWemVLo%3D&s=FEED&se=false&sh=&sc=feed_cover&l=20230929143813F4D0789DAD69B63EEF50", "width": 1080, "height": 1920, "durationFormatted": "00:00:09", "duration": 9, "ratio": "540p"}, "music": {"id": 7211414788142795000, "title": "Cruel Summer", "author": "Taylor Swift", "cover_hd": null, "cover_large": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_720x720.jpeg", "cover_medium": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_200x200.jpeg", "cover_thumb": "https://p16-va-default.akamaized.net/img/tos-useast2a-v-2774/76687d82a32641ee935a44e506c53ff6~c5_100x100.jpeg", "durationFormatted": "00:01:00", "duration": 60, "play_url": "https://sf16-ies-music-va.tiktokcdn.com/obj/tos-useast2a-ve-2774/o0DImqFiAzKCgoaUGLfswUUhsBNhOhytW1AyDh"}, "author": {"id": "7096406524952839173", "name": "Gifts-link in bio\ud83c\udf81", "unique_id": "charmingworlds", "signature": "\u2728Ins: charmingworlds\u2728\n\ud83d\udd17All products posted are available here\ud83d\udc47\ud83c\udffb\n\ud83d\udd3aSHOP NOW\ud83d\udd3b", "avatar": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/db8330dc13e67c328a5c12beee2af652~c5_720x720.webp?x-expires=1696082400&x-signature=0VNH6NRgsz%2Fivr3JHJs44uwZCiE%3D", "avatar_thumb": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/db8330dc13e67c328a5c12beee2af652~c5_100x100.webp?x-expires=1696082400&x-signature=Is9DaMGTk%2FoFxk8H7atzkm%2F79l4%3D"}}, {"id": 7272581751610904000, "title": "\ud83e\udd72#gift #giftideas #giftforhim #trending #giftforher ", "url": "https://www.tiktok.com/@charmingworlds/video/7272581751610903840", "created_at": "29 Aug 2023, 10:31 AM", "stats": {"likeCount": 123, "commentCount": 0, "shareCount": 3, "playCount": 6723, "saveCount": 4}, "video": {"noWatermark": "https://v16m-default.akamaized.net/94c0b71a4130ca829dcd3061ae774188/651735c2/video/tos/useast2a/tos-useast2a-ve-0068-euttp/os7InEZooAMDhmLsIftUryzAjBdLRhCjqFDkQt/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2552&bt=1276&bti=Ozk3QGo4dik7OzlmMzAuYCM6bS4xMDo%3D&cs=0&ds=6&ft=iJOG.y54Zff0PD1sYPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=NTo5O2U2PGRpMzxmZDZlaEBpamZoOGU6ZmxwbTMzZjczM0BeXjJfLTZeNWMxM2IwMDBhYSM1NC1ncjRfYGpgLS1kMWNzcw%3D%3D&l=20230929143817189C15FD10BB9F4043CA&btag=e00088000", "watermark": "https://v16m-default.akamaized.net/73636be4536bb737ad8688d214090776/651735c2/video/tos/useast2a/tos-useast2a-ve-0068c001-euttp/ogHtJYQ7bAQoBZfkgnRkoqBiZDDPeERHMWCIPX/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2664&bt=1332&bti=Ozk3QGo4dik7OzlmMzAuYCM6bS4xMDo%3D&cs=0&ds=3&ft=iJOG.y54Zff0PD1sYPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=ZmdpN2hmZDw4Z2c5ODRkaUBpamZoOGU6ZmxwbTMzZjczM0AuXzMyYWAvXjQxYTJiNjI0YSM1NC1ncjRfYGpgLS1kMWNzcw%3D%3D&l=20230929143817189C15FD10BB9F4043CA&btag=e00088000", "cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-euttp/o4rMEnRmkzAqZUOKprfLhIyB7CjosAydIDtJth~noop.image?x-expires=1696082400&x-signature=l0z0XdWoivIlTleWXaAj3T5swS4%3D&s=FEED&se=false&sh=&sc=cover&l=20230929143817189C15FD10BB9F4043CA", "dynamic_cover": "https://p16-sign-useast2a.tiktokcdn.com/obj/tos-useast2a-p-0037-euttp/1f90128edd484492a9ed454cd13ac5c6_1693279911?x-expires=1696082400&x-signature=u51uopR5%2B7bbZiMadnaVTWnxT2k%3D&s=FEED&se=false&sh=&sc=dynamic_cover&l=20230929143817189C15FD10BB9F4043CA", "origin_cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-euttp/2eb91239989345b9bbfe59fc114ca077_1693279911~tplv-tiktokx-360p.image?x-expires=1696082400&x-signature=yPkb9Rf3F9ObH%2BMgcax62vFoM4k%3D&s=FEED&se=false&sh=&sc=feed_cover&l=20230929143817189C15FD10BB9F4043CA", "width": 1080, "height": 1920, "durationFormatted": "00:00:07", "duration": 7, "ratio": "540p"}, "music": {"id": 7177259794242276000, "title": "original sound - mycatso_cute", "author": "mycatso_cute", "cover_hd": null, "cover_large": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/8adfd9fe5f1cddd65abce4a5f56f87e2~c5_1080x1080.webp?x-expires=1696082400&x-signature=43RGESGQP3y8gPaQxNHowCb6u4A%3D", "cover_medium": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/8adfd9fe5f1cddd65abce4a5f56f87e2~c5_720x720.webp?x-expires=1696082400&x-signature=H7%2B9sQnPh9EXHxdyLWq5CVvUc%2Fw%3D", "cover_thumb": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/8adfd9fe5f1cddd65abce4a5f56f87e2~c5_100x100.webp?x-expires=1696082400&x-signature=Up8gB%2BowEKoCZgeITJV%2FbzTRcUs%3D", "durationFormatted": "00:00:10", "duration": 10, "play_url": "https://sf16-ies-music-va.tiktokcdn.com/obj/ies-music-ttp-dup-us/7177259780975889198.mp3"}, "author": {"id": "7096406524952839173", "name": "Gifts-link in bio\ud83c\udf81", "unique_id": "charmingworlds", "signature": "\u2728Ins: charmingworlds\u2728\n\ud83d\udd17All products posted are available here\ud83d\udc47\ud83c\udffb\n\ud83d\udd3aSHOP NOW\ud83d\udd3b", "avatar": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/db8330dc13e67c328a5c12beee2af652~c5_720x720.webp?x-expires=1696082400&x-signature=0VNH6NRgsz%2Fivr3JHJs44uwZCiE%3D", "avatar_thumb": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/db8330dc13e67c328a5c12beee2af652~c5_100x100.webp?x-expires=1696082400&x-signature=Is9DaMGTk%2FoFxk8H7atzkm%2F79l4%3D"}}, {"id": 7266083875779071000, "title": "\u2764\ufe0f#gift #giftideas #giftforhim #trending #giftforher ", "url": "https://www.tiktok.com/@charmingworlds/video/7266083875779071265", "created_at": "11 Aug 2023, 10:16 PM", "stats": {"likeCount": 152, "commentCount": 2, "shareCount": 7, "playCount": 9704, "saveCount": 30}, "video": {"noWatermark": "https://v16m-default.akamaized.net/8f8bfb6d4b1d7a4b0953fdad3d34e6c7/651735cc/video/tos/useast2a/tos-useast2a-ve-0068-euttp/oQNWRlgBkQPDEYDJUB1e4fBDIPngSZAzkQbiNV/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=1946&bt=973&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=6&ft=iJOG.y54Zff0PD15YPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=aGg5aDRkZzM3PDU2OWQ6aEBpMzl5bDc6ZnM4bTMzZjczM0BfYy8yXzAvXjExYWIxMTAzYSNsZ2hocjQwLV9gLS1kMWNzcw%3D%3D&l=2023092914382093C2869E8181A83FB004&btag=e00088000", "watermark": "https://v16m-default.akamaized.net/2affba358e708182fe366f8a67ea5f03/651735cc/video/tos/useast2a/tos-useast2a-ve-0068c001-euttp/o8juNAzawUbhNfInypmygQnCoIrWAKdEBxEyh5/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2038&bt=1019&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=3&ft=iJOG.y54Zff0PD15YPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=aGU6aDlmOTQ6PGRnNWdmN0BpMzl5bDc6ZnM4bTMzZjczM0AuNDQzNC8tNl8xMzE1MzExYSNsZ2hocjQwLV9gLS1kMWNzcw%3D%3D&l=2023092914382093C2869E8181A83FB004&btag=e00088000", "cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-euttp/osnzwsZLhbuAINfoyCmAnUyNpgEIAyCaWEhjK5~noop.image?x-expires=1696082400&x-signature=l64J%2FeuhUsTza%2F0CZ%2BGij7DT5Xs%3D&s=FEED&se=false&sh=&sc=cover&l=2023092914382093C2869E8181A83FB004", "dynamic_cover": "https://p16-sign-useast2a.tiktokcdn.com/obj/tos-useast2a-p-0037-euttp/f18fe675188f4be386dd7078c81e5902_1691766995?x-expires=1696082400&x-signature=ze1emGehMRKBAOM1JhCTEFuULGA%3D&s=FEED&se=false&sh=&sc=dynamic_cover&l=2023092914382093C2869E8181A83FB004", "origin_cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-euttp/2cb60e3c4fd7462780f1a4d4e4373792_1691766995~tplv-tiktokx-360p.image?x-expires=1696082400&x-signature=H5QbWS9FSA2z3eSqO5Er5yc51pQ%3D&s=FEED&se=false&sh=&sc=feed_cover&l=2023092914382093C2869E8181A83FB004", "width": 1080, "height": 1920, "durationFormatted": "00:00:14", "duration": 14, "ratio": "540p"}, "music": {"id": 7098306818442644000, "title": "until i found you", "author": "favmusicvibes", "cover_hd": null, "cover_large": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/1fde0c57498b51770edf3a032efa40f7~c5_1080x1080.webp?x-expires=1696082400&x-signature=XOoKEbtZnINqAU1Aje61C1TIG0c%3D", "cover_medium": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/1fde0c57498b51770edf3a032efa40f7~c5_720x720.webp?x-expires=1696082400&x-signature=MuVrzHGvLB%2FC1o1LTrnwBeV00Vs%3D", "cover_thumb": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/1fde0c57498b51770edf3a032efa40f7~c5_100x100.webp?x-expires=1696082400&x-signature=HtF%2FxOMoYrz8aFzSyUl3GelURB8%3D", "durationFormatted": "00:00:33", "duration": 33, "play_url": "https://sf16-ies-music.tiktokcdn.com/obj/ies-music-aiso/7098306827946887962.mp3"}, "author": {"id": "7096406524952839173", "name": "Gifts-link in bio\ud83c\udf81", "unique_id": "charmingworlds", "signature": "\u2728Ins: charmingworlds\u2728\n\ud83d\udd17All products posted are available here\ud83d\udc47\ud83c\udffb\n\ud83d\udd3aSHOP NOW\ud83d\udd3b", "avatar": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/db8330dc13e67c328a5c12beee2af652~c5_720x720.webp?x-expires=1696082400&x-signature=0VNH6NRgsz%2Fivr3JHJs44uwZCiE%3D", "avatar_thumb": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/db8330dc13e67c328a5c12beee2af652~c5_100x100.webp?x-expires=1696082400&x-signature=Is9DaMGTk%2FoFxk8H7atzkm%2F79l4%3D"}}]
{"$schema": "http://json-schema.org/schema#", "type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer"}, "title": {"type": "string"}, "url": {"type": "string"}, "created_at": {"type": "string"}, "stats": {"type": "object", "properties": {"likeCount": {"type": "integer"}, "commentCount": {"type": "integer"}, "shareCount": {"type": "integer"}, "playCount": {"type": "integer"}, "saveCount": {"type": "integer"}}, "required": ["commentCount", "likeCount", "playCount", "saveCount", "shareCount"]}, "video": {"type": "object", "properties": {"noWatermark": {"type": "string"}, "watermark": {"type": "string"}, "cover": {"type": "string"}, "dynamic_cover": {"type": "string"}, "origin_cover": {"type": "string"}, "width": {"type": "integer"}, "height": {"type": "integer"}, "durationFormatted": {"type": "string"}, "duration": {"type": "integer"}, "ratio": {"type": "string"}}, "required": ["cover", "duration", "durationFormatted", "dynamic_cover", "height", "noWatermark", "origin_cover", "ratio", "watermark", "width"]}, "music": {"type": "object", "properties": {"id": {"type": "integer"}, "title": {"type": "string"}, "author": {"type": "string"}, "cover_hd": {"type": "null"}, "cover_large": {"type": "string"}, "cover_medium": {"type": "string"}, "cover_thumb": {"type": "string"}, "durationFormatted": {"type": "string"}, "duration": {"type": "integer"}, "play_url": {"type": "string"}}, "required": ["author", "cover_hd", "cover_large", "cover_medium", "cover_thumb", "duration", "durationFormatted", "id", "play_url", "title"]}, "author": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "unique_id": {"type": "string"}, "signature": {"type": "string"}, "avatar": {"type": "string"}, "avatar_thumb": {"type": "string"}}, "required": ["avatar", "avatar_thumb", "id", "name", "signature", "unique_id"]}}, "required": ["author", "created_at", "id", "music", "stats", "title", "url", "video"]}}
a9aa3667-3b1b-4fe6-be52-8ba7096490a1/afd7796e-ec78-474b-8d0d-05a6b9a592f9/0/0
Download all TikTok videos by user, tag, or music.
"Retrieve video details and download videos using their URL, user, tag, or music."
0
Get All Video Details
"Retrieve video details, including a download link."
200
Response
{"id": 7272581751610904000, "title": "\ud83e\udd72#gift #giftideas #giftforhim #trending #giftforher ", "url": "https://www.tiktok.com/@charmingworlds/video/7272581751610903840", "created_at": "29 Aug 2023, 10:31 AM", "stats": {"likeCount": 123, "commentCount": 0, "shareCount": 3, "playCount": 6724, "saveCount": 4}, "video": {"noWatermark": "https://v16m-default.akamaized.net/a1fca8f150877ed3ffd3e6859fd872ab/65173e96/video/tos/useast2a/tos-useast2a-ve-0068-euttp/os7InEZooAMDhmLsIftUryzAjBdLRhCjqFDkQt/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2552&bt=1276&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=6&ft=iJOG.y54Zff0PD1WIPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=NTo5O2U2PGRpMzxmZDZlaEBpamZoOGU6ZmxwbTMzZjczM0BeXjJfLTZeNWMxM2IwMDBhYSM1NC1ncjRfYGpgLS1kMWNzcw%3D%3D&l=20230929151556CA71D4A4DAE3A144FBAB&btag=e00088000", "watermark": "https://v16m-default.akamaized.net/acdb1730d5023470ac5ecf00b63caf00/65173e96/video/tos/useast2a/tos-useast2a-ve-0068c001-euttp/ogHtJYQ7bAQoBZfkgnRkoqBiZDDPeERHMWCIPX/?a=0&ch=0&cr=0&dr=0&lr=all&cd=0%7C0%7C0%7C0&cv=1&br=2664&bt=1332&bti=OHYpOTY0Zik7OzlmOm01MzE6ZC4xMDo%3D&cs=0&ds=3&ft=iJOG.y54Zff0PD1WIPcxg9wJX1S-kEeC~&mime_type=video_mp4&qs=0&rc=ZmdpN2hmZDw4Z2c5ODRkaUBpamZoOGU6ZmxwbTMzZjczM0AuXzMyYWAvXjQxYTJiNjI0YSM1NC1ncjRfYGpgLS1kMWNzcw%3D%3D&l=20230929151556CA71D4A4DAE3A144FBAB&btag=e00088000", "cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-euttp/o4rMEnRmkzAqZUOKprfLhIyB7CjosAydIDtJth~noop.image?x-expires=1696086000&x-signature=GbY3eF9UvzTe%2F8XUKobG6EBTwcY%3D&s=FEED&se=false&sh=&sc=cover&l=20230929151556CA71D4A4DAE3A144FBAB", "dynamic_cover": "https://p16-sign-useast2a.tiktokcdn.com/obj/tos-useast2a-p-0037-euttp/1f90128edd484492a9ed454cd13ac5c6_1693279911?x-expires=1696086000&x-signature=FpRJKDR56eev4H2Ro2zQR5EqSpI%3D&s=FEED&se=false&sh=&sc=dynamic_cover&l=20230929151556CA71D4A4DAE3A144FBAB", "origin_cover": "https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-p-0037-euttp/2eb91239989345b9bbfe59fc114ca077_1693279911~tplv-tiktokx-360p.image?x-expires=1696086000&x-signature=%2Fd4jFK1DD4vga0OVXF8HUmkFD74%3D&s=FEED&se=false&sh=&sc=feed_cover&l=20230929151556CA71D4A4DAE3A144FBAB", "width": 1080, "height": 1920, "durationFormatted": "00:00:07", "duration": 7, "ratio": "540p"}, "music": {"id": 7177259794242276000, "title": "original sound - mycatso_cute", "author": "mycatso_cute", "cover_hd": null, "cover_large": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/8adfd9fe5f1cddd65abce4a5f56f87e2~c5_1080x1080.webp?x-expires=1696086000&x-signature=bB2GNTpAJxl6IBf2HOwo%2BE%2BTDe8%3D", "cover_medium": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/8adfd9fe5f1cddd65abce4a5f56f87e2~c5_720x720.webp?x-expires=1696086000&x-signature=znUZ3g2podFXl5rNKIbkqQxgGnQ%3D", "cover_thumb": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/8adfd9fe5f1cddd65abce4a5f56f87e2~c5_100x100.webp?x-expires=1696086000&x-signature=kmpTstY5hkMwV999PAVu3WL45kg%3D", "durationFormatted": "00:00:10", "duration": 10, "play_url": "https://sf16-ies-music-va.tiktokcdn.com/obj/ies-music-ttp-dup-us/7177259780975889198.mp3"}, "author": {"id": "7096406524952839173", "name": "Gifts-link in bio\ud83c\udf81", "unique_id": "charmingworlds", "signature": "\u2728Ins: charmingworlds\u2728\n\ud83d\udd17All products posted are available here\ud83d\udc47\ud83c\udffb\n\ud83d\udd3aSHOP NOW\ud83d\udd3b", "avatar": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/db8330dc13e67c328a5c12beee2af652~c5_720x720.webp?x-expires=1696086000&x-signature=Z4omY4EcYmprziubGBp6RfP%2BZ%2Bo%3D", "avatar_thumb": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/db8330dc13e67c328a5c12beee2af652~c5_100x100.webp?x-expires=1696086000&x-signature=swnx9lwp4W9z8quKFXyV3hbifJg%3D"}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"id": {"type": "integer"}, "title": {"type": "string"}, "url": {"type": "string"}, "created_at": {"type": "string"}, "stats": {"type": "object", "properties": {"likeCount": {"type": "integer"}, "commentCount": {"type": "integer"}, "shareCount": {"type": "integer"}, "playCount": {"type": "integer"}, "saveCount": {"type": "integer"}}, "required": ["commentCount", "likeCount", "playCount", "saveCount", "shareCount"]}, "video": {"type": "object", "properties": {"noWatermark": {"type": "string"}, "watermark": {"type": "string"}, "cover": {"type": "string"}, "dynamic_cover": {"type": "string"}, "origin_cover": {"type": "string"}, "width": {"type": "integer"}, "height": {"type": "integer"}, "durationFormatted": {"type": "string"}, "duration": {"type": "integer"}, "ratio": {"type": "string"}}, "required": ["cover", "duration", "durationFormatted", "dynamic_cover", "height", "noWatermark", "origin_cover", "ratio", "watermark", "width"]}, "music": {"type": "object", "properties": {"id": {"type": "integer"}, "title": {"type": "string"}, "author": {"type": "string"}, "cover_hd": {"type": "null"}, "cover_large": {"type": "string"}, "cover_medium": {"type": "string"}, "cover_thumb": {"type": "string"}, "durationFormatted": {"type": "string"}, "duration": {"type": "integer"}, "play_url": {"type": "string"}}, "required": ["author", "cover_hd", "cover_large", "cover_medium", "cover_thumb", "duration", "durationFormatted", "id", "play_url", "title"]}, "author": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "unique_id": {"type": "string"}, "signature": {"type": "string"}, "avatar": {"type": "string"}, "avatar_thumb": {"type": "string"}}, "required": ["avatar", "avatar_thumb", "id", "name", "signature", "unique_id"]}}, "required": ["author", "created_at", "id", "music", "stats", "title", "url", "video"]}
53da6825-ded3-497c-9b9e-ef8920352d35/06eea9c1-355b-41c7-b937-ac8034516c28/0/0
Toonify
Tools for face transformation
9.5
comichd_v0_comichd
comic hd transformation. Note 1 call = 100 credits
200
Example_1
{"b64_encoded_aligned": "", "b64_encoded_output": "", "num_faces": 0}
{"properties": {"b64_encoded_aligned": {"title": "B64 Encoded Aligned", "type": "string"}, "b64_encoded_output": {"title": "B64 Encoded Output", "type": "string"}, "num_faces": {"title": "Num Faces", "type": "integer"}}, "required": ["num_faces", "b64_encoded_output"], "title": "ToonResponse", "type": "object"}
53da6825-ded3-497c-9b9e-ef8920352d35/06eea9c1-355b-41c7-b937-ac8034516c28/1/0
Toonify
Tools for face transformation
9.5
comichd_v0_comichd
comic hd transformation. Note 1 call = 100 credits
422
Example_1
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"properties": {"detail": {"items": {"properties": {"loc": {"items": {"type": "string"}, "title": "Location", "type": "array"}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}, "required": ["loc", "msg", "type"], "title": "ValidationError", "type": "object"}, "title": "Detail", "type": "array"}}, "title": "HTTPValidationError", "type": "object"}
53da6825-ded3-497c-9b9e-ef8920352d35/a8bf145a-0bfd-4d31-ae19-85e961e3f534/0/0
Toonify
Tools for face transformation
9.5
caricaturehd_v0_caricaturehd
caricature hd transformation. Note 1 call = 100 credits
200
Example_1
{"b64_encoded_aligned": "", "b64_encoded_output": "", "num_faces": 0}
{"properties": {"b64_encoded_aligned": {"title": "B64 Encoded Aligned", "type": "string"}, "b64_encoded_output": {"title": "B64 Encoded Output", "type": "string"}, "num_faces": {"title": "Num Faces", "type": "integer"}}, "required": ["num_faces", "b64_encoded_output"], "title": "ToonResponse", "type": "object"}
53da6825-ded3-497c-9b9e-ef8920352d35/a8bf145a-0bfd-4d31-ae19-85e961e3f534/1/0
Toonify
Tools for face transformation
9.5
caricaturehd_v0_caricaturehd
caricature hd transformation. Note 1 call = 100 credits
422
Example_1
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"properties": {"detail": {"items": {"properties": {"loc": {"items": {"type": "string"}, "title": "Location", "type": "array"}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}, "required": ["loc", "msg", "type"], "title": "ValidationError", "type": "object"}, "title": "Detail", "type": "array"}}, "title": "HTTPValidationError", "type": "object"}
53da6825-ded3-497c-9b9e-ef8920352d35/e427ec3e-1bcb-49e3-a594-b6023ffa2544/0/0
Toonify
Tools for face transformation
9.5
toonmojihd_v0_toonmojihd
toonmoji hd transformation. Note 1 call = 100 credits
200
Example_1
{"b64_encoded_aligned": "", "b64_encoded_output": "", "num_faces": 0}
{"properties": {"b64_encoded_aligned": {"title": "B64 Encoded Aligned", "type": "string"}, "b64_encoded_output": {"title": "B64 Encoded Output", "type": "string"}, "num_faces": {"title": "Num Faces", "type": "integer"}}, "required": ["num_faces", "b64_encoded_output"], "title": "ToonResponse", "type": "object"}
53da6825-ded3-497c-9b9e-ef8920352d35/e427ec3e-1bcb-49e3-a594-b6023ffa2544/1/0
Toonify
Tools for face transformation
9.5
toonmojihd_v0_toonmojihd
toonmoji hd transformation. Note 1 call = 100 credits
422
Example_1
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"properties": {"detail": {"items": {"properties": {"loc": {"items": {"type": "string"}, "title": "Location", "type": "array"}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}, "required": ["loc", "msg", "type"], "title": "ValidationError", "type": "object"}, "title": "Detail", "type": "array"}}, "title": "HTTPValidationError", "type": "object"}
53da6825-ded3-497c-9b9e-ef8920352d35/4c88d07f-3e73-4aeb-a44c-5e2244fce2d2/0/0
Toonify
Tools for face transformation
9.5
zombify_v0_zombify_post
Zombie transformation
200
Example_1
{"b64_encoded_aligned": "", "b64_encoded_output": "", "num_faces": 0}
{"properties": {"b64_encoded_aligned": {"title": "B64 Encoded Aligned", "type": "string"}, "b64_encoded_output": {"title": "B64 Encoded Output", "type": "string"}, "num_faces": {"title": "Num Faces", "type": "integer"}}, "required": ["num_faces", "b64_encoded_output"], "title": "ToonResponse", "type": "object"}
53da6825-ded3-497c-9b9e-ef8920352d35/4c88d07f-3e73-4aeb-a44c-5e2244fce2d2/1/0
Toonify
Tools for face transformation
9.5
zombify_v0_zombify_post
Zombie transformation
422
Example_1
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"properties": {"detail": {"items": {"properties": {"loc": {"items": {"type": "string"}, "title": "Location", "type": "array"}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}, "required": ["loc", "msg", "type"], "title": "ValidationError", "type": "object"}, "title": "Detail", "type": "array"}}, "title": "HTTPValidationError", "type": "object"}
53da6825-ded3-497c-9b9e-ef8920352d35/1001cdf7-0afa-47da-81bd-9f407973cc1d/0/0
Toonify
Tools for face transformation
9.5
caricature_v0_caricature
Caricature transformation
200
Example_1
{"b64_encoded_aligned": "", "b64_encoded_output": "", "num_faces": 0}
{"properties": {"b64_encoded_aligned": {"title": "B64 Encoded Aligned", "type": "string"}, "b64_encoded_output": {"title": "B64 Encoded Output", "type": "string"}, "num_faces": {"title": "Num Faces", "type": "integer"}}, "required": ["num_faces", "b64_encoded_output"], "title": "ToonResponse", "type": "object"}
53da6825-ded3-497c-9b9e-ef8920352d35/1001cdf7-0afa-47da-81bd-9f407973cc1d/1/0
Toonify
Tools for face transformation
9.5
caricature_v0_caricature
Caricature transformation
422
Example_1
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"properties": {"detail": {"items": {"properties": {"loc": {"items": {"type": "string"}, "title": "Location", "type": "array"}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}, "required": ["loc", "msg", "type"], "title": "ValidationError", "type": "object"}, "title": "Detail", "type": "array"}}, "title": "HTTPValidationError", "type": "object"}
53da6825-ded3-497c-9b9e-ef8920352d35/e8c1b292-78f5-49d1-821f-f6e2d7ccd18c/0/0
Toonify
Tools for face transformation
9.5
toonifyhd_v0_toonifyhd
toonify hd transformation. Note 1 call = 100 credits
200
Example_1
{"b64_encoded_aligned": "", "b64_encoded_output": "", "num_faces": 0}
{"properties": {"b64_encoded_aligned": {"title": "B64 Encoded Aligned", "type": "string"}, "b64_encoded_output": {"title": "B64 Encoded Output", "type": "string"}, "num_faces": {"title": "Num Faces", "type": "integer"}}, "required": ["num_faces", "b64_encoded_output"], "title": "ToonResponse", "type": "object"}
53da6825-ded3-497c-9b9e-ef8920352d35/e8c1b292-78f5-49d1-821f-f6e2d7ccd18c/1/0
Toonify
Tools for face transformation
9.5
toonifyhd_v0_toonifyhd
toonify hd transformation. Note 1 call = 100 credits
422
Example_1
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"properties": {"detail": {"items": {"properties": {"loc": {"items": {"type": "string"}, "title": "Location", "type": "array"}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}, "required": ["loc", "msg", "type"], "title": "ValidationError", "type": "object"}, "title": "Detail", "type": "array"}}, "title": "HTTPValidationError", "type": "object"}
53da6825-ded3-497c-9b9e-ef8920352d35/a7c1776b-05e0-471d-aa82-8189df6ad67e/0/0
Toonify
Tools for face transformation
9.5
comic_v0_comic_post
Become a comic book superhero.
422
Example_1
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"properties": {"detail": {"items": {"properties": {"loc": {"items": {"type": "string"}, "title": "Location", "type": "array"}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}, "required": ["loc", "msg", "type"], "title": "ValidationError", "type": "object"}, "title": "Detail", "type": "array"}}, "title": "HTTPValidationError", "type": "object"}
53da6825-ded3-497c-9b9e-ef8920352d35/a7c1776b-05e0-471d-aa82-8189df6ad67e/1/0
Toonify
Tools for face transformation
9.5
comic_v0_comic_post
Become a comic book superhero.
200
Example_1
{"num_faces": 0, "b64_encoded_output": "", "b64_encoded_aligned": ""}
{"properties": {"b64_encoded_aligned": {"title": "B64 Encoded Aligned", "type": "string"}, "b64_encoded_output": {"title": "B64 Encoded Output", "type": "string"}, "num_faces": {"title": "Num Faces", "type": "integer"}}, "required": ["num_faces", "b64_encoded_output"], "title": "ToonResponse", "type": "object"}
2471e490-d9fe-46b8-9238-aba1ff833177/5e5b3944-6e28-4437-aefc-e4dc409e1002/0/0
Image diffusion
Diffusion APIs
2
Inference Style
Apply img2img effect with available style: json [ "cartoon", "witch", "cyberpunk", "cyborg", "gta", "watercolor", "rockstar", "zombie", "illusion_ancient", "illusion_creepy", "illusion_clouds", "illusion_city", "illusion_island", "illusion_mountain", "illusion_tech", "illusion_river", "illusion_volcano" ]
200
New Example
{"status": true, "result": {"images": ["https://example.com/image.jpg"], "metadata": {"style": "Cyborg", "type": "img2img", "prompt": "photorealistic detailed full body picture of a (cyborg:1.2) 22 years old female, neon lights, ((white cybernetic armor)), extreme, uhdr, book called the most influental cyborg in 2 0 5 0, cyberpunk neon city in the background, fine details, highly detailed, intricate, smooth sharp focus, ", "neg_prompt": "fabric, textile, (naked, nude, nsfw,:1.2) (worst quality, low quality:1.2), bad eyes, signature, watermark, username, 3d, cartoon, 3dcg, doll, illustration, lowres, bad anatomy, wrong anatomy, mutated hands and fingers, mutation, mutated, amputation", "seed": -1, "step_size": 25, "cfg_scale": 5, "num_images": 1, "controlnet_name_list": ["lineart"], "controlnet_conditioning_scale": 1, "guess_mode": null, "strength": 1, "resize_by": 1.5, "sampler": "euler"}, "extras": {"age": 22, "gender": "Female"}}}
{"type": "object", "properties": {"status": {"type": "boolean"}, "result": {"type": "object", "properties": {"images": {"type": "array", "items": {"type": "string"}}, "metadata": {"type": "object", "properties": {"style": {"type": "string"}, "type": {"type": "string"}, "prompt": {"type": "string"}, "neg_prompt": {"type": "string"}, "seed": {"type": "integer"}, "step_size": {"type": "integer"}, "cfg_scale": {"type": "integer"}, "num_images": {"type": "integer"}, "controlnet_name_list": {"type": "array", "items": {"type": "string"}}, "controlnet_conditioning_scale": {"type": "integer"}, "guess_mode": {"type": "null"}, "strength": {"type": "integer"}, "resize_by": {"type": "number"}, "sampler": {"type": "string"}}}, "extras": {"type": "object", "properties": {"age": {"type": "integer"}, "gender": {"type": "string"}}}}}}}
2471e490-d9fe-46b8-9238-aba1ff833177/7c48e54f-4ca2-41ce-b60f-2a138f09e8e5/0/0
Image diffusion
Diffusion APIs
2
Anime SD API
design to generate weeb stuff.
200
Example_1
{"status": true, "result": {"metadata": {"mimetype": "string", "prompt": "string", "width": "string", "height": "string", "batch_size": "string", "steps": "string", "cfg_scale": "string", "images": ["encoding_base64"]}}}
{"type": "object", "properties": {"status": {"type": "boolean"}, "result": {"type": "object", "properties": {"metadata": {"type": "object", "properties": {"mimetype": {"type": "string"}, "prompt": {"type": "string"}, "width": {"type": "string"}, "height": {"type": "string"}, "batch_size": {"type": "string"}, "steps": {"type": "string"}, "cfg_scale": {"type": "string"}, "images": {"type": "array", "items": {"type": "string"}}}}}}}}
2471e490-d9fe-46b8-9238-aba1ff833177/e31abffa-a2b2-4e2e-9421-d79f32ba0786/0/0
Image diffusion
Diffusion APIs
2
Prompter
generate prompt from image url
200
Example_1
{"status": true, "result": {"model": "str", "prompt": "..generated prompt in here"}}
{"type": "object", "properties": {"status": {"type": "boolean"}, "result": {"type": "object", "properties": {"model": {"type": "string"}, "prompt": {"type": "string"}}}}}
2471e490-d9fe-46b8-9238-aba1ff833177/618c2172-35f3-4704-a42b-54bc5652f6f5/0/0
Image diffusion
Diffusion APIs
2
Stable SD API
Stable SD aAPI
200
JSON
{"status": true, "result": {"images": ["https://example.com/image.jpg"], "metadata": {"sensitive_content": false, "prompt": "str"}}}
{"type": "object", "properties": {"status": {"type": "boolean"}, "result": {"type": "object", "properties": {"images": {"type": "array", "items": {"type": "string"}}, "metadata": {"type": "object", "properties": {"sensitive_content": {"type": "boolean"}, "prompt": {"type": "string"}}}}}}}
2471e490-d9fe-46b8-9238-aba1ff833177/618c2172-35f3-4704-a42b-54bc5652f6f5/1/0
Image diffusion
Diffusion APIs
2
Stable SD API
Stable SD aAPI
400
Response
{"status": false, "message": "Missing parameter prompt"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "boolean"}, "message": {"type": "string"}}, "required": ["message", "status"]}
2471e490-d9fe-46b8-9238-aba1ff833177/908a5601-786d-4640-ade7-60668c356fc7/0/0
Image diffusion
Diffusion APIs
2
Remove Background
Remove the given image url background
200
New Example
{"status": true, "result": {"type": "url", "mimetype": "image/png", "images": ["https://example.com/image.png"]}}
{"type": "object", "properties": {"status": {"type": "boolean"}, "result": {"type": "object", "properties": {"type": {"type": "string"}, "mimetype": {"type": "string"}, "images": {"type": "array", "items": {"type": "string"}}}}}}
2471e490-d9fe-46b8-9238-aba1ff833177/f04678ac-99bc-49b3-a0d4-a7de69b49058/0/0
Image diffusion
Diffusion APIs
2
Fast SD API
Fast and simple sd api
200
Success reponse
{"status": true, "result": {"images": ["https://api.itsrose.life/out/y2xWzk.jpg"], "metadata": {"prompt": "(dark shot:1.1), epic realistic, portrait of halo, sunglasses, blue eyes, tartan scarf, white hair by atey ghailan, by greg rutkowski, by greg tocchini, by james gilleard, by joe fenton, by kaethe butcher, gradient yellow, black, brown and magenta color scheme, grunge aesthetic!!! graffiti tag wall background, art by greg rutkowski and artgerm, soft cinematic light, adobe lightroom, photolab, hdr, intricate, highly detailed, (depth of field:1.4), faded, (neutral colors:1.2), (hdr:1.4), (muted colors:1.2), hyperdetailed, (artstation:1.4), cinematic, warm lights, dramatic light, (intricate details:1.1), complex background, (rutkowski:0.66), (teal and orange:0.4)", "negative_prompt": "3d, cartoon, lowres, bad anatomy, bad hands, text, error, missing fingers, extra digit, fewer digits, cropped, worst quality, low quality, normal quality, jpeg artifacts, signature, watermark, username, blurry, artist name, young, loli, elf, 3d, illustration", "sampler": "Euler a", "seed": -1, "ratio": "1:1", "style": "realistic", "init_image": false, "cfg": "7.0", "image_num": 1, "controlNet": "none", "steps": 25}}}
{"type": "object", "properties": {"status": {"type": "boolean"}, "result": {"type": "object", "properties": {"images": {"type": "array", "items": {"type": "string"}}, "metadata": {"type": "object", "properties": {"prompt": {"type": "string"}, "negative_prompt": {"type": "string"}, "sampler": {"type": "string"}, "seed": {"type": "integer"}, "ratio": {"type": "string"}, "style": {"type": "string"}, "init_image": {"type": "boolean"}, "cfg": {"type": "string"}, "image_num": {"type": "integer"}, "controlNet": {"type": "string"}, "steps": {"type": "integer"}}}}}}}