File Scanning

get
List the files and results

https://api-v2.acrcloud.com/api/fs-containers/:container_id/files
This endpoint will not show the youtube channels/playlists results.
Request
Response
Request
Path Parameters
container_id
required
number
The container id
Headers
Authentication
required
string
Bearer token
Query Parameters
page
optional
number
The page number
per_page
optional
number
The results number per page
search
optional
string
Search by name or URI
Response
200: OK
Successfully retrieved.
{
"data":[
{
"id":"fd0cbc13-bb69-41ed-abbb-1ed6f25c3b02",
"uid":19,
"cid":10005,
"name":"Camilo - Millones (Official Video)",
"duration":222,
"uri":"youtube:video:krP539YBF7U",
"data_type":"youtube",
"method":1,
"count":1,
"state":1,
"created_at":"2021-04-08T10:23:29.000000Z",
"updated_at":"2021-04-23T02:58:04.000000Z",
"total":1,
"results":{
"music":[
{
"played_duration":220,
"type":"traverse",
"result":{
"album":{
"name":"Mis Manos"
},
"play_offset_ms":19780,
"sample_begin_time_offset_ms":0,
"contributors":{
"composers":[
"Camilo Echeverry",
"Édgar Barrera"
],
"lyricists":[
"Camilo Echeverry",
"Édgar Barrera"
]
},
"title":"Millones",
"result_from":3,
"release_date":"2021-03-04",
"sample_end_time_offset_ms":9440,
"genres":[
{
"name":"Latin Pop"
}
],
"label":"SME - Sony Music Latin",
"db_end_time_offset_ms":19300,
"score":100,
"db_begin_time_offset_ms":9860,
"artists":[
{
"name":"Camilo"
}
],
"duration_ms":221000,
"external_ids":{
"isrc":"USSD12100051",
"upc":"886449088867"
},
"acrid":"300f34d92ec1f3a7397bb2bb9cddf884",
"external_metadata":{
"spotify":{
"album":{
"name":"Mis Manos"
},
"track":{
"name":"Millones",
"id":"3YAnNBdk0uHyakXXzMbNJq"
},
"artists":[
{
"name":"Camilo"
}
]
},
"deezer":{
"album":{
"name":""
},
"track":{
"name":"Millones",
"id":"1260566282"
},
"artists":[
{
"name":"Camilo"
}
]
}
}
},
"offset":0
}
]
}
},
{
"id":"5c2cfaa2-6024-4775-ac24-1aa7b4786c86",
"uid":19,
"cid":10005,
"name":"Lil Tjay - Love Hurts (Feat. Toosii) [Official Video]",
"duration":247,
"uri":"youtube:video:V-IDVYH3YjA",
"data_type":"youtube",
"method":1,
"count":1,
"state":1,
"created_at":"2021-04-08T08:26:55.000000Z",
"updated_at":"2021-04-23T02:58:04.000000Z",
"total":1,
"results":{
"music":[
{
"played_duration":5,
"type":"traverse",
"result":{
"album":{
"name":"my ex called"
},
"play_offset_ms":6440,
"sample_begin_time_offset_ms":4260,
"title":"my ex called",
"result_from":3,
"release_date":"2020-02-21",
"sample_end_time_offset_ms":8860,
"label":"Thrill$",
"db_end_time_offset_ms":4600,
"score":100,
"db_begin_time_offset_ms":0,
"artists":[
{
"name":"Thrill$"
}
],
"duration_ms":168920,
"external_ids":{
"isrc":"QZJG52083365",
"upc":"194923628486"
},
"acrid":"269e27604f4be4c3167fc3751f5551c3",
"external_metadata":{
"deezer":{
"album":{
"name":""
},
"track":{
"name":"Havit",
"id":"1098021672"
},
"artists":[
{
"name":"Of_mannyg"
}
]
}
}
},
"offset":14
},
{
"played_duration":14,
"type":"traverse",
"result":{
"album":{
"name":"Lost Files"
},
"play_offset_ms":5340,
"sample_begin_time_offset_ms":4080,
"title":"In the Streets",
"result_from":1,
"release_date":"2020-10-26",
"sample_end_time_offset_ms":9260,
"label":"Hitta Huncho",
"db_end_time_offset_ms":5180,
"score":100,
"db_begin_time_offset_ms":0,
"artists":[
{
"name":"Hitta Huncho"
}
],
"duration_ms":160940,
"external_ids":{
"isrc":"TCAFE2056515",
"upc":"859742903298"
},
"acrid":"e63ee358a9357a1e181cd8ce858d78fd",
"external_metadata":{
"deezer":{
"album":{
"name":""
},
"track":{
"name":"In the Streets",
"id":"1131507852"
},
"artists":[
{
"name":"Hitta Huncho"
}
]
}
}
},
"offset":24
},
{
"played_duration":209,
"type":"traverse",
"result":{
"album":{
"name":"Destined 2 Win"
},
"play_offset_ms":25880,
"sample_begin_time_offset_ms":0,
"title":"Love Hurts",
"result_from":1,
"release_date":"2021-04-02",
"sample_end_time_offset_ms":8200,
"genres":[
{
"name":"Hip Hop"
}
],
"label":"Columbia",
"db_end_time_offset_ms":24100,
"score":100,
"db_begin_time_offset_ms":15900,
"artists":[
{
"name":"Lil Tjay"
}
],
"duration_ms":222100,
"external_ids":{
"isrc":"USSM12101539",
"upc":"886449173587"
},
"acrid":"d981bc8a8a55b06d15d5ea0f4957873c",
"external_metadata":{
"spotify":{
"album":{
"name":"Destined 2 Win"
},
"track":{
"name":"Love Hurts (feat. Toosii)",
"id":"2ULQtFHTzUK0DqcqWUlXxw"
},
"artists":[
{
"name":"Lil Tjay"
},
{
"name":"Toosii"
}
]
}
}
},
"offset":30
}
]
}
}
],
"links":{
"first":"https://ap-api-v2.acrcloud.com/api/fs-containers/10005/files?page=1",
"last":"https://ap-api-v2.acrcloud.com/api/fs-containers/10005/files?page=1",
"prev":null,
"next":null
},
"meta":{
"current_page":1,
"from":1,
"last_page":1,
"path":"https://ap-api-v2.acrcloud.com/api/fs-containers/10005/files",
"per_page":"20",
"to":2,
"total":2
}
}
Curl
Python
Curl
curl --location --request GET 'https://api-v2.acrcloud.com/api/fs-containers/:your_container_id/files?page=1&per_page=20' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YourAccessToken'
Python
import requests
url = "https://api-v2.acrcloud.com/api/fs-containers/:your_container_id/files?page=1&per_page=20"
payload={}
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer token'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)

