Zum Inhalt springen

API-Referenz

Die Referenz für Entwickler: was jede Route erwartet und zurückgibt. Wie du einen Schlüssel bekommst und was er erreicht, steht unter API.

Die Version steht in jedem Pfad: /api/v1. Innerhalb von Version 1 kommen Routen und Felder nur hinzu, sie werden nie umbenannt oder entfernt: Ignoriere Felder, die du nicht kennst. Eine Änderung, die deinen Code brechen würde, kommt als neue Version (/api/v2), v1 läuft daneben weiter.

Lege die API-Adresse und deinen Schlüssel in Umgebungsvariablen ab und rufe sie mit einem beliebigen HTTP-Client auf: Es gibt kein SDK zu installieren.

Terminal-Fenster
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 rein und raus, Felder in snake_case, IDs sind UUIDs.
  • Listen antworten mit {items, total, limit, offset}; blättere mit den Parametern limit und offset.
  • Fehler sind problem+json {type, title, status, code, details}: Prüfe code, er ändert sich nie.
  • Ein Upload braucht drei Aufrufe: presign, PUT der Datei an die zurückgegebene URL, dann confirm. Die URL gilt 15 Minuten und nimmt genau die angegebene size an, in einem einzigen PUT.
  • 503 circuit_open: Warte die Sekunden aus Retry-After ab und versuche es erneut.

Jeder Abschnitt unten ist eine Ressource; jede Route nennt ihre Parameter, Felder, Antwort und ein curl-Beispiel.

API-Version v1 · jede Route unten beginnt mit /api/v1

List Boards

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

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja
limit query integer
offset query integer

Antwort 200 · Page_BoardOut_

Feld Typ Pflicht Beschreibung
items array of BoardOut ja
total integer ja
limit integer ja
offset integer ja

Beispiel

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

Create Board

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Body · BoardIn

Feld Typ Pflicht Beschreibung
title string ja

Antwort 201 · BoardDetail

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
file_id string (uuid) | null ja
created_by string (uuid) | null ja
title string ja
version integer ja
item_count integer ja
can_write boolean ja
created_at string (date-time) ja
updated_at string (date-time) ja
items array of BoardItemOut ja

Beispiel

Terminal-Fenster
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.

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 200 · BoardDetail

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
file_id string (uuid) | null ja
created_by string (uuid) | null ja
title string ja
version integer ja
item_count integer ja
can_write boolean ja
created_at string (date-time) ja
updated_at string (date-time) ja
items array of BoardItemOut ja

Beispiel

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

Get Board

Parameter

Name In Typ Pflicht Beschreibung
board_id path string (uuid) ja

Antwort 200 · BoardDetail

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
file_id string (uuid) | null ja
created_by string (uuid) | null ja
title string ja
version integer ja
item_count integer ja
can_write boolean ja
created_at string (date-time) ja
updated_at string (date-time) ja
items array of BoardItemOut ja

Beispiel

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

Rename Board

Parameter

Name In Typ Pflicht Beschreibung
board_id path string (uuid) ja

Body · BoardPatch

Feld Typ Pflicht Beschreibung
title string ja

Antwort 200 · BoardOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
file_id string (uuid) | null ja
created_by string (uuid) | null ja
title string ja
version integer ja
item_count integer ja
can_write boolean ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

Terminal-Fenster
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.

Parameter

Name In Typ Pflicht Beschreibung
board_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

Terminal-Fenster
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"}).

Parameter

Name In Typ Pflicht Beschreibung
board_id path string (uuid) ja

Body · OpsIn

Feld Typ Pflicht Beschreibung
client_id string ja
ops array of UpsertOp | DeleteOp | ClearOp ja

Antwort 200 · OpsOut

Feld Typ Pflicht Beschreibung
version integer ja
items array of ItemRev ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 200 · ChartOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
file_id string (uuid) ja
content object ja
anchor_bar integer ja
source string ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

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

Put Chart

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · ChartIn

Feld Typ Pflicht Beschreibung
content ChartContent ja
anchor_bar integer
source “manual” | “import”

Antwort 200 · ChartOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
file_id string (uuid) ja
content object ja
anchor_bar integer ja
source string ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

Get Score

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 200 · ScoreOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
file_id string (uuid) ja
status “processing” | “ready” | “failed” ja
format “guitarpro” | “musicxml” | null ja
source_format string ja
original_filename string ja
title string ja
anchor_bar integer ja
settings object ja
error_code string | null ja
error_message string | null ja
url string | null ja
original_url string ja
revision integer ja
edited_at string (date-time) | null ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

Terminal-Fenster
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).

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 201 · ScoreOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
file_id string (uuid) ja
status “processing” | “ready” | “failed” ja
format “guitarpro” | “musicxml” | null ja
source_format string ja
original_filename string ja
title string ja
anchor_bar integer ja
settings object ja
error_code string | null ja
error_message string | null ja
url string | null ja
original_url string ja
revision integer ja
edited_at string (date-time) | null ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

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

Patch Score

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · ScorePatch

Feld Typ Pflicht Beschreibung
anchor_bar integer | null
settings object | null

Antwort 200 · ScoreOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
file_id string (uuid) ja
status “processing” | “ready” | “failed” ja
format “guitarpro” | “musicxml” | null ja
source_format string ja
original_filename string ja
title string ja
anchor_bar integer ja
settings object ja
error_code string | null ja
error_message string | null ja
url string | null ja
original_url string ja
revision integer ja
edited_at string (date-time) | null ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

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

Delete Score

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

