Salta ai contenuti

Riferimento dell'API

Il riferimento per gli sviluppatori: cosa si aspetta e cosa restituisce ogni rotta. Per ottenere una chiave e vedere cosa può raggiungere, leggi prima API.

La versione è in ogni percorso: /api/v1. Nella versione 1 rotte e campi vengono solo aggiunti, mai rinominati o rimossi: ignora i campi che non conosci. Una modifica che romperebbe il tuo codice arriva come nuova versione (/api/v2), con la v1 ancora attiva accanto.

Tieni l’indirizzo dell’API e la tua chiave in variabili d’ambiente, poi chiamala con qualsiasi client HTTP: nessun SDK da installare.

Finestra del terminale
export JAMCLOUD_API=https://api-jamcloud.australfactory.cl
export JAMCLOUD_KEY=jc_…
curl -H "Authorization: Bearer $JAMCLOUD_KEY" "$JAMCLOUD_API/api/v1/groups"
import os, requests
api = os.environ["JAMCLOUD_API"] + "/api/v1"
s = requests.Session()
s.headers["Authorization"] = "Bearer " + os.environ["JAMCLOUD_KEY"]
workspaces = s.get(f"{api}/groups").json()
tracks = s.get(f"{api}/groups/{workspaces[0]['id']}/files", params={"limit": 20}).json()["items"]
const api = `${process.env.JAMCLOUD_API}/api/v1`;
const headers = { Authorization: `Bearer ${process.env.JAMCLOUD_KEY}` };
const res = await fetch(`${api}/groups`, { headers });
if (!res.ok) throw new Error((await res.json()).code); // stable error code
const workspaces = await res.json();
  • JSON in entrata e in uscita, campi in snake_case, gli id sono UUID.
  • Le liste rispondono {items, total, limit, offset}; pagina con i parametri limit e offset.
  • Gli errori sono problem+json {type, title, status, code, details}: controlla code, non cambia mai.
  • Un caricamento richiede tre chiamate: presign, PUT del file all’URL restituito, poi confirm. L’URL vale 15 minuti e accetta esattamente la size dichiarata, in un solo PUT.
  • 503 circuit_open: attendi i secondi di Retry-After, poi riprova.

Ogni sezione qui sotto è una risorsa; ogni rotta indica parametri, campi, risposta e un esempio curl.

Versione dell’API: v1 · ogni route qui sotto inizia con /api/v1

List Boards

The workspace’s free boards (track boards are reached through their file).

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì
limit query integer
offset query integer

Restituisce 200 · Page_BoardOut_

Campo Tipo Obbligatorio Descrizione
items array of BoardOut sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/boards" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Board

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Corpo · BoardIn

Campo Tipo Obbligatorio Descrizione
title string sì

Restituisce 201 · BoardDetail

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
file_id string (uuid) | null sì
created_by string (uuid) | null sì
title string sì
version integer sì
item_count integer sì
can_write boolean sì
created_at string (date-time) sì
updated_at string (date-time) sì
items array of BoardItemOut sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/boards" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"title":"…"}'

Get Track Board

The file’s board, created empty on first read.

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 200 · BoardDetail

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
file_id string (uuid) | null sì
created_by string (uuid) | null sì
title string sì
version integer sì
item_count integer sì
can_write boolean sì
created_at string (date-time) sì
updated_at string (date-time) sì
items array of BoardItemOut sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/board" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Board

Parametri

Nome In Tipo Obbligatorio Descrizione
board_id path string (uuid) sì