post
Upload a file or youtube URI

https://api-v2.acrcloud.com/api/fs-containers/:container_id/files
Request
Response
Request
Path Parameters
container_id
required
number
The container id
Headers
Authentication
required
string
Bearer token
Form Data Parameters
file
optional
object
The audio or fingerprint file, "audio" data_type requires this field.
data_type
required
string
audio,fingerprint,youtube
uri
optional
string
If the data_type is youtube, the uri format should like this: youtube:video:krP539YBF7U youtube:channel:UCqECaJ8Gagnn7YCbPEzWH6g youtube:playlist:PLINj2JJM1jxMlmDr3lG66mh_V58rYfeKu
Response
200: OK
{
"data": {
"uid": 19,
"cid": 10005,
"name": "886443683402_US4D80623007.lo",
"duration": 159.56,
"uri": "audio:886443683402_US4D80623007.lo",
"data_type": "audio",
"method": 1,
"count": 0,
"state": 0,
"updated_at": "2021-04-23T07:33:21.000000Z",
"created_at": "2021-04-23T07:33:21.000000Z",
"id": "9d0f2c36-0265-46c2-b3e4-c0c2d0b9eb92",
"total": 1
}
}
Curl
Python
PHP
Curl
curl --location --request POST 'https://api-v2.acrcloud.com/api/fs-containers/10005/files' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer token' \
--form '[email protected]"/Users/olym/Downloads/886443683402_US4D80623007.mp3"' \
--form 'data_type="audio"'
Python
import requests
url = "https://api-v2.acrcloud.com/api/fs-containers/10005/files"
payload={'data_type': 'audio'}
files=[
('file',('886443683402_US4D80623007.mp3',open('886443683402_US4D80623007.mp3','rb'),'application/octet-stream'))
]
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer token'
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api-v2.acrcloud.com/api/fs-containers/10005/files',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('file'=> new CURLFILE('886443683402_US4D80623007.lo'),'data_type' => 'fingerprint'),
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI2IiwianRpIjoiZGMzNjIyOThhMDAyN2NmZDMzZGU3MjBhYThhY2I0MTgyMzJhN2I5ZTA4MzdjNTI0M2UxODIxYzcwMTA5NDIwZTg0ZGJhY2Q4YTRhZWM0YzAiLCJpYXQiOjE2MTg4MjA1NTAuMDA2OTYzLCJuYmYiOjE2MTg4MjA1NTAuMDA2OTY3LCJleHAiOjE2NTAzNTY1NDkuOTkwNTQxLCJzdWIiOiIxOSIsInNjb3BlcyI6WyIqIl19.G7L5T2fQljhK2D1za669Q3cIIbyBT0oE8Z_IWQyL0sofZvIOYymVqW55w6b_nX6emkJj7JfylAI7q7-CVxXUN4tRcJCv9-AxFprhQubKvy59_6B5jd38jsOGHdlmMN5x7Mt3xl9WUPd1ODFg6Vqp3tR3nQ9J9eqUjrZgu54Yyx-1_gekBx87GCvcJxfmiDTBmr8J4Ze5099W_Bsj5UHGUb1X-GhNxVzfTFranTsvSEFDEA5jrBvNGIRkvqMUCx4jK7sJstlnlvTUmJ6WK0owl946ULiJhPe5jlM2_CKDckw81Ri6ecV1zAOWncTWi1Oa5qUkpEVf6pBtzk4_OLLjWUZ3MRz7xO2BiFYTuWxaQKNL9W4RhWbsf'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