Terminal-Fenster
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).

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 200 · ScoreOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
file_id string (uuid) ja
status “processing” | “ready” | “failed” ja
format “guitarpro” | “musicxml” | null ja
source_format string ja
original_filename string ja
title string ja
anchor_bar integer ja
settings object ja
error_code string | null ja
error_message string | null ja
url string | null ja
original_url string ja
revision integer ja
edited_at string (date-time) | null ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

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

Export File

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · ExportIn

Feld Typ Pflicht Beschreibung
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

Antwort 202 · ExportJobOut

Feld Typ Pflicht Beschreibung
job_id string ja
file_id string | null
status “queued” | “processing” | “ready” | “failed” ja
filename string | null
url string | null
expires_in integer | null
code string | null

Beispiel

Terminal-Fenster
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.

Parameter

Name In Typ Pflicht Beschreibung
job_id path string (uuid) ja

Antwort 200 · ExportJobOut

Feld Typ Pflicht Beschreibung
job_id string ja
file_id string | null
status “queued” | “processing” | “ready” | “failed” ja
filename string | null
url string | null
expires_in integer | null
code string | null

Beispiel

Terminal-Fenster
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.

Body · FeedbackIn

Feld Typ Pflicht Beschreibung
category “bug” | “idea” | “question” | “other” ja
message string ja
group_id string | null The workspace open in the app.
context FeedbackContext

Antwort 201 · FeedbackOut

Feld Typ Pflicht Beschreibung
id string ja
category “bug” | “idea” | “question” | “other” ja
status “new” | “done” ja
created_at string (date-time) ja

Beispiel

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

List Directories

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Antwort 200 · array of DirectoryOut

Beispiel

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

Create Directory

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Body · DirectoryIn

Feld Typ Pflicht Beschreibung
name string ja

Antwort 200 · object

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
directory_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

List Files

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja
tags query array of string
favorite query boolean | null
search query string
directory_id query string (uuid) | null
limit query integer
offset query integer

Antwort 200 · Page_FileSummary_

Feld Typ Pflicht Beschreibung
items array of FileSummary ja
total integer ja
limit integer ja
offset integer ja

Beispiel

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

Recent Files

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Antwort 200 · array of FileSummary

Beispiel

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

Group Tags

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Antwort 200 · TagsOut

Feld Typ Pflicht Beschreibung
tags array of string ja

Beispiel

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

Batch Delete

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Body · BatchIds

Feld Typ Pflicht Beschreibung
file_ids array of string (uuid) ja

Antwort 200 · BatchDeleteOut

Feld Typ Pflicht Beschreibung
deleted integer ja

Beispiel

Terminal-Fenster
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).

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Body · BatchMoveIn

Feld Typ Pflicht Beschreibung
file_ids array of string (uuid) ja
target_group_id string (uuid) ja

Antwort 200 · BatchMoveOut

Feld Typ Pflicht Beschreibung
moved integer ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
tags query array of string
favorite query boolean | null
search query string
limit query integer
offset query integer

Antwort 200 · Page_FileSummary_

Feld Typ Pflicht Beschreibung
items array of FileSummary ja
total integer ja
limit integer ja
offset integer ja

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/files" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Recent All Files

Antwort 200 · array of FileSummary

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/files/recent" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

All Tags

Antwort 200 · TagsOut

Feld Typ Pflicht Beschreibung
tags array of string ja

Beispiel

Terminal-Fenster
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.

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja
play query boolean

Antwort 200 · FileOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) | null ja
title string ja
description string ja
favorite boolean ja
tags array of string ja
file_size integer ja
total_stems_usage integer ja
uploaded_at string (date-time) ja
last_played_at string (date-time) | null ja
play_count integer ja
directory DirectoryRef | null ja
normalized_metadata object ja
has_cover_art boolean ja
cover_image_url string | null ja
stems array of StemOut ja
analyze TransformationOut | null ja
metadata TransformationOut | null ja
separation TransformationOut | null ja
ml_analysis TransformationOut | null ja
mapping TransformationOut | null
queued_separation TransformationOut | null
parent_id string (uuid) | null
clip ClipOut | null

Beispiel

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

Patch File

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · FilePatch

Feld Typ Pflicht Beschreibung
title string | null
description string | null
favorite boolean | null
tags array of string | null
directory_id string (uuid) | null
parent_id null

Antwort 200 · FileOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) | null ja
title string ja
description string ja
favorite boolean ja
tags array of string ja
file_size integer ja
total_stems_usage integer ja
uploaded_at string (date-time) ja
last_played_at string (date-time) | null ja
play_count integer ja
directory DirectoryRef | null ja
normalized_metadata object ja
has_cover_art boolean ja
cover_image_url string | null ja
stems array of StemOut ja
analyze TransformationOut | null ja
metadata TransformationOut | null ja
separation TransformationOut | null ja
ml_analysis TransformationOut | null ja
mapping TransformationOut | null
queued_separation TransformationOut | null
parent_id string (uuid) | null
clip ClipOut | null

Beispiel

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

Delete File

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

Terminal-Fenster
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).

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · ExtractIn

Feld Typ Pflicht Beschreibung
start number ja
end number ja
title string | null

Antwort 202 · ExtractOut

Feld Typ Pflicht Beschreibung
status string ja
job_id string ja
audio_id string (uuid) ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · FavoriteIn

Feld Typ Pflicht Beschreibung
favorite boolean ja

Antwort 200 · FileSummary

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
favorite boolean ja
title string ja
description string ja
tags array of string ja
size integer ja
stems_usage integer ja
uploaded_at string (date-time) ja
last_played_at string (date-time) | null ja
directory DirectoryRef | null ja
has_cover_art boolean ja
parent_id string (uuid) | null
clip ClipOut | null
processes object
queue object
bpm number | null
key string | null

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 200 · TagsOut