Restituisce 200 · BoardDetail

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
file_id string (uuid) | null sì
created_by string (uuid) | null sì
title string sì
version integer sì
item_count integer sì
can_write boolean sì
created_at string (date-time) sì
updated_at string (date-time) sì
items array of BoardItemOut sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/boards/{board_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Rename Board

Parametri

Nome In Tipo Obbligatorio Descrizione
board_id path string (uuid) sì

Corpo · BoardPatch

Campo Tipo Obbligatorio Descrizione
title string sì

Restituisce 200 · BoardOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
file_id string (uuid) | null sì
created_by string (uuid) | null sì
title string sì
version integer sì
item_count integer sì
can_write boolean sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/boards/{board_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"title":"…"}'

Delete Board

Owner only; a track’s board can’t be deleted on its own.

Parametri

Nome In Tipo Obbligatorio Descrizione
board_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/boards/{board_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Apply Ops

Apply a batch of item ops in one transaction, then broadcast them on the board’s realtime channel ({"kind": "board", "board_id", "version", "client_id", "user_id", "ops"}).

Parametri

Nome In Tipo Obbligatorio Descrizione
board_id path string (uuid) sì

Corpo · OpsIn

Campo Tipo Obbligatorio Descrizione
client_id string sì
ops array of UpsertOp | DeleteOp | ClearOp sì

Restituisce 200 · OpsOut

Campo Tipo Obbligatorio Descrizione
version integer sì
items array of ItemRev sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/boards/{board_id}/ops" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"client_id":"…","ops":[{}]}'

Get Chart

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 200 · ChartOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
file_id string (uuid) sì
content object sì
anchor_bar integer sì
source string sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/chart" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Put Chart

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · ChartIn

Campo Tipo Obbligatorio Descrizione
content ChartContent sì
anchor_bar integer
source “manual” | “import”

Restituisce 200 · ChartOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
file_id string (uuid) sì
content object sì
anchor_bar integer sì
source string sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X PUT "$JAMCLOUD_API/api/v1/files/{file_id}/chart" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"content":{}}'

Delete Chart

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/chart" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Score

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 200 · ScoreOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
file_id string (uuid) sì
status “processing” | “ready” | “failed” sì
format “guitarpro” | “musicxml” | null sì
source_format string sì
original_filename string sì
title string sì
anchor_bar integer sì
settings object sì
error_code string | null sì
error_message string | null sì
url string | null sì
original_url string sì
revision integer sì
edited_at string (date-time) | null sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/score" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Upload Score

Upload the file’s score, replacing any existing one. Guitar Pro / MusicXML are ready at once (201); MuseScore, TablEdit, MIDI, TuxGuitar and Power Tab are converted to MusicXML in the background (202, status: processing, then a score_import_progress notification).

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 201 · ScoreOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
file_id string (uuid) sì
status “processing” | “ready” | “failed” sì
format “guitarpro” | “musicxml” | null sì
source_format string sì
original_filename string sì
title string sì
anchor_bar integer sì
settings object sì
error_code string | null sì
error_message string | null sì
url string | null sì
original_url string sì
revision integer sì
edited_at string (date-time) | null sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/score" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Score

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · ScorePatch

Campo Tipo Obbligatorio Descrizione
anchor_bar integer | null
settings object | null

Restituisce 200 · ScoreOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
file_id string (uuid) sì
status “processing” | “ready” | “failed” sì
format “guitarpro” | “musicxml” | null sì
source_format string sì
original_filename string sì
title string sì
anchor_bar integer sì
settings object sì
error_code string | null sì
error_message string | null sì
url string | null sì
original_url string sì
revision integer sì
edited_at string (date-time) | null sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/files/{file_id}/score" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Score

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/score" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Save Score Content

Save the score edited in the app (Guitar Pro 7). base_revision = the revision the edit started from: 409 score_conflict when someone saved in between. The original upload stays downloadable (original_url).

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 200 · ScoreOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
file_id string (uuid) sì
status “processing” | “ready” | “failed” sì
format “guitarpro” | “musicxml” | null sì
source_format string sì
original_filename string sì
title string sì
anchor_bar integer sì
settings object sì
error_code string | null sì
error_message string | null sì
url string | null sì
original_url string sì
revision integer sì
edited_at string (date-time) | null sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X PUT "$JAMCLOUD_API/api/v1/files/{file_id}/score/content" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Export File

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · ExportIn

Campo Tipo Obbligatorio Descrizione
download_mode “original” | “process”
include_stems boolean
format “wav” | “mp3” | “ogg” | “flac” | “aac”
codec string
sample_rate integer
channels integer
bitrate integer | null
vbr boolean
bit_depth integer
file_name string

Restituisce 202 · ExportJobOut

Campo Tipo Obbligatorio Descrizione
job_id string sì
file_id string | null
status “queued” | “processing” | “ready” | “failed” sì
filename string | null
url string | null
expires_in integer | null
code string | null

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/export" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Export Status

The requester’s export job; a fresh download link while it is ready.

Parametri

Nome In Tipo Obbligatorio Descrizione
job_id path string (uuid) sì

Restituisce 200 · ExportJobOut

Campo Tipo Obbligatorio Descrizione
job_id string sì
file_id string | null
status “queued” | “processing” | “ready” | “failed” sì
filename string | null
url string | null
expires_in integer | null
code string | null

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/exports/{job_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Send Feedback

Needs the feedback permission (on for every plan; an admin may turn it off per user). The user agent is read from the request, the rest of the context is sent by the app.

Corpo · FeedbackIn

Campo Tipo Obbligatorio Descrizione
category “bug” | “idea” | “question” | “other” sì
message string sì
group_id string | null The workspace open in the app.
context FeedbackContext

Restituisce 201 · FeedbackOut

Campo Tipo Obbligatorio Descrizione
id string sì
category “bug” | “idea” | “question” | “other” sì
status “new” | “done” sì
created_at string (date-time) sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/feedback" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"category":"bug","message":"…"}'

List Directories

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Restituisce 200 · array of DirectoryOut

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/directories" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Directory

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Corpo · DirectoryIn

Campo Tipo Obbligatorio Descrizione
name string sì

Restituisce 200 · object

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/directories" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"…"}'

Delete Directory

Parametri

Nome In Tipo Obbligatorio Descrizione
directory_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/directories/{directory_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Files

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì
tags query array of string
favorite query boolean | null
search query string
directory_id query string (uuid) | null
limit query integer
offset query integer

Restituisce 200 · Page_FileSummary_

Campo Tipo Obbligatorio Descrizione
items array of FileSummary sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/files" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Recent Files

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Restituisce 200 · array of FileSummary

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/files/recent" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Group Tags

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Restituisce 200 · TagsOut

Campo Tipo Obbligatorio Descrizione
tags array of string sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Batch Delete

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Corpo · BatchIds

Campo Tipo Obbligatorio Descrizione
file_ids array of string (uuid) sì

Restituisce 200 · BatchDeleteOut

Campo Tipo Obbligatorio Descrizione
deleted integer sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/files/batch-delete" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"file_ids":["<uuid>"]}'

Batch Move

Move files to another workspace the caller owns (personal <-> shared, same owner).

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Corpo · BatchMoveIn

Campo Tipo Obbligatorio Descrizione
file_ids array of string (uuid) sì
target_group_id string (uuid) sì

Restituisce 200 · BatchMoveOut

Campo Tipo Obbligatorio Descrizione
moved integer sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/files/batch-move" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"file_ids":["<uuid>"],"target_group_id":"<uuid>"}'

List All Files

Parametri

Nome In Tipo Obbligatorio Descrizione
tags query array of string
favorite query boolean | null
search query string
limit query integer
offset query integer

Restituisce 200 · Page_FileSummary_

Campo Tipo Obbligatorio Descrizione
items array of FileSummary sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Recent All Files

Restituisce 200 · array of FileSummary

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/recent" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

All Tags

Restituisce 200 · TagsOut

Campo Tipo Obbligatorio Descrizione
tags array of string sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get File

Opening a file counts as a play (Django did it on every detail read); pass ?play=false to read without touching play_count / recents.

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì
play query boolean

Restituisce 200 · FileOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
title string sì
description string sì
favorite boolean sì
tags array of string sì
file_size integer sì
total_stems_usage integer sì
uploaded_at string (date-time) sì
last_played_at string (date-time) | null sì
play_count integer sì
directory DirectoryRef | null sì
normalized_metadata object sì
has_cover_art boolean sì
cover_image_url string | null sì
stems array of StemOut sì
analyze TransformationOut | null sì
metadata TransformationOut | null sì
separation TransformationOut | null sì
ml_analysis TransformationOut | null sì
mapping TransformationOut | null
queued_separation TransformationOut | null
parent_id string (uuid) | null
clip ClipOut | null

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch File

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · FilePatch

Campo Tipo Obbligatorio Descrizione
title string | null
description string | null
favorite boolean | null
tags array of string | null
directory_id string (uuid) | null
parent_id null

Restituisce 200 · FileOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
title string sì
description string sì
favorite boolean sì
tags array of string sì
file_size integer sì
total_stems_usage integer sì
uploaded_at string (date-time) sì
last_played_at string (date-time) | null sì
play_count integer sì
directory DirectoryRef | null sì
normalized_metadata object sì
has_cover_art boolean sì
cover_image_url string | null sì
stems array of StemOut sì
analyze TransformationOut | null sì
metadata TransformationOut | null sì
separation TransformationOut | null sì
ml_analysis TransformationOut | null sì
mapping TransformationOut | null
queued_separation TransformationOut | null
parent_id string (uuid) | null
clip ClipOut | null

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/files/{file_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete File

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Extract Clip

Copy [start, end] of the track into a new track of the same workspace (same format, tags and metadata), grouped under the original. A file_ingested notification follows (extract_failed with a code on failure).

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · ExtractIn

Campo Tipo Obbligatorio Descrizione
start number sì
end number sì
title string | null

Restituisce 202 · ExtractOut

Campo Tipo Obbligatorio Descrizione
status string sì
job_id string sì
audio_id string (uuid) sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/extract" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"start":0,"end":0}'

Set Favorite

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · FavoriteIn

Campo Tipo Obbligatorio Descrizione
favorite boolean sì

Restituisce 200 · FileSummary

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
favorite boolean sì
title string sì
description string sì
tags array of string sì
size integer sì
stems_usage integer sì
uploaded_at string (date-time) sì
last_played_at string (date-time) | null sì
directory DirectoryRef | null sì
has_cover_art boolean sì
parent_id string (uuid) | null
clip ClipOut | null
processes object
queue object
bpm number | null
key string | null

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/favorite" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"favorite":false}'

File Tags

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 200 · TagsOut

Campo Tipo Obbligatorio Descrizione
tags array of string sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Add Tags

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · TagsIn

Campo Tipo Obbligatorio Descrizione
tags array of string sì

Restituisce 200 · TagsOut

Campo Tipo Obbligatorio Descrizione
tags array of string sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"tags":["…"]}'

Remove Tag

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì
tag path string sì

Restituisce 200 · TagsOut

Campo Tipo Obbligatorio Descrizione
tags array of string sì

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/tags/{tag}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Metadata

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 200 · MetadataOut

Campo Tipo Obbligatorio Descrizione
normalized object sì
has_cover_art boolean sì
cover_image_url string | null sì
technical object | null sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/metadata" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

File Status

Latest state of every process run on the file (any status).

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 200 · StatusOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
transformations object sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/status" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Delete All Stems

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/stems" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Delete Stem

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì
stem_name path string sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/stems/{stem_name}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Families

Parametri

Nome In Tipo Obbligatorio Descrizione
search query string | null
ordering query string | null
limit query integer
offset query integer

Restituisce 200 · Page_FamilyOut_

Campo Tipo Obbligatorio Descrizione
items array of FamilyOut sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/families" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Families

Corpo · FamilyIn

Campo Tipo Obbligatorio Descrizione
name string sì
description string

Restituisce 201 · FamilyOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
name string sì
description string sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/harmony/families" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"…"}'

Get Families

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 200 · FamilyOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
name string sì
description string sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Families

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Corpo · FamilyPatch

Campo Tipo Obbligatorio Descrizione
name string | null
description string | null

Restituisce 200 · FamilyOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
name string sì
description string sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Families

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Qualities

Parametri

Nome In Tipo Obbligatorio Descrizione
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Restituisce 200 · Page_QualityOut_

Campo Tipo Obbligatorio Descrizione
items array of QualityOut sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/qualities" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Quality

Corpo · QualityIn

Campo Tipo Obbligatorio Descrizione
key string sì
family_id string (uuid) sì
formula array of integer sì
description string

Restituisce 201 · QualityOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
key string sì
family string sì
family_id string (uuid) sì
formula array of integer sì
aliases array of AliasOut sì
description string sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/harmony/qualities" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"key":"…","family_id":"<uuid>","formula":[0]}'

Get Quality

Parametri

Nome In Tipo Obbligatorio Descrizione
key path string sì

Restituisce 200 · QualityOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
key string sì
family string sì
family_id string (uuid) sì
formula array of integer sì
aliases array of AliasOut sì
description string sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Quality

Parametri

Nome In Tipo Obbligatorio Descrizione
key path string sì

Corpo · QualityPatch

Campo Tipo Obbligatorio Descrizione
key string | null
family_id string (uuid) | null
formula array of integer | null
description string | null

Restituisce 200 · QualityOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
key string sì
family string sì
family_id string (uuid) sì
formula array of integer sì
aliases array of AliasOut sì
description string sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Quality

Parametri

Nome In Tipo Obbligatorio Descrizione
key path string sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Aliases

Parametri

Nome In Tipo Obbligatorio Descrizione
quality query string (uuid) | null
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Restituisce 200 · Page_AliasOut_

Campo Tipo Obbligatorio Descrizione
items array of AliasOut sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/aliases" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Aliases

Corpo · AliasIn

Campo Tipo Obbligatorio Descrizione
quality_id string (uuid) sì
alias string sì
is_preferred boolean

Restituisce 201 · AliasOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
quality_id string (uuid) sì
alias string sì
is_preferred boolean sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/harmony/aliases" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"quality_id":"<uuid>","alias":"…"}'

Get Aliases

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 200 · AliasOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
quality_id string (uuid) sì
alias string sì
is_preferred boolean sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Aliases

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Corpo · AliasPatch

Campo Tipo Obbligatorio Descrizione
quality_id string (uuid) | null
alias string | null
is_preferred boolean | null

Restituisce 200 · AliasOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
quality_id string (uuid) sì
alias string sì
is_preferred boolean sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Aliases

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Types

Parametri

Nome In Tipo Obbligatorio Descrizione
quality query string (uuid) | null
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Restituisce 200 · Page_ChordTypeOut_

Campo Tipo Obbligatorio Descrizione
items array of ChordTypeOut sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/types" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Types

Corpo · ChordTypeIn

Campo Tipo Obbligatorio Descrizione
label string sì
description string
quality_id string (uuid) | null

Restituisce 201 · ChordTypeOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
label string sì
description string sì
quality_id string (uuid) | null sì
quality_key string | null sì
family string | null sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/harmony/types" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"label":"…"}'

Get Types

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 200 · ChordTypeOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
label string sì
description string sì
quality_id string (uuid) | null sì
quality_key string | null sì
family string | null sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Types

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Corpo · ChordTypePatch

Campo Tipo Obbligatorio Descrizione
label string | null
description string | null
quality_id string (uuid) | null

Restituisce 200 · ChordTypeOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
label string sì
description string sì
quality_id string (uuid) | null sì
quality_key string | null sì
family string | null sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Types

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Instruments

Parametri

Nome In Tipo Obbligatorio Descrizione
search query string | null
ordering query string | null
limit query integer
offset query integer

Restituisce 200 · Page_InstrumentOut_

Campo Tipo Obbligatorio Descrizione
items array of InstrumentOut sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/instruments" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Instruments

Corpo · InstrumentIn

Campo Tipo Obbligatorio Descrizione
name string sì
string_count integer

Restituisce 201 · InstrumentOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
name string sì
string_count integer sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/harmony/instruments" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"…"}'

Get Instruments

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 200 · InstrumentOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
name string sì
string_count integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/instruments/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Instruments

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Corpo · InstrumentPatch

Campo Tipo Obbligatorio Descrizione
name string | null
string_count integer | null

Restituisce 200 · InstrumentOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
name string sì
string_count integer sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/instruments/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Instruments

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/instruments/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Tunings

Parametri

Nome In Tipo Obbligatorio Descrizione
instrument query string (uuid) | null
is_default query boolean | null
name query string | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Restituisce 200 · Page_TuningOut_

Campo Tipo Obbligatorio Descrizione
items array of TuningOut sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/tunings" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Tunings

Corpo · TuningIn

Campo Tipo Obbligatorio Descrizione
instrument_id string (uuid) sì
name string sì
open_strings array of string sì
is_default boolean

Restituisce 201 · TuningOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
instrument InstrumentOut sì
name string sì
open_strings array of string sì
is_default boolean sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/harmony/tunings" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"instrument_id":"<uuid>","name":"…","open_strings":["…"]}'

Get Tunings

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 200 · TuningOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
instrument InstrumentOut sì
name string sì
open_strings array of string sì
is_default boolean sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Tunings

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Corpo · TuningPatch

Campo Tipo Obbligatorio Descrizione
instrument_id string (uuid) | null
name string | null
open_strings array of string | null
is_default boolean | null

Restituisce 200 · TuningOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
instrument InstrumentOut sì
name string sì
open_strings array of string sì
is_default boolean sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Tunings

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Voicing Tags

Parametri

Nome In Tipo Obbligatorio Descrizione
search query string | null
ordering query string | null
limit query integer
offset query integer

Restituisce 200 · Page_VoicingTagOut_

Campo Tipo Obbligatorio Descrizione
items array of VoicingTagOut sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing-Tags

Corpo · VoicingTagIn

Campo Tipo Obbligatorio Descrizione
name string sì

Restituisce 201 · VoicingTagOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
name string sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/harmony/voicing-tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"…"}'

Get Voicing-Tags

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 200 · VoicingTagOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
name string sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-tags/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Voicing-Tags

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Corpo · VoicingTagPatch

Campo Tipo Obbligatorio Descrizione
name string | null

Restituisce 200 · VoicingTagOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
name string sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/voicing-tags/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Voicing-Tags

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/voicing-tags/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Voicings

Parametri

Nome In Tipo Obbligatorio Descrizione
entry query string (uuid) | null
tuning query string | null ‘default’ or a tuning id
caged query string | null
min_fret query integer | null
max_fret query integer | null
inversion query integer | null
is_open query boolean | null
difficulty query integer | null
difficulty_lte query integer | null
tags query string | null comma-separated tag names (all)
search query string | null
ordering query string | null
limit query integer
offset query integer

Restituisce 200 · Page_VoicingOut_

Campo Tipo Obbligatorio Descrizione
items array of VoicingOut sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicings" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing

Corpo · VoicingIn

Campo Tipo Obbligatorio Descrizione
entry_id string (uuid) sì
tuning_id string (uuid) sì
name string
source string
caged "" | “C” | “A” | “G” | “E” | “D”
frets array of integer sì
fingers array of integer | null
barres array of object
inversion integer
difficulty integer
tag_names array of string

Restituisce 201 · VoicingOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
entry EntryLite sì
tuning TuningLite sì
name string sì
source string sì
caged string sì
frets array of integer sì
fingers array of integer | null sì
barres array of object sì
inversion integer sì
is_open boolean sì
fret_low integer sì
fret_high integer sì
difficulty integer sì
tags array of string sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/harmony/voicings" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"entry_id":"<uuid>","tuning_id":"<uuid>","frets":[0]}'

Get Voicing

Parametri

Nome In Tipo Obbligatorio Descrizione
voicing_id path string (uuid) sì

Restituisce 200 · VoicingOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
entry EntryLite sì
tuning TuningLite sì
name string sì
source string sì
caged string sì
frets array of integer sì
fingers array of integer | null sì
barres array of object sì
inversion integer sì
is_open boolean sì
fret_low integer sì
fret_high integer sì
difficulty integer sì
tags array of string sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicings/{voicing_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Voicing

Parametri

Nome In Tipo Obbligatorio Descrizione
voicing_id path string (uuid) sì

Corpo · VoicingPatch

Campo Tipo Obbligatorio Descrizione
entry_id string (uuid) | null
tuning_id string (uuid) | null
name string | null
source string | null
caged "" | “C” | “A” | “G” | “E” | “D” | null
frets array of integer | null
fingers array of integer | null
barres array of object | null
inversion integer | null
difficulty integer | null
tag_names array of string | null

Restituisce 200 · VoicingOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
entry EntryLite sì
tuning TuningLite sì
name string sì
source string sì
caged string sì
frets array of integer sì
fingers array of integer | null sì
barres array of object sì
inversion integer sì
is_open boolean sì
fret_low integer sì
fret_high integer sì
difficulty integer sì
tags array of string sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/voicings/{voicing_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Voicing

Parametri

Nome In Tipo Obbligatorio Descrizione
voicing_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/voicings/{voicing_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List References

Parametri

Nome In Tipo Obbligatorio Descrizione
search query string | null
ordering query string | null
limit query integer
offset query integer

Restituisce 200 · Page_ReferenceOut_

Campo Tipo Obbligatorio Descrizione
items array of ReferenceOut sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/references" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create References

Corpo · ReferenceIn

Campo Tipo Obbligatorio Descrizione
title string sì
author string
details string

Restituisce 201 · ReferenceOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
title string sì
author string sì
details string sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/harmony/references" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"title":"…"}'

Get References

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 200 · ReferenceOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
title string sì
author string sì
details string sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/references/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch References

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Corpo · ReferencePatch

Campo Tipo Obbligatorio Descrizione
title string | null
author string | null
details string | null

Restituisce 200 · ReferenceOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
title string sì
author string sì
details string sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/references/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete References

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/references/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Voicing References

Parametri

Nome In Tipo Obbligatorio Descrizione
voicing query string (uuid) | null
source query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Restituisce 200 · Page_VoicingReferenceOut_

Campo Tipo Obbligatorio Descrizione
items array of VoicingReferenceOut sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-references" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing-References

Corpo · VoicingReferenceIn

Campo Tipo Obbligatorio Descrizione
voicing_id string (uuid) sì
source_id string (uuid) sì
page string
figure string

Restituisce 201 · VoicingReferenceOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
voicing_id string (uuid) sì
source ReferenceOut sì
page string sì
figure string sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/harmony/voicing-references" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"voicing_id":"<uuid>","source_id":"<uuid>"}'

Get Voicing-References

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 200 · VoicingReferenceOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
voicing_id string (uuid) sì
source ReferenceOut sì
page string sì
figure string sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-references/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

PATCH /api/v1/harmony/voicing-references/{item_id}

Sezione intitolata “PATCH /api/v1/harmony/voicing-references/{item_id}”

Patch Voicing-References

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Corpo · VoicingReferencePatch

Campo Tipo Obbligatorio Descrizione
voicing_id string (uuid) | null
source_id string (uuid) | null
page string | null
figure string | null

Restituisce 200 · VoicingReferenceOut

Campo Tipo Obbligatorio Descrizione
created_at string (date-time) sì
updated_at string (date-time) sì
id string (uuid) sì
voicing_id string (uuid) sì
source ReferenceOut sì
page string sì
figure string sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/voicing-references/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

DELETE /api/v1/harmony/voicing-references/{item_id}

Sezione intitolata “DELETE /api/v1/harmony/voicing-references/{item_id}”

Delete Voicing-References

Parametri

Nome In Tipo Obbligatorio Descrizione
item_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/voicing-references/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Entries

Parametri

Nome In Tipo Obbligatorio Descrizione
root query string | null
symbol query string | null
quality query string (uuid) | null
family query string (uuid) | null
bass query string | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Restituisce 200 · Page_EntryOut_

Campo Tipo Obbligatorio Descrizione
items array of EntryOut sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Entry By Symbol

Resolve Dbmaj7/Gb-style symbols to the canonical (sharp) entry.

Parametri

Nome In Tipo Obbligatorio Descrizione
symbol query string

Restituisce 200 · EntryOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
symbol string sì
root string sì
bass string sì
quality QualityOut sì
family string sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries/by-symbol" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Entry

Parametri

Nome In Tipo Obbligatorio Descrizione
entry_id path string (uuid) sì

Restituisce 200 · EntryOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
symbol string sì
root string sì
bass string sì
quality QualityOut sì
family string sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries/{entry_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Live

Restituisce 200 · object

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/health/live" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Ready

Restituisce 200 · object

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/health/ready" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Presign Upload

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Corpo · PresignIn

Campo Tipo Obbligatorio Descrizione
filename string sì
content_type string sì
size integer sì

Restituisce 200 · PresignOut

Campo Tipo Obbligatorio Descrizione
upload_url string sì
key string sì
audio_id string (uuid) sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/uploads/presign" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"filename":"…","content_type":"…","size":0}'

Confirm Upload

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Corpo · app__modules__ingestion__schemas__ConfirmIn

Campo Tipo Obbligatorio Descrizione
key string sì
audio_id string (uuid) sì
directory_id string (uuid) | null

Restituisce 201 · ConfirmOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
title string sì
description string sì
favorite boolean sì
tags array of string sì
file_size integer sì
total_stems_usage integer sì
uploaded_at string (date-time) sì
last_played_at string (date-time) | null sì
play_count integer sì
directory DirectoryRef | null sì
normalized_metadata object sì
has_cover_art boolean sì
cover_image_url string | null sì
stems array of StemOut sì
analyze TransformationOut | null sì
metadata TransformationOut | null sì
separation TransformationOut | null sì
ml_analysis TransformationOut | null sì
mapping TransformationOut | null
queued_separation TransformationOut | null
parent_id string (uuid) | null
clip ClipOut | null
auto_tasks object sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/uploads/confirm" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"key":"…","audio_id":"<uuid>"}'

Ingest Url

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Corpo · IngestUrlIn

Campo Tipo Obbligatorio Descrizione
video_url string (uri) sì
format IngestFormat

Restituisce 202 · IngestUrlOut

Campo Tipo Obbligatorio Descrizione
status string sì
job_id string sì
audio_id string (uuid) sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/ingest/url" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"video_url":"…"}'

Upload Conditions

Restituisce 200 · ConditionsOut

Campo Tipo Obbligatorio Descrizione
extensions array of string sì
max_file_size_mb integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/uploads/conditions" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Lyrics

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 200 · LyricsOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
file_id string (uuid) sì
lines array of object sì
offset_ms integer sì
source string sì
source_ref string | null sì
synced boolean sì
updated_by string (uuid) | null sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Put Lyrics

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · LyricsIn

Campo Tipo Obbligatorio Descrizione
lines array of LyricsLine sì
offset_ms integer
source “manual” | “file” | “lrclib”
source_ref string | null

Restituisce 200 · LyricsOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
file_id string (uuid) sì
lines array of object sì
offset_ms integer sì
source string sì
source_ref string | null sì
synced boolean sì
updated_by string (uuid) | null sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X PUT "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"lines":[{}]}'

Delete Lyrics

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Search Lyrics

LRCLIB records (at most 20). No term: the track’s own title and artist.

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì
track query string | null
artist query string | null
q query string | null

Restituisce 200 · array of LyricsCandidate

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics/search" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Sections

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì
section_type query string | null

Restituisce 200 · array of SectionOut

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/sections" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Section

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · SectionIn

Campo Tipo Obbligatorio Descrizione
start number sì
end number | null
section_type string sì
observation string | null

Restituisce 201 · SectionOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
file_id string (uuid) sì
start number sì
end number | null sì
label string sì
color string | null sì
section_type string sì
section_number integer sì
observation string | null sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/sections" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"start":0,"section_type":"…"}'

Patch Section

Parametri

Nome In Tipo Obbligatorio Descrizione
section_id path string (uuid) sì

Corpo · SectionPatch

Campo Tipo Obbligatorio Descrizione
start number | null
end number | null
section_type string | null
observation string | null

Restituisce 200 · SectionOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
file_id string (uuid) sì
start number sì
end number | null sì
label string sì
color string | null sì
section_type string sì
section_number integer sì
observation string | null sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/sections/{section_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Section

Parametri

Nome In Tipo Obbligatorio Descrizione
section_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/sections/{section_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Marks

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 200 · array of MarkOut

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/marks" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Mark

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · MarkIn

Campo Tipo Obbligatorio Descrizione
start number sì
name string | null
observation string | null

Restituisce 201 · MarkOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
file_id string (uuid) sì
start number sì
name string sì
observation string | null sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/marks" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"start":0}'

Patch Mark

Parametri

Nome In Tipo Obbligatorio Descrizione
mark_id path string (uuid) sì

Corpo · MarkPatch

Campo Tipo Obbligatorio Descrizione
start number | null
name string | null
observation string | null

Restituisce 200 · MarkOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
file_id string (uuid) sì
start number sì
name string sì
observation string | null sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/marks/{mark_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Mark

Parametri

Nome In Tipo Obbligatorio Descrizione
mark_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/marks/{mark_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Loops

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 200 · array of LoopOut

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/loops" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Loop

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · LoopIn

Campo Tipo Obbligatorio Descrizione
start number sì
end number | null
name string | null
observation string | null

Restituisce 201 · LoopOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
file_id string (uuid) sì
start number sì
end number | null sì
name string sì
observation string | null sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/loops" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"start":0}'

Patch Loop

Parametri

Nome In Tipo Obbligatorio Descrizione
loop_id path string (uuid) sì

Corpo · LoopPatch

Campo Tipo Obbligatorio Descrizione
start number | null
end number | null
name string | null
observation string | null

Restituisce 200 · LoopOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
file_id string (uuid) sì
start number sì
end number | null sì
name string sì
observation string | null sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/loops/{loop_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Loop

Parametri

Nome In Tipo Obbligatorio Descrizione
loop_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/loops/{loop_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Beats

The saved beat map, else the analysis beats with a suggested meter.

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 200 · BeatsOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) | null
beats array of object sì
meter array of MeterEntry sì
source string sì
beat_count integer sì
created_at string (date-time) | null
updated_at string (date-time) | null

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/beats" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Put Beats

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · BeatsIn

Campo Tipo Obbligatorio Descrizione
beats array of number sì
meter array of MeterEntry

Restituisce 200 · BeatsOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) | null
beats array of object sì
meter array of MeterEntry sì
source string sì
beat_count integer sì
created_at string (date-time) | null
updated_at string (date-time) | null

Esempio

Finestra del terminale
curl -X PUT "$JAMCLOUD_API/api/v1/files/{file_id}/beats" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"beats":[0]}'

Delete Beats

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/beats" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Import

Upload a music file (MIDI, MusicXML, Guitar Pro, …) to import as a notation; poll GET /imports/{id} or listen for music_import_progress notifications.

Needs the workspace owner’s score_import permission (403 action_not_allowed); the file’s size is reserved on the owner’s storage (400 storage_limit_exceeded) until the job ends.

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Restituisce 202 · ImportCreated

Campo Tipo Obbligatorio Descrizione
import_job_id string (uuid) sì
job_id string sì
status string sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/imports" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Import Status

Parametri

Nome In Tipo Obbligatorio Descrizione
import_id path string (uuid) sì

Restituisce 200 · app__modules__music_import__schemas__ImportJobOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
original_filename string sì
source_format string sì
status string sì
notation_id string (uuid) | null sì
error_message string sì
progress_percent integer sì
progress_message string sì
parser_logs object sì
created_at string (date-time) sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/imports/{import_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Formats

Enabled import formats and their extensions.

Restituisce 200 · array of FormatOut

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/import/formats" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Notations

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì
audio_file_id query string (uuid) | null
favorite query boolean | null
tags query array of string
search query string
limit query integer
offset query integer

Restituisce 200 · Page_NotationSummary_

Campo Tipo Obbligatorio Descrizione
items array of NotationSummary sì
total integer sì
limit integer sì
offset integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/notations" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Notation

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Corpo · NotationIn

Campo Tipo Obbligatorio Descrizione
title string
author string
audio_file_id string (uuid) | null
data object
tempo integer
time_signature string
number_of_measures integer
start_time number | string | null
end_time number | string | null
repeat_sync boolean
sync_map object
favorite boolean
tags array of string
category_ids array of string (uuid)

Restituisce 201 · NotationOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
title string sì
author string sì
audio_file_id string (uuid) | null sì
audio_file_title string sì
data object sì
format_version integer sì
source_format string sì
origin string sì
tempo integer sì
time_signature string sì
number_of_measures integer sì
start_time number | null sì
end_time number | null sì
repeat_sync boolean sì
sync_map object sì
favorite boolean sì
tags array of string sì
category_ids array of string (uuid) sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/notations" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Notation Tags

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Restituisce 200 · TagsOut

Campo Tipo Obbligatorio Descrizione
tags array of string sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/notations/tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Recent Notations

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Restituisce 200 · array of NotationSummary

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/notations/recent" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Notation

Parametri

Nome In Tipo Obbligatorio Descrizione
notation_id path string (uuid) sì

Restituisce 200 · NotationOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
title string sì
author string sì
audio_file_id string (uuid) | null sì
audio_file_title string sì
data object sì
format_version integer sì
source_format string sì
origin string sì
tempo integer sì
time_signature string sì
number_of_measures integer sì
start_time number | null sì
end_time number | null sì
repeat_sync boolean sì
sync_map object sì
favorite boolean sì
tags array of string sì
category_ids array of string (uuid) sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/notations/{notation_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Notation

Parametri

Nome In Tipo Obbligatorio Descrizione
notation_id path string (uuid) sì

Corpo · NotationPatch

Campo Tipo Obbligatorio Descrizione
title string | null
author string | null
audio_file_id string (uuid) | null
data object | null
tempo integer | null
time_signature string | null
number_of_measures integer | null
start_time number | string | null
end_time number | string | null
repeat_sync boolean | null
sync_map object | null
favorite boolean | null
tags array of string | null
category_ids array of string (uuid) | null

Restituisce 200 · NotationOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
title string sì
author string sì
audio_file_id string (uuid) | null sì
audio_file_title string sì
data object sì
format_version integer sì
source_format string sì
origin string sì
tempo integer sì
time_signature string sì
number_of_measures integer sì
start_time number | null sì
end_time number | null sì
repeat_sync boolean sì
sync_map object sì
favorite boolean sì
tags array of string sì
category_ids array of string (uuid) sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/notations/{notation_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Notation

Parametri

Nome In Tipo Obbligatorio Descrizione
notation_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/notations/{notation_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Set Favorite

Parametri

Nome In Tipo Obbligatorio Descrizione
notation_id path string (uuid) sì

Corpo · FavoriteIn

Campo Tipo Obbligatorio Descrizione
favorite boolean sì

Restituisce 200 · NotationOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
title string sì
author string sì
audio_file_id string (uuid) | null sì
audio_file_title string sì
data object sì
format_version integer sì
source_format string sì
origin string sì
tempo integer sì
time_signature string sì
number_of_measures integer sì
start_time number | null sì
end_time number | null sì
repeat_sync boolean sì
sync_map object sì
favorite boolean sì
tags array of string sì
category_ids array of string (uuid) sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/notations/{notation_id}/favorite" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"favorite":false}'

Categories

Restituisce 200 · array of CategoryOut

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/notation-categories" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Platform

Public, no credentials: read by the app’s public pages and by the static site from its own origin (hence *: nothing private here). Cached a minute by browsers and Cloudflare.

Restituisce 200 · PlatformOut

Campo Tipo Obbligatorio Descrizione
payments_enabled boolean sì
site_show_signup boolean sì
site_hidden_pages array of string sì
site_announcement string sì
site_announcement_url string sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/platform" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Playlists

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Restituisce 200 · array of PlaylistOut

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/playlists" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Playlist

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Corpo · PlaylistIn

Campo Tipo Obbligatorio Descrizione
name string sì
repeat_mode “off” | “all” | “one”

Restituisce 201 · PlaylistDetail

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
name string sì
repeat_mode string sì
track_count integer sì
created_at string (date-time) sì
updated_at string (date-time) sì
tracks array of app__modules__playlists__schemas__TrackOut sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/playlists" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"…"}'

Get Playlist

Parametri

Nome In Tipo Obbligatorio Descrizione
playlist_id path string (uuid) sì

Restituisce 200 · PlaylistDetail

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
name string sì
repeat_mode string sì
track_count integer sì
created_at string (date-time) sì
updated_at string (date-time) sì
tracks array of app__modules__playlists__schemas__TrackOut sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Playlist

Parametri

Nome In Tipo Obbligatorio Descrizione
playlist_id path string (uuid) sì

Corpo · PlaylistPatch

Campo Tipo Obbligatorio Descrizione
name string | null
repeat_mode “off” | “all” | “one” | null

Restituisce 200 · PlaylistDetail

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
name string sì
repeat_mode string sì
track_count integer sì
created_at string (date-time) sì
updated_at string (date-time) sì
tracks array of app__modules__playlists__schemas__TrackOut sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Playlist

Parametri

Nome In Tipo Obbligatorio Descrizione
playlist_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Tracks

Parametri

Nome In Tipo Obbligatorio Descrizione
playlist_id path string (uuid) sì

Restituisce 200 · array of app__modules__playlists__schemas__TrackOut

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/playlists/{playlist_id}/tracks" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Add Tracks

Appends at the end (position is accepted but ignored, as in Django).

Parametri

Nome In Tipo Obbligatorio Descrizione
playlist_id path string (uuid) sì

Corpo · TracksIn

Campo Tipo Obbligatorio Descrizione
tracks array of TrackIn sì

Restituisce 201 · array of app__modules__playlists__schemas__TrackOut

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/playlists/{playlist_id}/tracks" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"tracks":[{}]}'

Reorder Tracks

Parametri

Nome In Tipo Obbligatorio Descrizione
playlist_id path string (uuid) sì

Corpo · ReorderIn

Campo Tipo Obbligatorio Descrizione
order array of string (uuid) sì

Restituisce 200 · array of app__modules__playlists__schemas__TrackOut

Esempio

Finestra del terminale
curl -X PUT "$JAMCLOUD_API/api/v1/playlists/{playlist_id}/tracks" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"order":["<uuid>"]}'

DELETE /api/v1/playlists/{playlist_id}/tracks/{track_id}

Sezione intitolata “DELETE /api/v1/playlists/{playlist_id}/tracks/{track_id}”

Remove Track

Parametri

Nome In Tipo Obbligatorio Descrizione
playlist_id path string (uuid) sì
track_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/playlists/{playlist_id}/tracks/{track_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Stream File

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì
quality query “low” | “medium” | “high” | null Profile chosen by the player when the preference is auto.

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/stream" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Stream File Url

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì
quality query “low” | “medium” | “high” | null Profile chosen by the player when the preference is auto.

Restituisce 200 · StreamUrlOut

Campo Tipo Obbligatorio Descrizione
url string sì
expires_in integer sì
quality string | null

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/stream-url" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

GET /api/v1/files/{file_id}/stems/{stem_name}/stream

Sezione intitolata “GET /api/v1/files/{file_id}/stems/{stem_name}/stream”

Stream Stem

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì
stem_name path string sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/stems/{stem_name}/stream" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

GET /api/v1/files/{file_id}/stems/{stem_name}/stream-url

Sezione intitolata “GET /api/v1/files/{file_id}/stems/{stem_name}/stream-url”

Stream Stem Url

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì
stem_name path string sì

Restituisce 200 · StreamUrlOut

Campo Tipo Obbligatorio Descrizione
url string sì
expires_in integer sì
quality string | null

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/stems/{stem_name}/stream-url" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Presign Take

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · TakePresignIn

Campo Tipo Obbligatorio Descrizione
content_type “audio/wav” | “audio/x-wav” | “audio/wave”
size integer sì

Restituisce 200 · TakePresignOut

Campo Tipo Obbligatorio Descrizione
upload_url string sì
key string sì
take_id string (uuid) sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/takes/presign" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"size":0}'

Confirm Take

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · TakeConfirmIn

Campo Tipo Obbligatorio Descrizione
take_id string (uuid) sì
key string sì
name string | null
duration number sì
offset_ms integer
latency_ms integer
sample_rate integer sì
speed number
pitch_tones number

Restituisce 201 · TakeOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
audio_file_id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) sì
author_name string sì
mine boolean sì
name string sì
status string sì
duration number sì
offset_ms integer sì
latency_ms integer sì
sample_rate integer sì
speed number sì
pitch_tones number sì
file_size integer sì
shared boolean sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/takes/confirm" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"take_id":"<uuid>","key":"…","duration":0,"sample_rate":0}'

List Takes

Mine and the shared ones, newest first (small, bounded list: a plain array).

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Restituisce 200 · array of TakeOut

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/takes" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Take

Parametri

Nome In Tipo Obbligatorio Descrizione
take_id path string (uuid) sì

Restituisce 200 · TakeOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
audio_file_id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) sì
author_name string sì
mine boolean sì
name string sì
status string sì
duration number sì
offset_ms integer sì
latency_ms integer sì
sample_rate integer sì
speed number sì
pitch_tones number sì
file_size integer sì
shared boolean sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/takes/{take_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Update Take

Author only.

Parametri

Nome In Tipo Obbligatorio Descrizione
take_id path string (uuid) sì

Corpo · TakePatch

Campo Tipo Obbligatorio Descrizione
name string | null
shared boolean | null
offset_ms integer | null

Restituisce 200 · TakeOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
audio_file_id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) sì
author_name string sì
mine boolean sì
name string sì
status string sì
duration number sì
offset_ms integer sì
latency_ms integer sì
sample_rate integer sì
speed number sì
pitch_tones number sì
file_size integer sì
shared boolean sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/takes/{take_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Take

The author, or the workspace owner (for a take they can see: a shared one).

Parametri

Nome In Tipo Obbligatorio Descrizione
take_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/takes/{take_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Take Stream Url

Parametri

Nome In Tipo Obbligatorio Descrizione
take_id path string (uuid) sì

Restituisce 200 · TakeStreamUrlOut

Campo Tipo Obbligatorio Descrizione
url string sì
expires_in integer sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/takes/{take_id}/stream-url" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Tuner Catalog

Instruments, tunings (string notes + frequencies) and temperaments.

Restituisce 200 · object

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/tools/tuner/catalog" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Metronome Catalog

World-rhythm presets (clave, bell timelines, tala, aksak…) with their ethnomusicological notes, categories and sources.

Restituisce 200 · object

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/tools/metronome/catalog" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Presets

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Restituisce 200 · array of MetronomePresetOut

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/metronome-presets" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Preset

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Corpo · MetronomePresetIn

Campo Tipo Obbligatorio Descrizione
name string sì
base_preset_id string | null
bpm number
numerator integer
denominator 1 | 2 | 4 | 8 | 16
subdivision “quarter” | “eighth” | “triplet” | “sixteenth”
bars integer
pattern string
swing_ratio number | null
voice “click” | “wood” | “bell”
layers array of LayerIn
audio_file_id string (uuid) | null

Restituisce 201 · MetronomePresetOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
name string sì
base_preset_id string | null sì
bpm number sì
numerator integer sì
denominator integer sì
subdivision string sì
bars integer sì
pattern string sì
swing_ratio number | null sì
voice string sì
layers array of object sì
audio_file_id string (uuid) | null sì
analysis object | null sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/metronome-presets" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"…"}'

Get Preset

Parametri

Nome In Tipo Obbligatorio Descrizione
preset_id path string (uuid) sì

Restituisce 200 · MetronomePresetOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
name string sì
base_preset_id string | null sì
bpm number sì
numerator integer sì
denominator integer sì
subdivision string sì
bars integer sì
pattern string sì
swing_ratio number | null sì
voice string sì
layers array of object sì
audio_file_id string (uuid) | null sì
analysis object | null sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Preset

Parametri

Nome In Tipo Obbligatorio Descrizione
preset_id path string (uuid) sì

Corpo · MetronomePresetPatch

Campo Tipo Obbligatorio Descrizione
name string | null
bpm number | null
numerator integer | null
denominator 1 | 2 | 4 | 8 | 16 | null
subdivision “quarter” | “eighth” | “triplet” | “sixteenth” | null
bars integer | null
pattern string | null
swing_ratio number | null
voice “click” | “wood” | “bell” | null
layers array of LayerIn | null
audio_file_id string (uuid) | null

Restituisce 200 · MetronomePresetOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
name string sì
base_preset_id string | null sì
bpm number sì
numerator integer sì
denominator integer sì
subdivision string sì
bars integer sì
pattern string sì
swing_ratio number | null sì
voice string sì
layers array of object sì
audio_file_id string (uuid) | null sì
analysis object | null sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Preset

Parametri

Nome In Tipo Obbligatorio Descrizione
preset_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

POST /api/v1/metronome-presets/{preset_id}/analyze-audio

Sezione intitolata “POST /api/v1/metronome-presets/{preset_id}/analyze-audio”

Analyze Audio

BPM + beat pattern proposal from the attached loop (analysis, then a metronome_analysis notification).

Parametri

Nome In Tipo Obbligatorio Descrizione
preset_id path string (uuid) sì

Restituisce 202 · app__modules__tools__schemas__JobOut

Campo Tipo Obbligatorio Descrizione
status string sì
job_id string sì
audio_id string (uuid) | null

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}/analyze-audio" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Render

Render a click track and import it into the library (same pipeline as an upload).

Parametri

Nome In Tipo Obbligatorio Descrizione
preset_id path string (uuid) sì

Corpo · RenderIn

Campo Tipo Obbligatorio Descrizione
bars integer

Restituisce 202 · app__modules__tools__schemas__JobOut

Campo Tipo Obbligatorio Descrizione
status string sì
job_id string sì
audio_id string (uuid) | null

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}/render" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

List Tunings

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Restituisce 200 · array of TunerProfileOut

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/tuner-profiles" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Tuning

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Corpo · TunerProfileIn

Campo Tipo Obbligatorio Descrizione
instrument string sì
name string sì
strings array of string sì
reference_hz number
temperament string
tonic integer

Restituisce 201 · TunerProfileOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
instrument string sì
name string sì
strings array of string sì
reference_hz number sì
temperament string sì
tonic integer sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/tuner-profiles" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"instrument":"…","name":"…","strings":["…"]}'

Patch Tuning

Parametri

Nome In Tipo Obbligatorio Descrizione
tuning_id path string (uuid) sì

Corpo · TunerProfilePatch

Campo Tipo Obbligatorio Descrizione
instrument string | null
name string | null
strings array of string | null
reference_hz number | null
temperament string | null
tonic integer | null

Restituisce 200 · TunerProfileOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
group_id string (uuid) sì
created_by string (uuid) | null sì
instrument string sì
name string sì
strings array of string sì
reference_hz number sì
temperament string sì
tonic integer sì
created_at string (date-time) sì
updated_at string (date-time) sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/tuner-profiles/{tuning_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Tuning

Parametri

Nome In Tipo Obbligatorio Descrizione
tuning_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/tuner-profiles/{tuning_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Update Metadata

Write tags into the audio file (async). Not quota-counted: a basic edit.

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì

Corpo · MetadataIn

Campo Tipo Obbligatorio Descrizione
tags object sì

Restituisce 202 · MetadataJobOut

Campo Tipo Obbligatorio Descrizione
status string
job_id string sì
transformation_id string (uuid) sì

Esempio

Finestra del terminale
curl -X PATCH "$JAMCLOUD_API/api/v1/files/{file_id}/metadata" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"tags":{}}'

POST /api/v1/files/{file_id}/transformations/{process}

Sezione intitolata “POST /api/v1/files/{file_id}/transformations/{process}”

Trigger

Parametri

Nome In Tipo Obbligatorio Descrizione
file_id path string (uuid) sì
process path string sì

Corpo · TriggerIn | null

Restituisce 202 · TriggerOut

Campo Tipo Obbligatorio Descrizione
position integer | null 1 = next to start.
ahead integer | null Requests waiting before this one.
eta_seconds integer | null Rough wait before it starts.
status string started, or queued (waiting).
process string sì
job_id string sì
transformation_id string (uuid) sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/transformations/{process}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Separation Models

Separation models an admin enabled, default first in catalog order.

Restituisce 200 · array of SeparationModelOut

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/separation-models" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

POST /api/v1/groups/{group_id}/files/batch-metadata

Sezione intitolata “POST /api/v1/groups/{group_id}/files/batch-metadata”

Batch Metadata

Same tags on many files of the workspace; unknown ids are skipped.

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Corpo · BatchMetadataIn

Campo Tipo Obbligatorio Descrizione
file_ids array of string (uuid) sì
tags object sì

Restituisce 202 · BatchMetadataOut

Campo Tipo Obbligatorio Descrizione
jobs array of BatchJob sì

Esempio

Finestra del terminale
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/files/batch-metadata" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"file_ids":["<uuid>"],"tags":{}}'

Job Status

Parametri

Nome In Tipo Obbligatorio Descrizione
job_id path string sì

Restituisce 200 · app__modules__transformer__schemas__JobOut

Campo Tipo Obbligatorio Descrizione
position integer | null 1 = next to start.
ahead integer | null Requests waiting before this one.
eta_seconds integer | null Rough wait before it starts.
job_id string sì
state string sì
status string sì
progress integer sì
ready boolean sì
successful boolean sì
transformation_id string (uuid) sì

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/jobs/{job_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Cancel Job

Withdraw a request still waiting in line (editor); its quota use is refunded.

Parametri

Nome In Tipo Obbligatorio Descrizione
job_id path string sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/jobs/{job_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Job Events

Server-sent events of one job: the current state first, then every event published on rt:job:<id> until completed / failed (keepalive comments in between).

Parametri

Nome In Tipo Obbligatorio Descrizione
job_id path string sì

Restituisce 200 · object

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/jobs/{job_id}/events" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

DELETE /api/v1/transformations/{transformation_id}

Sezione intitolata “DELETE /api/v1/transformations/{transformation_id}”

Delete Transformation

Parametri

Nome In Tipo Obbligatorio Descrizione
transformation_id path string (uuid) sì

Restituisce 204 · nessun contenuto

Esempio

Finestra del terminale
curl -X DELETE "$JAMCLOUD_API/api/v1/transformations/{transformation_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

My Workspaces

Restituisce 200 · array of WorkspaceOut

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/groups" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Workspace

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Restituisce 200 · WorkspaceOut

Campo Tipo Obbligatorio Descrizione
id string (uuid) sì
name string sì
kind string sì
my_role GroupRole sì
created_at string (date-time) sì
owner_id string (uuid) | null sì
member_count integer sì Members besides the owner.
members array of WorkspaceMemberOut sì
settings WorkspaceSettingsOut

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Settings

Parametri

Nome In Tipo Obbligatorio Descrizione
group_id path string (uuid) sì

Restituisce 200 · WorkspaceSettingsOut

Campo Tipo Obbligatorio Descrizione
boards_viewers_can_write boolean

Esempio

Finestra del terminale
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/settings" \
-H "Authorization: Bearer $JAMCLOUD_KEY"