get
Show the one file's results

https://api-v2.acrcloud.com/api/fs-containers/:container_id/files/:file_id
Suit for getting the youtube channels/playlists results
Request
Response
Request
Path Parameters
container_id
required
number
The container id
file_id
required
number
The file id
Headers
Authentication
required
string
Bearer token
Query Parameters
page
optional
string
The page number
per_page
optional
string
The results number per page
search
optional
string
Search by the name or youtube id
Response
200: OK
{
"data": [
{
"playlist_id": "PLHFeMk_LSwG5pMfNQyeaqk4bUBPiFvPXF",
"vid": "1UFc0CQzVt4",
"title": "Beyoncé X10: Walk To Stage",
"duration": 51,
"created_at": "2021-04-23T05:53:39.000000Z",
"results": null,
"state": 0
},
{
"playlist_id": "PLHFeMk_LSwG5pMfNQyeaqk4bUBPiFvPXF",
"vid": "i8FjKlOdd3U",
"title": "Beyoncé X10: Album Release Party",
"duration": 51,
"created_at": "2021-04-23T05:53:39.000000Z",
"results": null,
"state": 0
},
{
"playlist_id": "PLHFeMk_LSwG5pMfNQyeaqk4bUBPiFvPXF",
"vid": "0aip4XarbNM",
"title": "The 2015 Official Calendar",
"duration": 15,
"created_at": "2021-04-23T05:53:39.000000Z",
"results": {
"music": [
{
"count": 1,
"type": "points",
"result": {
"album": {
"name": "Carter (Deluxe Edition)"
},
"play_offset_ms": 98020,
"sample_begin_time_offset_ms": 0,
"title": "Yoncé",
"result_from": 3,
"release_date": "2016-01-11",
"sample_end_time_offset_ms": 8760,
"label": "Fél Carter",
"db_end_time_offset_ms": 97000,
"score": 100,
"db_begin_time_offset_ms": 88240,
"artists": [
{
"name": "Fél Carter"
}
],
"duration_ms": 103000,
"external_ids": {
"isrc": "BRBMG0499954",
"upc": "1827849181757"
},
"acrid": "d5e4f462af3d648d02fb6b22325b22c0",
"external_metadata": {
"deezer": {
"album": {
"name": "Carter (Deluxe Edition)"
},
"track": {
"name": "Yoncé",
"id": "117149072"
},
"artists": [
{
"name": "Fél Carter"
}
]
}
}
},
"offset": 0
}
]
},
"state": 1
},
{
"playlist_id": "PLHFeMk_LSwG5pMfNQyeaqk4bUBPiFvPXF",
"vid": "LmFjwtdCimQ",
"title": "BEYONCÉ Platinum Edition Box Set",
"duration": 21,
"created_at": "2021-04-23T05:53:39.000000Z",
"results": null,
"state": 0
},
{
"playlist_id": "PLHFeMk_LSwG5pMfNQyeaqk4bUBPiFvPXF",
"vid": "k4YRWT_Aldo",
"title": "Beyoncé - 7/11",
"duration": 217,
"created_at": "2021-04-23T05:53:39.000000Z",
"results": {
"music": [
{
"count": 3,
"type": "points",
"result": {
"album": {
"name": "BEYONCÉ [Platinum Edition]"
},
"play_offset_ms": 42460,
"sample_begin_time_offset_ms": 0,
"lyrics": {
"copyrights": [
"Kobalt Music Publishing Ltd.",
"Sony/ATV Music Publishing LLC",
"Warner/Chappell Music",
"Inc."
]
},
"contributors": {
"composers": [
"Sidney Swift",
"Noel Fisher",
"Beyoncé",
"Adrian Bruesch"
],
"lyricists": [
"Noel Fisher",
"Adrian Bruesch",
"Beyonce Knowles",
"Sidney Swift"
]
},
"title": "7/11",
"result_from": 3,
"release_date": "2014-11-24",
"sample_end_time_offset_ms": 8820,
"genres": [
{
"name": "Pop"
}
],
"label": "Parkwood Entertainment/Columbia",
"duration_ms": 213520,
"score": 100,
"db_begin_time_offset_ms": 32700,
"artists": [
{
"name": "Beyoncé"
}
],
"db_end_time_offset_ms": 41520,
"external_ids": {
"isrc": "USSM11408532",
"iswc": "T-803.469.303-4",
"upc": "886444975025"
},
"acrid": "a201b20cf560b893e636954c4976eb93",
"external_metadata": {
"musicbrainz": [
{
"track": {
"id": "f9e47e74-b21b-4adb-b47d-732006ade023"
}
}
],
"spotify": {
"album": {
"name": "BEYONCÉ [Platinum Edition]"
},
"track": {
"name": "7/11",
"id": "1A7QIlETJSCFXzyp3cSbak"
},
"artists": [
{
"name": "Beyoncé"
}
]
},
"deezer": {
"album": {
"name": "BEYONCÉ [Platinum Edition]",
"id": "9163719"
},
"track": {
"name": "7/11",
"id": "90408897"
},
"artists": [
{
"name": "Beyoncé",
"id": "145"
}
]
},
"youtube": {
"vid": "k4YRWT_Aldo"
}
}
},
"offset": 0
}
]
},
"state": 1
},
{
"playlist_id": "PLHFeMk_LSwG5pMfNQyeaqk4bUBPiFvPXF",
"vid": "v01C7uQ9yUg",
"title": "BEYONCÉ Platinum Edition",
"duration": 16,
"created_at": "2021-04-23T05:53:39.000000Z",
"results": {
"music": [
{
"count": 1,
"type": "points",
"result": {
"album": {
"name": "I Created The Remix"
},
"play_offset_ms": 153020,
"sample_begin_time_offset_ms": 0,
"title": "Yonce",
"result_from": 3,
"release_date": "2018-04-06",
"sample_end_time_offset_ms": 8980,
"label": "Luvproductionz Music Group",
"db_end_time_offset_ms": 152140,
"score": 100,
"db_begin_time_offset_ms": 143160,
"artists": [
{
"name": "LV the Voice"
}
],
"duration_ms": 305060,
"external_ids": {
"isrc": "QMEZE1809133",
"upc": "5054960589049"
},
"acrid": "25fdb1fb21afb8247eacf69290e6bc93",
"external_metadata": {
"spotify": {
"album": {
"name": "I Created The Remix"
},
"track": {
"name": "Yonce - Remix",
"id": "3IgjRehr5wPC4RICcoJHyZ"
},
"artists": [
{
"name": "LV The Voice"
}
]
}
}
},
"offset": 0
}
]
},
"state": 1
}
],
"links": {
"first": "https://ap-api-v2.acrcloud.com/api/fs-containers/10055/files/f60c40d8-f35e-488e-bca4-105d85b080dc?page=1",
"last": "https://ap-api-v2.acrcloud.com/api/fs-containers/10055/files/f60c40d8-f35e-488e-bca4-105d85b080dc?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https://ap-api-v2.acrcloud.com/api/fs-containers/10055/files/f60c40d8-f35e-488e-bca4-105d85b080dc",
"per_page": "20",
"to": 6,
"total": 6
}
}
Curl
Python
Curl
curl --location --request GET 'https://api-v2.acrcloud.com/api/fs-containers/:your_container_id/files/f60c40d8-f35e-488e-bca4-105d85b080dc' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YourAccessToken'
Python
import requests
url = "https://api-v2.acrcloud.com/api/fs-containers/:your_container_id/files/f60c40d8-f35e-488e-bca4-105d85b080dc"
payload={}
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer token'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)