Feld Typ Pflicht Beschreibung
tags array of string ja

Beispiel

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

Add Tags

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · TagsIn

Feld Typ Pflicht Beschreibung
tags array of string ja

Antwort 200 · TagsOut

Feld Typ Pflicht Beschreibung
tags array of string ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja
tag path string ja

Antwort 200 · TagsOut

Feld Typ Pflicht Beschreibung
tags array of string ja

Beispiel

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

Get Metadata

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 200 · MetadataOut

Feld Typ Pflicht Beschreibung
normalized object ja
has_cover_art boolean ja
cover_image_url string | null ja
technical object | null ja

Beispiel

Terminal-Fenster
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).

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 200 · StatusOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
transformations object ja

Beispiel

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

Delete All Stems

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

Delete Stem

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja
stem_name path string ja

Antwort 204 · kein Inhalt

Beispiel

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

List Families

Parameter

Name In Typ Pflicht Beschreibung
search query string | null
ordering query string | null
limit query integer
offset query integer

Antwort 200 · Page_FamilyOut_

Feld Typ Pflicht Beschreibung
items array of FamilyOut ja
total integer ja
limit integer ja
offset integer ja

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/harmony/families" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Families

Body · FamilyIn

Feld Typ Pflicht Beschreibung
name string ja
description string

Antwort 201 · FamilyOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
name string ja
description string ja

Beispiel

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

Get Families

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 200 · FamilyOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
name string ja
description string ja

Beispiel

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

Patch Families

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Body · FamilyPatch

Feld Typ Pflicht Beschreibung
name string | null
description string | null

Antwort 200 · FamilyOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
name string ja
description string ja

Beispiel

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

Delete Families

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

List Qualities

Parameter

Name In Typ Pflicht Beschreibung
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Antwort 200 · Page_QualityOut_

Feld Typ Pflicht Beschreibung
items array of QualityOut ja
total integer ja
limit integer ja
offset integer ja

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/harmony/qualities" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Quality

Body · QualityIn

Feld Typ Pflicht Beschreibung
key string ja
family_id string (uuid) ja
formula array of integer ja
description string

Antwort 201 · QualityOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
key string ja
family string ja
family_id string (uuid) ja
formula array of integer ja
aliases array of AliasOut ja
description string ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
key path string ja

Antwort 200 · QualityOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
key string ja
family string ja
family_id string (uuid) ja
formula array of integer ja
aliases array of AliasOut ja
description string ja

Beispiel

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

Patch Quality

Parameter

Name In Typ Pflicht Beschreibung
key path string ja

Body · QualityPatch

Feld Typ Pflicht Beschreibung
key string | null
family_id string (uuid) | null
formula array of integer | null
description string | null

Antwort 200 · QualityOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
key string ja
family string ja
family_id string (uuid) ja
formula array of integer ja
aliases array of AliasOut ja
description string ja

Beispiel

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

Delete Quality

Parameter

Name In Typ Pflicht Beschreibung
key path string ja

Antwort 204 · kein Inhalt

Beispiel

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

List Aliases

Parameter

Name In Typ Pflicht Beschreibung
quality query string (uuid) | null
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Antwort 200 · Page_AliasOut_

Feld Typ Pflicht Beschreibung
items array of AliasOut ja
total integer ja
limit integer ja
offset integer ja

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/harmony/aliases" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Aliases

Body · AliasIn

Feld Typ Pflicht Beschreibung
quality_id string (uuid) ja
alias string ja
is_preferred boolean

Antwort 201 · AliasOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
quality_id string (uuid) ja
alias string ja
is_preferred boolean ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 200 · AliasOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
quality_id string (uuid) ja
alias string ja
is_preferred boolean ja

Beispiel

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

Patch Aliases

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Body · AliasPatch

Feld Typ Pflicht Beschreibung
quality_id string (uuid) | null
alias string | null
is_preferred boolean | null

Antwort 200 · AliasOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
quality_id string (uuid) ja
alias string ja
is_preferred boolean ja

Beispiel

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

Delete Aliases

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

List Types

Parameter

Name In Typ Pflicht Beschreibung
quality query string (uuid) | null
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Antwort 200 · Page_ChordTypeOut_

Feld Typ Pflicht Beschreibung
items array of ChordTypeOut ja
total integer ja
limit integer ja
offset integer ja

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/harmony/types" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Types

Body · ChordTypeIn

Feld Typ Pflicht Beschreibung
label string ja
description string
quality_id string (uuid) | null

Antwort 201 · ChordTypeOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
label string ja
description string ja
quality_id string (uuid) | null ja
quality_key string | null ja
family string | null ja

Beispiel

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

Get Types

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 200 · ChordTypeOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
label string ja
description string ja
quality_id string (uuid) | null ja
quality_key string | null ja
family string | null ja

Beispiel

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

Patch Types

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Body · ChordTypePatch

Feld Typ Pflicht Beschreibung
label string | null
description string | null
quality_id string (uuid) | null

Antwort 200 · ChordTypeOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
label string ja
description string ja
quality_id string (uuid) | null ja
quality_key string | null ja
family string | null ja

Beispiel

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

Delete Types

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

List Instruments

Parameter

Name In Typ Pflicht Beschreibung
search query string | null
ordering query string | null
limit query integer
offset query integer

Antwort 200 · Page_InstrumentOut_

Feld Typ Pflicht Beschreibung
items array of InstrumentOut ja
total integer ja
limit integer ja
offset integer ja

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/harmony/instruments" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Instruments

Body · InstrumentIn

Feld Typ Pflicht Beschreibung
name string ja
string_count integer

Antwort 201 · InstrumentOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
name string ja
string_count integer ja

