ACRCloud
Visit WebsiteConsole
  • Introduction
  • Get Started
  • Console Tutorials
    • Recognize Music
    • Recognize Custom Content
    • Broadcast Monitoring for Music
    • Broadcast Monitoring for Custom Content
    • Detect Live & Timeshift TV Channels
    • Recognize Custom Content Offline
    • Recognize Live Channels and Custom Content
    • Find Potential Detections in Unknown Content Filter
  • SDK REFERENCE
    • Mobile SDK
      • iOS
      • Android
      • Unity
    • Backend SDK
      • Python
      • PHP
      • Go
      • Java
      • C/C++
      • C#
    • Error Codes
  • API Reference
    • Identification API
    • Console API
      • Access Token
      • Buckets
        • Audio Files
        • Live Channels
        • Dedup Files
      • Base Projects
      • OfflineDBs
      • BM Projects
        • Custom Streams Projects
          • Streams
          • Streams Results
          • Streams State
          • Recordings
          • Analytics
          • User Reports
        • Broadcast Database Projects
          • Channels
          • Channels Results
          • Channels State
          • Recordings
          • Analytics
          • User Reports
      • File Scanning
        • FsFiles
      • UCF Projects
        • BM Streams
        • UCF Results
    • Metadata API
  • Tools
    • Audio File Fingerprinting Tool
    • Local Monitoring Tool
    • Live Channel Fingerprinting Tool
    • File Scan Tool
  • Metadata
    • Music
    • Music (Broadcast Monitoring with Broadcast Database)
    • Custom Files
    • Live Channels
    • Humming
  • FAQ
    • Definition of Terms
  • Service Usage
Powered by GitBook
On this page
  • Create a FS container
  • Get all the containers
  • Show one container
  • Delete one container
  1. API Reference
  2. Console API

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

```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
        },
        "engine": 1,
        "callback_url": null,
        "created_at": "2023-04-28T07:53:40.000000Z",
        "updated_at": "2023-04-28T07:53:40.000000Z"
    }
}
```
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

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

{
    "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

Last updated 1 year ago