File Scanning

Create a FS container

POST https://api-v2.acrcloud.com/api/fs-containers

Headers

Name	Type	Description
Authorization*	String	Bearer your_token

Request Body

Name	Type	Description
name*	String	Your container name
region*	String	eu-west-1,us-west-2,ap-southeast-1
audio_type*	String	linein or recorded. Default is linein linein: Audio of original file or stream without noise recorded: Audio captured via microphone or noisy audio files
buckets*	Array	The project detects content from the buckets. The format is bucket id/name array. For example: [8881,8882,"ACRCloud Music"]
engine*	Number	1:Audio Fingerprinting 2:Cover Songs 3:Audio Fingerprinting & Cover songs 4:Speech to Text
policy*	JSON	{"type":"traverse", "interval":0, "rec_length:10} or {"type":"points", "points":3}
callback_url	String	Result callback url
deepright	Bool	0 or 1 0: disable the derivative works detection 1: enable the derivative works detection
music_detection	Bool	0 or 1 0: disable music/speech detection 1: enable music/speech detection
ai_detection	Bool	0 or 1 0: disable ai detection 1: enable ai detection

201: Created

```json
{
    "data": {
        "id": 123456,
        "uid": 123,
        "region": "eu-west-1",
        "name": "container name",
        "buckets": [
            {
                "id": 23,
                "name": "ACRCloud Music",
                "type": "ACRCloudFile",
                "metadata_template": null
            }
        ],
        "audio_type": "linein",
        "num": 1,
        "size": 14,
        "policy": {
            "type": "traverse",
            "interval": 0,
            "rec_length": 10,
            "ai_detection": 1,
            "deepright":true
        },
        "engine": 1,
        "callback_url": null,
        "created_at": "2023-04-28T07:53:40.000000Z",
        "updated_at": "2023-04-28T07:53:40.000000Z"
    }
}
```

Python

import requests

url = "https://api-v2.acrcloud.com/api/fs-containers"

payload={
  "name":"test", 
  "region":"eu-west-1", 
  "buckets":[8881,8882,"ACRCloud Music"],
  "audio_type":"linein",
  "engine":1,
  "policy":{"type":"traverse", "interval":0, "rec_length":10}
}
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer token',
  'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers, json=payload)

print(response.text)

Get all the containers

GET https://api-v2.acrcloud.com/api/fs-containers

Headers

Name	Type	Description
Authorization*	String	Bearer your_token
Content-Type	String	application/json

Query Parameters

Name	Type	Description
region	String	list the continers in the region. eu-west-1 us-west-2 ap-southeast-1
name	String	search by name

200: OK

Update a container

PUT https://api-v2.acrcloud.com/api/fs-containers/:container_id

Headers

Name	Type	Description
Authorization*	String	Bearer your_token
Content-Type	String	application/json

Request Body

Name	Type	Description
name	String	Your container name
audio_type	String	linein or recorded. Default is linein linein: Audio of original file or stream without noise recorded: Audio captured via microphone or noisy audio files
buckets	Array	The project detects content from the buckets. The format is bucket id/name array. For example: [8881,8882,"ACRCloud Music"]
engine	Number	1:Audio Fingerprinting 2:Cover Songs 3:Audio Fingerprinting & Cover songs 4:Speech to Text
policy	JSON	{"type":"traverse", "interval":0, "rec_length:10} or {"type":"points", "points":3}
callback_url	String	Result callback url
deepright	Bool	0 or 1 0: disable the derivative works detection 1: enable the derivative works detection
music_detection	Bool	0 or 1 0: disable music/speech detection 1: enable music/speech detection
ai_detection	Bool	0 or 1 0: disable ai detection 1: enable ai detection

Python

import requests

url = "https://api-v2.acrcloud.com/api/fs-containers/123456"

payload={
  "name":"test", 
  "buckets":["ACRCloud Music"],
  "audio_type":"linein",
  "engine":1,
  "policy":{"type":"traverse", "interval":0, "rec_length":10},
  "deepright":1
}
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer token',
  'Content-Type': 'application/json'
}

response = requests.(url, headers=headers, json=payload)

print(response.text)

200: Ok

```json
{
    "data": {
        "id": 123456,
        "uid": 123,
        "region": "eu-west-1",
        "name": "container name",
        "buckets": [
            {
                "id": 23,
                "name": "ACRCloud Music",
                "type": "ACRCloudFile",
                "metadata_template": null
            }
        ],
        "audio_type": "linein",
        "num": 1,
        "size": 14,
        "policy": {
            "type": "traverse",
            "interval": 0,
            "rec_length": 10,
            "ai_detection": 1,
            "deepright":true
        },
        "engine": 1,
        "callback_url": null,
        "created_at": "2023-04-28T07:53:40.000000Z",
        "updated_at": "2023-04-28T07:53:40.000000Z"
    }
}
```

Show one container

GET https://api-v2.acrcloud.com/api/fs-containers/:container_id

Headers

Name	Type	Description
Authorization*	String	Bearer your_token
Content-Type	String	application/json

200: OK

{
    "data": {
        "id": 123456,
        "uid": 123,
        "region": "eu-west-1",
        "name": "container name",
        "buckets": [
            {
                "id": 23,
                "name": "ACRCloud Music",
                "type": "ACRCloudFile",
                "metadata_template": null
            }
        ],
        "audio_type": "linein",
        "num": 1,
        "size": 14,
        "policy": {
            "type": "traverse",
            "interval": 0,
            "rec_length": 10
        },
        "engine": 1,
        "callback_url": null,
        "created_at": "2023-04-28T07:53:40.000000Z",
        "updated_at": "2023-04-28T07:53:40.000000Z"
    }
}

Delete one container

DELETE https://api-v2.acrcloud.com/api/fs-containers/:container_id

Path Parameters

Name	Type	Description
container_id*	Number	The Container ID

Headers

Name	Type	Description
Authorization*	String	Bearer your_token
Content-Type	String	application/json

204: No Content