Beispiel

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

Get Instruments

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 200 · InstrumentOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
name string ja
string_count integer ja

Beispiel

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

Patch Instruments

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Body · InstrumentPatch

Feld Typ Pflicht Beschreibung
name string | null
string_count integer | null

Antwort 200 · InstrumentOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
name string ja
string_count integer ja

Beispiel

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

Delete Instruments

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

List Tunings

Parameter

Name In Typ Pflicht Beschreibung
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

Antwort 200 · Page_TuningOut_

Feld Typ Pflicht Beschreibung
items array of TuningOut ja
total integer ja
limit integer ja
offset integer ja

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/harmony/tunings" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Tunings

Body · TuningIn

Feld Typ Pflicht Beschreibung
instrument_id string (uuid) ja
name string ja
open_strings array of string ja
is_default boolean

Antwort 201 · TuningOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
instrument InstrumentOut ja
name string ja
open_strings array of string ja
is_default boolean ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 200 · TuningOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
instrument InstrumentOut ja
name string ja
open_strings array of string ja
is_default boolean ja

Beispiel

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

Patch Tunings

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Body · TuningPatch

Feld Typ Pflicht Beschreibung
instrument_id string (uuid) | null
name string | null
open_strings array of string | null
is_default boolean | null

Antwort 200 · TuningOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
instrument InstrumentOut ja
name string ja
open_strings array of string ja
is_default boolean ja

Beispiel

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

Delete Tunings

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

List Voicing Tags

Parameter

Name In Typ Pflicht Beschreibung
search query string | null
ordering query string | null
limit query integer
offset query integer

Antwort 200 · Page_VoicingTagOut_

Feld Typ Pflicht Beschreibung
items array of VoicingTagOut ja
total integer ja
limit integer ja
offset integer ja

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing-Tags

Body · VoicingTagIn

Feld Typ Pflicht Beschreibung
name string ja

Antwort 201 · VoicingTagOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
name string ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 200 · VoicingTagOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
name string ja

Beispiel

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

Patch Voicing-Tags

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Body · VoicingTagPatch

Feld Typ Pflicht Beschreibung
name string | null

Antwort 200 · VoicingTagOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
name string ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

List Voicings

Parameter

Name In Typ Pflicht Beschreibung
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

Antwort 200 · Page_VoicingOut_

Feld Typ Pflicht Beschreibung
items array of VoicingOut ja
total integer ja
limit integer ja
offset integer ja

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicings" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing

Body · VoicingIn

Feld Typ Pflicht Beschreibung
entry_id string (uuid) ja
tuning_id string (uuid) ja
name string
source string
caged "" | “C” | “A” | “G” | “E” | “D”
frets array of integer ja
fingers array of integer | null
barres array of object
inversion integer
difficulty integer
tag_names array of string

Antwort 201 · VoicingOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
entry EntryLite ja
tuning TuningLite ja
name string ja
source string ja
caged string ja
frets array of integer ja
fingers array of integer | null ja
barres array of object ja
inversion integer ja
is_open boolean ja
fret_low integer ja
fret_high integer ja
difficulty integer ja
tags array of string ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
voicing_id path string (uuid) ja

Antwort 200 · VoicingOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
entry EntryLite ja
tuning TuningLite ja
name string ja
source string ja
caged string ja
frets array of integer ja
fingers array of integer | null ja
barres array of object ja
inversion integer ja
is_open boolean ja
fret_low integer ja
fret_high integer ja
difficulty integer ja
tags array of string ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

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

Patch Voicing

Parameter

Name In Typ Pflicht Beschreibung
voicing_id path string (uuid) ja

Body · VoicingPatch

Feld Typ Pflicht Beschreibung
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

Antwort 200 · VoicingOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
entry EntryLite ja
tuning TuningLite ja
name string ja
source string ja
caged string ja
frets array of integer ja
fingers array of integer | null ja
barres array of object ja
inversion integer ja
is_open boolean ja
fret_low integer ja
fret_high integer ja
difficulty integer ja
tags array of string ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

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

Delete Voicing

Parameter

Name In Typ Pflicht Beschreibung
voicing_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

List References

Parameter

Name In Typ Pflicht Beschreibung
search query string | null
ordering query string | null
limit query integer
offset query integer

Antwort 200 · Page_ReferenceOut_

Feld Typ Pflicht Beschreibung
items array of ReferenceOut ja
total integer ja
limit integer ja
offset integer ja

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/harmony/references" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create References

Body · ReferenceIn

Feld Typ Pflicht Beschreibung
title string ja
author string
details string

Antwort 201 · ReferenceOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
title string ja
author string ja
details string ja

Beispiel

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

Get References

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 200 · ReferenceOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
title string ja
author string ja
details string ja

Beispiel

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

Patch References

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Body · ReferencePatch

Feld Typ Pflicht Beschreibung
title string | null
author string | null
details string | null

Antwort 200 · ReferenceOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
title string ja
author string ja
details string ja

Beispiel

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

Delete References

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

List Voicing References

Parameter

Name In Typ Pflicht Beschreibung
voicing query string (uuid) | null
source query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Antwort 200 · Page_VoicingReferenceOut_

Feld Typ Pflicht Beschreibung
items array of VoicingReferenceOut ja
total integer ja
limit integer ja
offset integer ja

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-references" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing-References

Body · VoicingReferenceIn

Feld Typ Pflicht Beschreibung
voicing_id string (uuid) ja
source_id string (uuid) ja
page string
figure string

Antwort 201 · VoicingReferenceOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
voicing_id string (uuid) ja
source ReferenceOut ja
page string ja
figure string ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 200 · VoicingReferenceOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
voicing_id string (uuid) ja
source ReferenceOut ja
page string ja
figure string ja

Beispiel

Terminal-Fenster
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}

Abschnitt betitelt „PATCH /api/v1/harmony/voicing-references/{item_id}“

Patch Voicing-References

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Body · VoicingReferencePatch

Feld Typ Pflicht Beschreibung
voicing_id string (uuid) | null
source_id string (uuid) | null
page string | null
figure string | null

Antwort 200 · VoicingReferenceOut

Feld Typ Pflicht Beschreibung
created_at string (date-time) ja
updated_at string (date-time) ja
id string (uuid) ja
voicing_id string (uuid) ja
source ReferenceOut ja
page string ja
figure string ja

Beispiel

Terminal-Fenster
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}

Abschnitt betitelt „DELETE /api/v1/harmony/voicing-references/{item_id}“

Delete Voicing-References

Parameter

Name In Typ Pflicht Beschreibung
item_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

List Entries

Parameter

Name In Typ Pflicht Beschreibung
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

Antwort 200 · Page_EntryOut_

Feld Typ Pflicht Beschreibung
items array of EntryOut ja
total integer ja
limit integer ja
offset integer ja

Beispiel

Terminal-Fenster
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.

Parameter

Name In Typ Pflicht Beschreibung
symbol query string

Antwort 200 · EntryOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
symbol string ja
root string ja
bass string ja
quality QualityOut ja
family string ja

Beispiel

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

Get Entry

Parameter

Name In Typ Pflicht Beschreibung
entry_id path string (uuid) ja

Antwort 200 · EntryOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
symbol string ja
root string ja
bass string ja
quality QualityOut ja
family string ja

Beispiel

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

Live

Antwort 200 · object

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/health/live" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Ready

Antwort 200 · object

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/health/ready" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Presign Upload

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Body · PresignIn

Feld Typ Pflicht Beschreibung
filename string ja
content_type string ja
size integer ja

Antwort 200 · PresignOut

Feld Typ Pflicht Beschreibung
upload_url string ja
key string ja
audio_id string (uuid) ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Body · app__modules__ingestion__schemas__ConfirmIn

Feld Typ Pflicht Beschreibung
key string ja
audio_id string (uuid) ja
directory_id string (uuid) | null

Antwort 201 · ConfirmOut

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

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Body · IngestUrlIn

Feld Typ Pflicht Beschreibung
video_url string (uri) ja
format IngestFormat

Antwort 202 · IngestUrlOut

Feld Typ Pflicht Beschreibung
status string ja
job_id string ja
audio_id string (uuid) ja

Beispiel

Terminal-Fenster
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

Antwort 200 · ConditionsOut

Feld Typ Pflicht Beschreibung
extensions array of string ja
max_file_size_mb integer ja

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/uploads/conditions" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Lyrics

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 200 · LyricsOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
file_id string (uuid) ja
lines array of object ja
offset_ms integer ja
source string ja
source_ref string | null ja
synced boolean ja
updated_by string (uuid) | null ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

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

Put Lyrics

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · LyricsIn

Feld Typ Pflicht Beschreibung
lines array of LyricsLine ja
offset_ms integer
source “manual” | “file” | “lrclib”
source_ref string | null

Antwort 200 · LyricsOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
file_id string (uuid) ja
lines array of object ja
offset_ms integer ja
source string ja
source_ref string | null ja
synced boolean ja
updated_by string (uuid) | null ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

Terminal-Fenster
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.

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja
track query string | null
artist query string | null
q query string | null

Antwort 200 · array of LyricsCandidate

Beispiel

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

List Sections

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja
section_type query string | null

Antwort 200 · array of SectionOut

Beispiel

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

Create Section

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · SectionIn

Feld Typ Pflicht Beschreibung
start number ja
end number | null
section_type string ja
observation string | null

Antwort 201 · SectionOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
file_id string (uuid) ja
start number ja
end number | null ja
label string ja
color string | null ja
section_type string ja
section_number integer ja
observation string | null ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
section_id path string (uuid) ja

Body · SectionPatch

Feld Typ Pflicht Beschreibung
start number | null
end number | null
section_type string | null
observation string | null

Antwort 200 · SectionOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
file_id string (uuid) ja
start number ja
end number | null ja
label string ja
color string | null ja
section_type string ja
section_number integer ja
observation string | null ja

Beispiel

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

Delete Section

Parameter

Name In Typ Pflicht Beschreibung
section_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

List Marks

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 200 · array of MarkOut

Beispiel

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

Create Mark

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · MarkIn

Feld Typ Pflicht Beschreibung
start number ja
name string | null
observation string | null

Antwort 201 · MarkOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
file_id string (uuid) ja
start number ja
name string ja
observation string | null ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
mark_id path string (uuid) ja

Body · MarkPatch

Feld Typ Pflicht Beschreibung
start number | null
name string | null
observation string | null

Antwort 200 · MarkOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
file_id string (uuid) ja
start number ja
name string ja
observation string | null ja

Beispiel

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

Delete Mark

Parameter

Name In Typ Pflicht Beschreibung
mark_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

List Loops

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 200 · array of LoopOut

Beispiel

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

Create Loop

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · LoopIn

Feld Typ Pflicht Beschreibung
start number ja
end number | null
name string | null
observation string | null

Antwort 201 · LoopOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
file_id string (uuid) ja
start number ja
end number | null ja
name string ja
observation string | null ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
loop_id path string (uuid) ja

Body · LoopPatch

Feld Typ Pflicht Beschreibung
start number | null
end number | null
name string | null
observation string | null

Antwort 200 · LoopOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
file_id string (uuid) ja
start number ja
end number | null ja
name string ja
observation string | null ja

Beispiel

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

Delete Loop

Parameter

Name In Typ Pflicht Beschreibung
loop_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

Terminal-Fenster
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.

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 200 · BeatsOut

Feld Typ Pflicht Beschreibung
id string (uuid) | null
beats array of object ja
meter array of MeterEntry ja
source string ja
beat_count integer ja
created_at string (date-time) | null
updated_at string (date-time) | null

Beispiel

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

Put Beats

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · BeatsIn

Feld Typ Pflicht Beschreibung
beats array of number ja
meter array of MeterEntry

Antwort 200 · BeatsOut

Feld Typ Pflicht Beschreibung
id string (uuid) | null
beats array of object ja
meter array of MeterEntry ja
source string ja
beat_count integer ja
created_at string (date-time) | null
updated_at string (date-time) | null

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

Terminal-Fenster
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.

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Antwort 202 · ImportCreated

Feld Typ Pflicht Beschreibung
import_job_id string (uuid) ja
job_id string ja
status string ja

Beispiel

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

Import Status

Parameter

Name In Typ Pflicht Beschreibung
import_id path string (uuid) ja

Antwort 200 · app__modules__music_import__schemas__ImportJobOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
original_filename string ja
source_format string ja
status string ja
notation_id string (uuid) | null ja
error_message string ja
progress_percent integer ja
progress_message string ja
parser_logs object ja
created_at string (date-time) ja

Beispiel

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

Formats

Enabled import formats and their extensions.

Antwort 200 · array of FormatOut

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/import/formats" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Notations

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja
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

Antwort 200 · Page_NotationSummary_

Feld Typ Pflicht Beschreibung
items array of NotationSummary ja
total integer ja
limit integer ja
offset integer ja

Beispiel

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

Create Notation

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Body · NotationIn

Feld Typ Pflicht Beschreibung
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)

Antwort 201 · NotationOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) | null ja
title string ja
author string ja
audio_file_id string (uuid) | null ja
audio_file_title string ja
data object ja
format_version integer ja
source_format string ja
origin string ja
tempo integer ja
time_signature string ja
number_of_measures integer ja
start_time number | null ja
end_time number | null ja
repeat_sync boolean ja
sync_map object ja
favorite boolean ja
tags array of string ja
category_ids array of string (uuid) ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

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

Notation Tags

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Antwort 200 · TagsOut

Feld Typ Pflicht Beschreibung
tags array of string ja

Beispiel

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

Recent Notations

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Antwort 200 · array of NotationSummary

Beispiel

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

Get Notation

Parameter

Name In Typ Pflicht Beschreibung
notation_id path string (uuid) ja

Antwort 200 · NotationOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) | null ja
title string ja
author string ja
audio_file_id string (uuid) | null ja
audio_file_title string ja
data object ja
format_version integer ja
source_format string ja
origin string ja
tempo integer ja
time_signature string ja
number_of_measures integer ja
start_time number | null ja
end_time number | null ja
repeat_sync boolean ja
sync_map object ja
favorite boolean ja
tags array of string ja
category_ids array of string (uuid) ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

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

Patch Notation

Parameter

Name In Typ Pflicht Beschreibung
notation_id path string (uuid) ja

Body · NotationPatch

Feld Typ Pflicht Beschreibung
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

Antwort 200 · NotationOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) | null ja
title string ja
author string ja
audio_file_id string (uuid) | null ja
audio_file_title string ja
data object ja
format_version integer ja
source_format string ja
origin string ja
tempo integer ja
time_signature string ja
number_of_measures integer ja
start_time number | null ja
end_time number | null ja
repeat_sync boolean ja
sync_map object ja
favorite boolean ja
tags array of string ja
category_ids array of string (uuid) ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

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

Delete Notation

Parameter

Name In Typ Pflicht Beschreibung
notation_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

Set Favorite

Parameter

Name In Typ Pflicht Beschreibung
notation_id path string (uuid) ja

Body · FavoriteIn

Feld Typ Pflicht Beschreibung
favorite boolean ja

Antwort 200 · NotationOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) | null ja
title string ja
author string ja
audio_file_id string (uuid) | null ja
audio_file_title string ja
data object ja
format_version integer ja
source_format string ja
origin string ja
tempo integer ja
time_signature string ja
number_of_measures integer ja
start_time number | null ja
end_time number | null ja
repeat_sync boolean ja
sync_map object ja
favorite boolean ja
tags array of string ja
category_ids array of string (uuid) ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

Terminal-Fenster
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

Antwort 200 · array of CategoryOut

Beispiel

Terminal-Fenster
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.

Antwort 200 · PlatformOut

Feld Typ Pflicht Beschreibung
payments_enabled boolean ja
site_show_signup boolean ja
site_hidden_pages array of string ja
site_announcement string ja
site_announcement_url string ja

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/platform" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Playlists

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Antwort 200 · array of PlaylistOut

Beispiel

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

Create Playlist

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Body · PlaylistIn

Feld Typ Pflicht Beschreibung
name string ja
repeat_mode “off” | “all” | “one”

Antwort 201 · PlaylistDetail

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) | null ja
name string ja
repeat_mode string ja
track_count integer ja
created_at string (date-time) ja
updated_at string (date-time) ja
tracks array of app__modules__playlists__schemas__TrackOut ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
playlist_id path string (uuid) ja

Antwort 200 · PlaylistDetail

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) | null ja
name string ja
repeat_mode string ja
track_count integer ja
created_at string (date-time) ja
updated_at string (date-time) ja
tracks array of app__modules__playlists__schemas__TrackOut ja

Beispiel

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

Patch Playlist

Parameter

Name In Typ Pflicht Beschreibung
playlist_id path string (uuid) ja

Body · PlaylistPatch

Feld Typ Pflicht Beschreibung
name string | null
repeat_mode “off” | “all” | “one” | null

Antwort 200 · PlaylistDetail

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) | null ja
name string ja
repeat_mode string ja
track_count integer ja
created_at string (date-time) ja
updated_at string (date-time) ja
tracks array of app__modules__playlists__schemas__TrackOut ja

Beispiel

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

Delete Playlist

Parameter

Name In Typ Pflicht Beschreibung
playlist_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

List Tracks

Parameter

Name In Typ Pflicht Beschreibung
playlist_id path string (uuid) ja

Antwort 200 · array of app__modules__playlists__schemas__TrackOut

Beispiel

Terminal-Fenster
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).

Parameter

Name In Typ Pflicht Beschreibung
playlist_id path string (uuid) ja

Body · TracksIn

Feld Typ Pflicht Beschreibung
tracks array of TrackIn ja

Antwort 201 · array of app__modules__playlists__schemas__TrackOut

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
playlist_id path string (uuid) ja

Body · ReorderIn

Feld Typ Pflicht Beschreibung
order array of string (uuid) ja

Antwort 200 · array of app__modules__playlists__schemas__TrackOut

Beispiel

Terminal-Fenster
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}

Abschnitt betitelt „DELETE /api/v1/playlists/{playlist_id}/tracks/{track_id}“

Remove Track

Parameter

Name In Typ Pflicht Beschreibung
playlist_id path string (uuid) ja
track_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

Stream File

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja
quality query “low” | “medium” | “high” | null Profile chosen by the player when the preference is auto.

Beispiel

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

Stream File Url

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja
quality query “low” | “medium” | “high” | null Profile chosen by the player when the preference is auto.

Antwort 200 · StreamUrlOut

Feld Typ Pflicht Beschreibung
url string ja
expires_in integer ja
quality string | null

Beispiel

Terminal-Fenster
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

Abschnitt betitelt „GET /api/v1/files/{file_id}/stems/{stem_name}/stream“

Stream Stem

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja
stem_name path string ja

Beispiel

Terminal-Fenster
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

Abschnitt betitelt „GET /api/v1/files/{file_id}/stems/{stem_name}/stream-url“

Stream Stem Url

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja
stem_name path string ja

Antwort 200 · StreamUrlOut

Feld Typ Pflicht Beschreibung
url string ja
expires_in integer ja
quality string | null

Beispiel

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

Presign Take

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · TakePresignIn

Feld Typ Pflicht Beschreibung
content_type “audio/wav” | “audio/x-wav” | “audio/wave”
size integer ja

Antwort 200 · TakePresignOut

Feld Typ Pflicht Beschreibung
upload_url string ja
key string ja
take_id string (uuid) ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · TakeConfirmIn

Feld Typ Pflicht Beschreibung
take_id string (uuid) ja
key string ja
name string | null
duration number ja
offset_ms integer
latency_ms integer
sample_rate integer ja
speed number
pitch_tones number

Antwort 201 · TakeOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
audio_file_id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) ja
author_name string ja
mine boolean ja
name string ja
status string ja
duration number ja
offset_ms integer ja
latency_ms integer ja
sample_rate integer ja
speed number ja
pitch_tones number ja
file_size integer ja
shared boolean ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

Terminal-Fenster
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).

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Antwort 200 · array of TakeOut

Beispiel

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

Get Take

Parameter

Name In Typ Pflicht Beschreibung
take_id path string (uuid) ja

Antwort 200 · TakeOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
audio_file_id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) ja
author_name string ja
mine boolean ja
name string ja
status string ja
duration number ja
offset_ms integer ja
latency_ms integer ja
sample_rate integer ja
speed number ja
pitch_tones number ja
file_size integer ja
shared boolean ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

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

Update Take

Author only.

Parameter

Name In Typ Pflicht Beschreibung
take_id path string (uuid) ja

Body · TakePatch

Feld Typ Pflicht Beschreibung
name string | null
shared boolean | null
offset_ms integer | null

Antwort 200 · TakeOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
audio_file_id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) ja
author_name string ja
mine boolean ja
name string ja
status string ja
duration number ja
offset_ms integer ja
latency_ms integer ja
sample_rate integer ja
speed number ja
pitch_tones number ja
file_size integer ja
shared boolean ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

Terminal-Fenster
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).

Parameter

Name In Typ Pflicht Beschreibung
take_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

Take Stream Url

Parameter

Name In Typ Pflicht Beschreibung
take_id path string (uuid) ja

Antwort 200 · TakeStreamUrlOut

Feld Typ Pflicht Beschreibung
url string ja
expires_in integer ja

Beispiel

Terminal-Fenster
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.

Antwort 200 · object

Beispiel

Terminal-Fenster
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.

Antwort 200 · object

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/tools/metronome/catalog" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Presets

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Antwort 200 · array of MetronomePresetOut

Beispiel

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

Create Preset

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Body · MetronomePresetIn

Feld Typ Pflicht Beschreibung
name string ja
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

Antwort 201 · MetronomePresetOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) | null ja
name string ja
base_preset_id string | null ja
bpm number ja
numerator integer ja
denominator integer ja
subdivision string ja
bars integer ja
pattern string ja
swing_ratio number | null ja
voice string ja
layers array of object ja
audio_file_id string (uuid) | null ja
analysis object | null ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
preset_id path string (uuid) ja

Antwort 200 · MetronomePresetOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) | null ja
name string ja
base_preset_id string | null ja
bpm number ja
numerator integer ja
denominator integer ja
subdivision string ja
bars integer ja
pattern string ja
swing_ratio number | null ja
voice string ja
layers array of object ja
audio_file_id string (uuid) | null ja
analysis object | null ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

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

Patch Preset

Parameter

Name In Typ Pflicht Beschreibung
preset_id path string (uuid) ja

Body · MetronomePresetPatch

Feld Typ Pflicht Beschreibung
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

Antwort 200 · MetronomePresetOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) | null ja
name string ja
base_preset_id string | null ja
bpm number ja
numerator integer ja
denominator integer ja
subdivision string ja
bars integer ja
pattern string ja
swing_ratio number | null ja
voice string ja
layers array of object ja
audio_file_id string (uuid) | null ja
analysis object | null ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

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

Delete Preset

Parameter

Name In Typ Pflicht Beschreibung
preset_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

Terminal-Fenster
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

Abschnitt betitelt „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).

Parameter

Name In Typ Pflicht Beschreibung
preset_id path string (uuid) ja

Antwort 202 · app__modules__tools__schemas__JobOut

Feld Typ Pflicht Beschreibung
status string ja
job_id string ja
audio_id string (uuid) | null

Beispiel

Terminal-Fenster
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).

Parameter

Name In Typ Pflicht Beschreibung
preset_id path string (uuid) ja

Body · RenderIn

Feld Typ Pflicht Beschreibung
bars integer

Antwort 202 · app__modules__tools__schemas__JobOut

Feld Typ Pflicht Beschreibung
status string ja
job_id string ja
audio_id string (uuid) | null

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Antwort 200 · array of TunerProfileOut

Beispiel

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

Create Tuning

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Body · TunerProfileIn

Feld Typ Pflicht Beschreibung
instrument string ja
name string ja
strings array of string ja
reference_hz number
temperament string
tonic integer

Antwort 201 · TunerProfileOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) | null ja
instrument string ja
name string ja
strings array of string ja
reference_hz number ja
temperament string ja
tonic integer ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
tuning_id path string (uuid) ja

Body · TunerProfilePatch

Feld Typ Pflicht Beschreibung
instrument string | null
name string | null
strings array of string | null
reference_hz number | null
temperament string | null
tonic integer | null

Antwort 200 · TunerProfileOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
group_id string (uuid) ja
created_by string (uuid) | null ja
instrument string ja
name string ja
strings array of string ja
reference_hz number ja
temperament string ja
tonic integer ja
created_at string (date-time) ja
updated_at string (date-time) ja

Beispiel

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

Delete Tuning

Parameter

Name In Typ Pflicht Beschreibung
tuning_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

Terminal-Fenster
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.

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja

Body · MetadataIn

Feld Typ Pflicht Beschreibung
tags object ja

Antwort 202 · MetadataJobOut

Feld Typ Pflicht Beschreibung
status string
job_id string ja
transformation_id string (uuid) ja

Beispiel

Terminal-Fenster
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}

Abschnitt betitelt „POST /api/v1/files/{file_id}/transformations/{process}“

Trigger

Parameter

Name In Typ Pflicht Beschreibung
file_id path string (uuid) ja
process path string ja

Body · TriggerIn | null

Antwort 202 · TriggerOut

Feld Typ Pflicht Beschreibung
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 ja
job_id string ja
transformation_id string (uuid) ja

Beispiel

Terminal-Fenster
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.

Antwort 200 · array of SeparationModelOut

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/separation-models" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

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

Abschnitt betitelt „POST /api/v1/groups/{group_id}/files/batch-metadata“

Batch Metadata

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

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Body · BatchMetadataIn

Feld Typ Pflicht Beschreibung
file_ids array of string (uuid) ja
tags object ja

Antwort 202 · BatchMetadataOut

Feld Typ Pflicht Beschreibung
jobs array of BatchJob ja

Beispiel

Terminal-Fenster
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

Parameter

Name In Typ Pflicht Beschreibung
job_id path string ja

Antwort 200 · app__modules__transformer__schemas__JobOut

Feld Typ Pflicht Beschreibung
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 ja
state string ja
status string ja
progress integer ja
ready boolean ja
successful boolean ja
transformation_id string (uuid) ja

Beispiel

Terminal-Fenster
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.

Parameter

Name In Typ Pflicht Beschreibung
job_id path string ja

Antwort 204 · kein Inhalt

Beispiel

Terminal-Fenster
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).

Parameter

Name In Typ Pflicht Beschreibung
job_id path string ja

Antwort 200 · object

Beispiel

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

DELETE /api/v1/transformations/{transformation_id}

Abschnitt betitelt „DELETE /api/v1/transformations/{transformation_id}“

Delete Transformation

Parameter

Name In Typ Pflicht Beschreibung
transformation_id path string (uuid) ja

Antwort 204 · kein Inhalt

Beispiel

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

My Workspaces

Antwort 200 · array of WorkspaceOut

Beispiel

Terminal-Fenster
curl -X GET "$JAMCLOUD_API/api/v1/groups" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Workspace

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Antwort 200 · WorkspaceOut

Feld Typ Pflicht Beschreibung
id string (uuid) ja
name string ja
kind string ja
my_role GroupRole ja
created_at string (date-time) ja
owner_id string (uuid) | null ja
member_count integer ja Members besides the owner.
members array of WorkspaceMemberOut ja
settings WorkspaceSettingsOut

Beispiel

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

Get Settings

Parameter

Name In Typ Pflicht Beschreibung
group_id path string (uuid) ja

Antwort 200 · WorkspaceSettingsOut

Feld Typ Pflicht Beschreibung
boards_viewers_can_write boolean

Beispiel

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