Référence de l'API
La référence pour les développeurs : ce que chaque route attend et renvoie. Pour obtenir une clé et voir ce qu’elle peut atteindre, lisez d’abord API.
Versions
Section intitulée « Versions »La version figure dans chaque chemin : /api/v1. Dans la version 1, les routes et les champs ne font que s’ajouter, sans jamais être renommés ni supprimés : ignorez les champs que vous ne connaissez pas. Un changement qui casserait votre code arrive dans une nouvelle version (/api/v2), la v1 continuant de tourner à côté.
Démarrage rapide
Section intitulée « Démarrage rapide »Gardez l’adresse de l’API et votre clé dans des variables d’environnement, puis appelez-la avec n’importe quel client HTTP : aucun SDK à installer.
export JAMCLOUD_API=https://api-jamcloud.australfactory.clexport 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 codeconst workspaces = await res.json();Conventions
Section intitulée « Conventions »- Du JSON en entrée et en sortie, des champs en
snake_case, des identifiants UUID. - Les listes renvoient
{items, total, limit, offset}; paginez avec les paramètreslimitetoffset. - Les erreurs sont en problem+json
{type, title, status, code, details}: testezcode, il ne change jamais. - Un envoi de fichier se fait en trois appels : presign,
PUTdu fichier vers l’URL renvoyée, puis confirm. L’URL est valable 15 minutes et n’accepte que la taillesizedéclarée, en un seulPUT. - 503
circuit_open: attendez les secondes deRetry-After, puis réessayez.
Chaque section ci-dessous est une ressource ; chaque route donne ses paramètres, ses champs, sa réponse et un exemple curl.
Version de l’API : v1 · chaque route ci-dessous commence par /api/v1
GET /api/v1/groups/{group_id}/boards
Section intitulée « GET /api/v1/groups/{group_id}/boards »List Boards
The workspace’s free boards (track boards are reached through their file).
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui | |
limit |
query | integer | ||
offset |
query | integer |
Renvoie 200 · Page_BoardOut_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of BoardOut | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/boards" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/groups/{group_id}/boards
Section intitulée « POST /api/v1/groups/{group_id}/boards »Create Board
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Corps · BoardIn
| Champ | Type | Requis | Description |
|---|---|---|---|
title |
string | oui |
Renvoie 201 · BoardDetail
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
file_id |
string (uuid) | null | oui | |
created_by |
string (uuid) | null | oui | |
title |
string | oui | |
version |
integer | oui | |
item_count |
integer | oui | |
can_write |
boolean | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
items |
array of BoardItemOut | oui |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/boards" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"title":"…"}'GET /api/v1/files/{file_id}/board
Section intitulée « GET /api/v1/files/{file_id}/board »Get Track Board
The file’s board, created empty on first read.
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 200 · BoardDetail
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
file_id |
string (uuid) | null | oui | |
created_by |
string (uuid) | null | oui | |
title |
string | oui | |
version |
integer | oui | |
item_count |
integer | oui | |
can_write |
boolean | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
items |
array of BoardItemOut | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/board" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/boards/{board_id}
Section intitulée « GET /api/v1/boards/{board_id} »Get Board
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
board_id |
path | string (uuid) | oui |
Renvoie 200 · BoardDetail
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
file_id |
string (uuid) | null | oui | |
created_by |
string (uuid) | null | oui | |
title |
string | oui | |
version |
integer | oui | |
item_count |
integer | oui | |
can_write |
boolean | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
items |
array of BoardItemOut | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/boards/{board_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/boards/{board_id}
Section intitulée « PATCH /api/v1/boards/{board_id} »Rename Board
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
board_id |
path | string (uuid) | oui |
Corps · BoardPatch
| Champ | Type | Requis | Description |
|---|---|---|---|
title |
string | oui |
Renvoie 200 · BoardOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
file_id |
string (uuid) | null | oui | |
created_by |
string (uuid) | null | oui | |
title |
string | oui | |
version |
integer | oui | |
item_count |
integer | oui | |
can_write |
boolean | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/boards/{board_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"title":"…"}'DELETE /api/v1/boards/{board_id}
Section intitulée « DELETE /api/v1/boards/{board_id} »Delete Board
Owner only; a track’s board can’t be deleted on its own.
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
board_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/boards/{board_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/boards/{board_id}/ops
Section intitulée « POST /api/v1/boards/{board_id}/ops »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"}).
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
board_id |
path | string (uuid) | oui |
Corps · OpsIn
| Champ | Type | Requis | Description |
|---|---|---|---|
client_id |
string | oui | |
ops |
array of UpsertOp | DeleteOp | ClearOp | oui |
Renvoie 200 · OpsOut
| Champ | Type | Requis | Description |
|---|---|---|---|
version |
integer | oui | |
items |
array of ItemRev | oui |
Exemple
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 /api/v1/files/{file_id}/chart
Section intitulée « GET /api/v1/files/{file_id}/chart »Get Chart
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 200 · ChartOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
file_id |
string (uuid) | oui | |
content |
object | oui | |
anchor_bar |
integer | oui | |
source |
string | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/chart" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PUT /api/v1/files/{file_id}/chart
Section intitulée « PUT /api/v1/files/{file_id}/chart »Put Chart
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · ChartIn
| Champ | Type | Requis | Description |
|---|---|---|---|
content |
ChartContent | oui | |
anchor_bar |
integer | ||
source |
“manual” | “import” |
Renvoie 200 · ChartOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
file_id |
string (uuid) | oui | |
content |
object | oui | |
anchor_bar |
integer | oui | |
source |
string | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X PUT "$JAMCLOUD_API/api/v1/files/{file_id}/chart" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"content":{}}'DELETE /api/v1/files/{file_id}/chart
Section intitulée « DELETE /api/v1/files/{file_id}/chart »Delete Chart
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/chart" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/score
Section intitulée « GET /api/v1/files/{file_id}/score »Get Score
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 200 · ScoreOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
file_id |
string (uuid) | oui | |
status |
“processing” | “ready” | “failed” | oui | |
format |
“guitarpro” | “musicxml” | null | oui | |
source_format |
string | oui | |
original_filename |
string | oui | |
title |
string | oui | |
anchor_bar |
integer | oui | |
settings |
object | oui | |
error_code |
string | null | oui | |
error_message |
string | null | oui | |
url |
string | null | oui | |
original_url |
string | oui | |
revision |
integer | oui | |
edited_at |
string (date-time) | null | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/score" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/score
Section intitulée « POST /api/v1/files/{file_id}/score »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).
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 201 · ScoreOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
file_id |
string (uuid) | oui | |
status |
“processing” | “ready” | “failed” | oui | |
format |
“guitarpro” | “musicxml” | null | oui | |
source_format |
string | oui | |
original_filename |
string | oui | |
title |
string | oui | |
anchor_bar |
integer | oui | |
settings |
object | oui | |
error_code |
string | null | oui | |
error_message |
string | null | oui | |
url |
string | null | oui | |
original_url |
string | oui | |
revision |
integer | oui | |
edited_at |
string (date-time) | null | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/score" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/files/{file_id}/score
Section intitulée « PATCH /api/v1/files/{file_id}/score »Patch Score
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · ScorePatch
| Champ | Type | Requis | Description |
|---|---|---|---|
anchor_bar |
integer | null | ||
settings |
object | null |
Renvoie 200 · ScoreOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
file_id |
string (uuid) | oui | |
status |
“processing” | “ready” | “failed” | oui | |
format |
“guitarpro” | “musicxml” | null | oui | |
source_format |
string | oui | |
original_filename |
string | oui | |
title |
string | oui | |
anchor_bar |
integer | oui | |
settings |
object | oui | |
error_code |
string | null | oui | |
error_message |
string | null | oui | |
url |
string | null | oui | |
original_url |
string | oui | |
revision |
integer | oui | |
edited_at |
string (date-time) | null | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/files/{file_id}/score" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/files/{file_id}/score
Section intitulée « DELETE /api/v1/files/{file_id}/score »Delete Score
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/score" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PUT /api/v1/files/{file_id}/score/content
Section intitulée « PUT /api/v1/files/{file_id}/score/content »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).
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 200 · ScoreOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
file_id |
string (uuid) | oui | |
status |
“processing” | “ready” | “failed” | oui | |
format |
“guitarpro” | “musicxml” | null | oui | |
source_format |
string | oui | |
original_filename |
string | oui | |
title |
string | oui | |
anchor_bar |
integer | oui | |
settings |
object | oui | |
error_code |
string | null | oui | |
error_message |
string | null | oui | |
url |
string | null | oui | |
original_url |
string | oui | |
revision |
integer | oui | |
edited_at |
string (date-time) | null | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X PUT "$JAMCLOUD_API/api/v1/files/{file_id}/score/content" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/export
Section intitulée « POST /api/v1/files/{file_id}/export »Export File
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · ExportIn
| Champ | Type | Requis | Description |
|---|---|---|---|
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 |
Renvoie 202 · ExportJobOut
| Champ | Type | Requis | Description |
|---|---|---|---|
job_id |
string | oui | |
file_id |
string | null | ||
status |
“queued” | “processing” | “ready” | “failed” | oui | |
filename |
string | null | ||
url |
string | null | ||
expires_in |
integer | null | ||
code |
string | null |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/export" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'GET /api/v1/exports/{job_id}
Section intitulée « GET /api/v1/exports/{job_id} »Export Status
The requester’s export job; a fresh download link while it is ready.
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
job_id |
path | string (uuid) | oui |
Renvoie 200 · ExportJobOut
| Champ | Type | Requis | Description |
|---|---|---|---|
job_id |
string | oui | |
file_id |
string | null | ||
status |
“queued” | “processing” | “ready” | “failed” | oui | |
filename |
string | null | ||
url |
string | null | ||
expires_in |
integer | null | ||
code |
string | null |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/exports/{job_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Feedback
Section intitulée « Feedback »POST /api/v1/feedback
Section intitulée « POST /api/v1/feedback »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.
Corps · FeedbackIn
| Champ | Type | Requis | Description |
|---|---|---|---|
category |
“bug” | “idea” | “question” | “other” | oui | |
message |
string | oui | |
group_id |
string | null | The workspace open in the app. | |
context |
FeedbackContext |
Renvoie 201 · FeedbackOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string | oui | |
category |
“bug” | “idea” | “question” | “other” | oui | |
status |
“new” | “done” | oui | |
created_at |
string (date-time) | oui |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/feedback" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"category":"bug","message":"…"}'GET /api/v1/groups/{group_id}/directories
Section intitulée « GET /api/v1/groups/{group_id}/directories »List Directories
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Renvoie 200 · array of DirectoryOut
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/directories" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/groups/{group_id}/directories
Section intitulée « POST /api/v1/groups/{group_id}/directories »Create Directory
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Corps · DirectoryIn
| Champ | Type | Requis | Description |
|---|---|---|---|
name |
string | oui |
Renvoie 200 · object
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/directories" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"…"}'DELETE /api/v1/directories/{directory_id}
Section intitulée « DELETE /api/v1/directories/{directory_id} »Delete Directory
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
directory_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/directories/{directory_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/groups/{group_id}/files
Section intitulée « GET /api/v1/groups/{group_id}/files »List Files
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui | |
tags |
query | array of string | ||
favorite |
query | boolean | null | ||
search |
query | string | ||
directory_id |
query | string (uuid) | null | ||
limit |
query | integer | ||
offset |
query | integer |
Renvoie 200 · Page_FileSummary_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of FileSummary | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/files" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/groups/{group_id}/files/recent
Section intitulée « GET /api/v1/groups/{group_id}/files/recent »Recent Files
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Renvoie 200 · array of FileSummary
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/files/recent" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/groups/{group_id}/tags
Section intitulée « GET /api/v1/groups/{group_id}/tags »Group Tags
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Renvoie 200 · TagsOut
| Champ | Type | Requis | Description |
|---|---|---|---|
tags |
array of string | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/tags" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/groups/{group_id}/files/batch-delete
Section intitulée « POST /api/v1/groups/{group_id}/files/batch-delete »Batch Delete
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Corps · BatchIds
| Champ | Type | Requis | Description |
|---|---|---|---|
file_ids |
array of string (uuid) | oui |
Renvoie 200 · BatchDeleteOut
| Champ | Type | Requis | Description |
|---|---|---|---|
deleted |
integer | oui |
Exemple
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>"]}'POST /api/v1/groups/{group_id}/files/batch-move
Section intitulée « POST /api/v1/groups/{group_id}/files/batch-move »Batch Move
Move files to another workspace the caller owns (personal <-> shared, same owner).
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Corps · BatchMoveIn
| Champ | Type | Requis | Description |
|---|---|---|---|
file_ids |
array of string (uuid) | oui | |
target_group_id |
string (uuid) | oui |
Renvoie 200 · BatchMoveOut
| Champ | Type | Requis | Description |
|---|---|---|---|
moved |
integer | oui |
Exemple
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>"}'GET /api/v1/files
Section intitulée « GET /api/v1/files »List All Files
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
tags |
query | array of string | ||
favorite |
query | boolean | null | ||
search |
query | string | ||
limit |
query | integer | ||
offset |
query | integer |
Renvoie 200 · Page_FileSummary_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of FileSummary | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/recent
Section intitulée « GET /api/v1/files/recent »Recent All Files
Renvoie 200 · array of FileSummary
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/recent" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/tags
Section intitulée « GET /api/v1/files/tags »All Tags
Renvoie 200 · TagsOut
| Champ | Type | Requis | Description |
|---|---|---|---|
tags |
array of string | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/tags" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}
Section intitulée « GET /api/v1/files/{file_id} »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.
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui | |
play |
query | boolean |
Renvoie 200 · FileOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
title |
string | oui | |
description |
string | oui | |
favorite |
boolean | oui | |
tags |
array of string | oui | |
file_size |
integer | oui | |
total_stems_usage |
integer | oui | |
uploaded_at |
string (date-time) | oui | |
last_played_at |
string (date-time) | null | oui | |
play_count |
integer | oui | |
directory |
DirectoryRef | null | oui | |
normalized_metadata |
object | oui | |
has_cover_art |
boolean | oui | |
cover_image_url |
string | null | oui | |
stems |
array of StemOut | oui | |
analyze |
TransformationOut | null | oui | |
metadata |
TransformationOut | null | oui | |
separation |
TransformationOut | null | oui | |
ml_analysis |
TransformationOut | null | oui | |
mapping |
TransformationOut | null | ||
queued_separation |
TransformationOut | null | ||
parent_id |
string (uuid) | null | ||
clip |
ClipOut | null |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/files/{file_id}
Section intitulée « PATCH /api/v1/files/{file_id} »Patch File
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · FilePatch
| Champ | Type | Requis | Description |
|---|---|---|---|
title |
string | null | ||
description |
string | null | ||
favorite |
boolean | null | ||
tags |
array of string | null | ||
directory_id |
string (uuid) | null | ||
parent_id |
null |
Renvoie 200 · FileOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
title |
string | oui | |
description |
string | oui | |
favorite |
boolean | oui | |
tags |
array of string | oui | |
file_size |
integer | oui | |
total_stems_usage |
integer | oui | |
uploaded_at |
string (date-time) | oui | |
last_played_at |
string (date-time) | null | oui | |
play_count |
integer | oui | |
directory |
DirectoryRef | null | oui | |
normalized_metadata |
object | oui | |
has_cover_art |
boolean | oui | |
cover_image_url |
string | null | oui | |
stems |
array of StemOut | oui | |
analyze |
TransformationOut | null | oui | |
metadata |
TransformationOut | null | oui | |
separation |
TransformationOut | null | oui | |
ml_analysis |
TransformationOut | null | oui | |
mapping |
TransformationOut | null | ||
queued_separation |
TransformationOut | null | ||
parent_id |
string (uuid) | null | ||
clip |
ClipOut | null |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/files/{file_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/files/{file_id}
Section intitulée « DELETE /api/v1/files/{file_id} »Delete File
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/extract
Section intitulée « POST /api/v1/files/{file_id}/extract »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).
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · ExtractIn
| Champ | Type | Requis | Description |
|---|---|---|---|
start |
number | oui | |
end |
number | oui | |
title |
string | null |
Renvoie 202 · ExtractOut
| Champ | Type | Requis | Description |
|---|---|---|---|
status |
string | oui | |
job_id |
string | oui | |
audio_id |
string (uuid) | oui |
Exemple
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}'POST /api/v1/files/{file_id}/favorite
Section intitulée « POST /api/v1/files/{file_id}/favorite »Set Favorite
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · FavoriteIn
| Champ | Type | Requis | Description |
|---|---|---|---|
favorite |
boolean | oui |
Renvoie 200 · FileSummary
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
favorite |
boolean | oui | |
title |
string | oui | |
description |
string | oui | |
tags |
array of string | oui | |
size |
integer | oui | |
stems_usage |
integer | oui | |
uploaded_at |
string (date-time) | oui | |
last_played_at |
string (date-time) | null | oui | |
directory |
DirectoryRef | null | oui | |
has_cover_art |
boolean | oui | |
parent_id |
string (uuid) | null | ||
clip |
ClipOut | null | ||
processes |
object | ||
queue |
object | ||
bpm |
number | null | ||
key |
string | null |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/favorite" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"favorite":false}'GET /api/v1/files/{file_id}/tags
Section intitulée « GET /api/v1/files/{file_id}/tags »File Tags
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 200 · TagsOut
| Champ | Type | Requis | Description |
|---|---|---|---|
tags |
array of string | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/tags" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/tags
Section intitulée « POST /api/v1/files/{file_id}/tags »Add Tags
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · TagsIn
| Champ | Type | Requis | Description |
|---|---|---|---|
tags |
array of string | oui |
Renvoie 200 · TagsOut
| Champ | Type | Requis | Description |
|---|---|---|---|
tags |
array of string | oui |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/tags" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"tags":["…"]}'DELETE /api/v1/files/{file_id}/tags/{tag}
Section intitulée « DELETE /api/v1/files/{file_id}/tags/{tag} »Remove Tag
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui | |
tag |
path | string | oui |
Renvoie 200 · TagsOut
| Champ | Type | Requis | Description |
|---|---|---|---|
tags |
array of string | oui |
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/tags/{tag}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/metadata
Section intitulée « GET /api/v1/files/{file_id}/metadata »Get Metadata
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 200 · MetadataOut
| Champ | Type | Requis | Description |
|---|---|---|---|
normalized |
object | oui | |
has_cover_art |
boolean | oui | |
cover_image_url |
string | null | oui | |
technical |
object | null | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/metadata" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/status
Section intitulée « GET /api/v1/files/{file_id}/status »File Status
Latest state of every process run on the file (any status).
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 200 · StatusOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
transformations |
object | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/status" \ -H "Authorization: Bearer $JAMCLOUD_KEY"DELETE /api/v1/files/{file_id}/stems
Section intitulée « DELETE /api/v1/files/{file_id}/stems »Delete All Stems
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/stems" \ -H "Authorization: Bearer $JAMCLOUD_KEY"DELETE /api/v1/files/{file_id}/stems/{stem_name}
Section intitulée « DELETE /api/v1/files/{file_id}/stems/{stem_name} »Delete Stem
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui | |
stem_name |
path | string | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/stems/{stem_name}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/families
Section intitulée « GET /api/v1/harmony/families »List Families
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
search |
query | string | null | ||
ordering |
query | string | null | ||
limit |
query | integer | ||
offset |
query | integer |
Renvoie 200 · Page_FamilyOut_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of FamilyOut | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/families" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/families
Section intitulée « POST /api/v1/harmony/families »Create Families
Corps · FamilyIn
| Champ | Type | Requis | Description |
|---|---|---|---|
name |
string | oui | |
description |
string |
Renvoie 201 · FamilyOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
name |
string | oui | |
description |
string | oui |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/harmony/families" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"…"}'GET /api/v1/harmony/families/{item_id}
Section intitulée « GET /api/v1/harmony/families/{item_id} »Get Families
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 200 · FamilyOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
name |
string | oui | |
description |
string | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/families/{item_id}
Section intitulée « PATCH /api/v1/harmony/families/{item_id} »Patch Families
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Corps · FamilyPatch
| Champ | Type | Requis | Description |
|---|---|---|---|
name |
string | null | ||
description |
string | null |
Renvoie 200 · FamilyOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
name |
string | oui | |
description |
string | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/harmony/families/{item_id}
Section intitulée « DELETE /api/v1/harmony/families/{item_id} »Delete Families
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/qualities
Section intitulée « GET /api/v1/harmony/qualities »List Qualities
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
family |
query | string (uuid) | null | ||
search |
query | string | null | ||
ordering |
query | string | null | ||
limit |
query | integer | ||
offset |
query | integer |
Renvoie 200 · Page_QualityOut_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of QualityOut | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/qualities" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/qualities
Section intitulée « POST /api/v1/harmony/qualities »Create Quality
Corps · QualityIn
| Champ | Type | Requis | Description |
|---|---|---|---|
key |
string | oui | |
family_id |
string (uuid) | oui | |
formula |
array of integer | oui | |
description |
string |
Renvoie 201 · QualityOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
key |
string | oui | |
family |
string | oui | |
family_id |
string (uuid) | oui | |
formula |
array of integer | oui | |
aliases |
array of AliasOut | oui | |
description |
string | oui |
Exemple
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 /api/v1/harmony/qualities/{key}
Section intitulée « GET /api/v1/harmony/qualities/{key} »Get Quality
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
key |
path | string | oui |
Renvoie 200 · QualityOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
key |
string | oui | |
family |
string | oui | |
family_id |
string (uuid) | oui | |
formula |
array of integer | oui | |
aliases |
array of AliasOut | oui | |
description |
string | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/qualities/{key}
Section intitulée « PATCH /api/v1/harmony/qualities/{key} »Patch Quality
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
key |
path | string | oui |
Corps · QualityPatch
| Champ | Type | Requis | Description |
|---|---|---|---|
key |
string | null | ||
family_id |
string (uuid) | null | ||
formula |
array of integer | null | ||
description |
string | null |
Renvoie 200 · QualityOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
key |
string | oui | |
family |
string | oui | |
family_id |
string (uuid) | oui | |
formula |
array of integer | oui | |
aliases |
array of AliasOut | oui | |
description |
string | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/harmony/qualities/{key}
Section intitulée « DELETE /api/v1/harmony/qualities/{key} »Delete Quality
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
key |
path | string | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/aliases
Section intitulée « GET /api/v1/harmony/aliases »List Aliases
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
quality |
query | string (uuid) | null | ||
family |
query | string (uuid) | null | ||
search |
query | string | null | ||
ordering |
query | string | null | ||
limit |
query | integer | ||
offset |
query | integer |
Renvoie 200 · Page_AliasOut_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of AliasOut | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/aliases" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/aliases
Section intitulée « POST /api/v1/harmony/aliases »Create Aliases
Corps · AliasIn
| Champ | Type | Requis | Description |
|---|---|---|---|
quality_id |
string (uuid) | oui | |
alias |
string | oui | |
is_preferred |
boolean |
Renvoie 201 · AliasOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
quality_id |
string (uuid) | oui | |
alias |
string | oui | |
is_preferred |
boolean | oui |
Exemple
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 /api/v1/harmony/aliases/{item_id}
Section intitulée « GET /api/v1/harmony/aliases/{item_id} »Get Aliases
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 200 · AliasOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
quality_id |
string (uuid) | oui | |
alias |
string | oui | |
is_preferred |
boolean | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/aliases/{item_id}
Section intitulée « PATCH /api/v1/harmony/aliases/{item_id} »Patch Aliases
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Corps · AliasPatch
| Champ | Type | Requis | Description |
|---|---|---|---|
quality_id |
string (uuid) | null | ||
alias |
string | null | ||
is_preferred |
boolean | null |
Renvoie 200 · AliasOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
quality_id |
string (uuid) | oui | |
alias |
string | oui | |
is_preferred |
boolean | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/harmony/aliases/{item_id}
Section intitulée « DELETE /api/v1/harmony/aliases/{item_id} »Delete Aliases
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/types
Section intitulée « GET /api/v1/harmony/types »List Types
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
quality |
query | string (uuid) | null | ||
family |
query | string (uuid) | null | ||
search |
query | string | null | ||
ordering |
query | string | null | ||
limit |
query | integer | ||
offset |
query | integer |
Renvoie 200 · Page_ChordTypeOut_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of ChordTypeOut | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/types" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/types
Section intitulée « POST /api/v1/harmony/types »Create Types
Corps · ChordTypeIn
| Champ | Type | Requis | Description |
|---|---|---|---|
label |
string | oui | |
description |
string | ||
quality_id |
string (uuid) | null |
Renvoie 201 · ChordTypeOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
label |
string | oui | |
description |
string | oui | |
quality_id |
string (uuid) | null | oui | |
quality_key |
string | null | oui | |
family |
string | null | oui |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/harmony/types" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"label":"…"}'GET /api/v1/harmony/types/{item_id}
Section intitulée « GET /api/v1/harmony/types/{item_id} »Get Types
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 200 · ChordTypeOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
label |
string | oui | |
description |
string | oui | |
quality_id |
string (uuid) | null | oui | |
quality_key |
string | null | oui | |
family |
string | null | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/types/{item_id}
Section intitulée « PATCH /api/v1/harmony/types/{item_id} »Patch Types
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Corps · ChordTypePatch
| Champ | Type | Requis | Description |
|---|---|---|---|
label |
string | null | ||
description |
string | null | ||
quality_id |
string (uuid) | null |
Renvoie 200 · ChordTypeOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
label |
string | oui | |
description |
string | oui | |
quality_id |
string (uuid) | null | oui | |
quality_key |
string | null | oui | |
family |
string | null | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/harmony/types/{item_id}
Section intitulée « DELETE /api/v1/harmony/types/{item_id} »Delete Types
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/instruments
Section intitulée « GET /api/v1/harmony/instruments »List Instruments
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
search |
query | string | null | ||
ordering |
query | string | null | ||
limit |
query | integer | ||
offset |
query | integer |
Renvoie 200 · Page_InstrumentOut_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of InstrumentOut | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/instruments" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/instruments
Section intitulée « POST /api/v1/harmony/instruments »Create Instruments
Corps · InstrumentIn
| Champ | Type | Requis | Description |
|---|---|---|---|
name |
string | oui | |
string_count |
integer |
Renvoie 201 · InstrumentOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
name |
string | oui | |
string_count |
integer | oui |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/harmony/instruments" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"…"}'GET /api/v1/harmony/instruments/{item_id}
Section intitulée « GET /api/v1/harmony/instruments/{item_id} »Get Instruments
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 200 · InstrumentOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
name |
string | oui | |
string_count |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/instruments/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/instruments/{item_id}
Section intitulée « PATCH /api/v1/harmony/instruments/{item_id} »Patch Instruments
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Corps · InstrumentPatch
| Champ | Type | Requis | Description |
|---|---|---|---|
name |
string | null | ||
string_count |
integer | null |
Renvoie 200 · InstrumentOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
name |
string | oui | |
string_count |
integer | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/instruments/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/harmony/instruments/{item_id}
Section intitulée « DELETE /api/v1/harmony/instruments/{item_id} »Delete Instruments
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/instruments/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/tunings
Section intitulée « GET /api/v1/harmony/tunings »List Tunings
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
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 |
Renvoie 200 · Page_TuningOut_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of TuningOut | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/tunings" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/tunings
Section intitulée « POST /api/v1/harmony/tunings »Create Tunings
Corps · TuningIn
| Champ | Type | Requis | Description |
|---|---|---|---|
instrument_id |
string (uuid) | oui | |
name |
string | oui | |
open_strings |
array of string | oui | |
is_default |
boolean |
Renvoie 201 · TuningOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
instrument |
InstrumentOut | oui | |
name |
string | oui | |
open_strings |
array of string | oui | |
is_default |
boolean | oui |
Exemple
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 /api/v1/harmony/tunings/{item_id}
Section intitulée « GET /api/v1/harmony/tunings/{item_id} »Get Tunings
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 200 · TuningOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
instrument |
InstrumentOut | oui | |
name |
string | oui | |
open_strings |
array of string | oui | |
is_default |
boolean | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/tunings/{item_id}
Section intitulée « PATCH /api/v1/harmony/tunings/{item_id} »Patch Tunings
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Corps · TuningPatch
| Champ | Type | Requis | Description |
|---|---|---|---|
instrument_id |
string (uuid) | null | ||
name |
string | null | ||
open_strings |
array of string | null | ||
is_default |
boolean | null |
Renvoie 200 · TuningOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
instrument |
InstrumentOut | oui | |
name |
string | oui | |
open_strings |
array of string | oui | |
is_default |
boolean | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/harmony/tunings/{item_id}
Section intitulée « DELETE /api/v1/harmony/tunings/{item_id} »Delete Tunings
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/voicing-tags
Section intitulée « GET /api/v1/harmony/voicing-tags »List Voicing Tags
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
search |
query | string | null | ||
ordering |
query | string | null | ||
limit |
query | integer | ||
offset |
query | integer |
Renvoie 200 · Page_VoicingTagOut_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of VoicingTagOut | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-tags" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/voicing-tags
Section intitulée « POST /api/v1/harmony/voicing-tags »Create Voicing-Tags
Corps · VoicingTagIn
| Champ | Type | Requis | Description |
|---|---|---|---|
name |
string | oui |
Renvoie 201 · VoicingTagOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
name |
string | oui |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/harmony/voicing-tags" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"…"}'GET /api/v1/harmony/voicing-tags/{item_id}
Section intitulée « GET /api/v1/harmony/voicing-tags/{item_id} »Get Voicing-Tags
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 200 · VoicingTagOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
name |
string | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-tags/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/voicing-tags/{item_id}
Section intitulée « PATCH /api/v1/harmony/voicing-tags/{item_id} »Patch Voicing-Tags
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Corps · VoicingTagPatch
| Champ | Type | Requis | Description |
|---|---|---|---|
name |
string | null |
Renvoie 200 · VoicingTagOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
name |
string | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/voicing-tags/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/harmony/voicing-tags/{item_id}
Section intitulée « DELETE /api/v1/harmony/voicing-tags/{item_id} »Delete Voicing-Tags
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/voicing-tags/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/voicings
Section intitulée « GET /api/v1/harmony/voicings »List Voicings
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
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 |
Renvoie 200 · Page_VoicingOut_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of VoicingOut | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicings" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/voicings
Section intitulée « POST /api/v1/harmony/voicings »Create Voicing
Corps · VoicingIn
| Champ | Type | Requis | Description |
|---|---|---|---|
entry_id |
string (uuid) | oui | |
tuning_id |
string (uuid) | oui | |
name |
string | ||
source |
string | ||
caged |
"" | “C” | “A” | “G” | “E” | “D” | ||
frets |
array of integer | oui | |
fingers |
array of integer | null | ||
barres |
array of object | ||
inversion |
integer | ||
difficulty |
integer | ||
tag_names |
array of string |
Renvoie 201 · VoicingOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
entry |
EntryLite | oui | |
tuning |
TuningLite | oui | |
name |
string | oui | |
source |
string | oui | |
caged |
string | oui | |
frets |
array of integer | oui | |
fingers |
array of integer | null | oui | |
barres |
array of object | oui | |
inversion |
integer | oui | |
is_open |
boolean | oui | |
fret_low |
integer | oui | |
fret_high |
integer | oui | |
difficulty |
integer | oui | |
tags |
array of string | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
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 /api/v1/harmony/voicings/{voicing_id}
Section intitulée « GET /api/v1/harmony/voicings/{voicing_id} »Get Voicing
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
voicing_id |
path | string (uuid) | oui |
Renvoie 200 · VoicingOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
entry |
EntryLite | oui | |
tuning |
TuningLite | oui | |
name |
string | oui | |
source |
string | oui | |
caged |
string | oui | |
frets |
array of integer | oui | |
fingers |
array of integer | null | oui | |
barres |
array of object | oui | |
inversion |
integer | oui | |
is_open |
boolean | oui | |
fret_low |
integer | oui | |
fret_high |
integer | oui | |
difficulty |
integer | oui | |
tags |
array of string | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicings/{voicing_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/voicings/{voicing_id}
Section intitulée « PATCH /api/v1/harmony/voicings/{voicing_id} »Patch Voicing
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
voicing_id |
path | string (uuid) | oui |
Corps · VoicingPatch
| Champ | Type | Requis | Description |
|---|---|---|---|
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 |
Renvoie 200 · VoicingOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
entry |
EntryLite | oui | |
tuning |
TuningLite | oui | |
name |
string | oui | |
source |
string | oui | |
caged |
string | oui | |
frets |
array of integer | oui | |
fingers |
array of integer | null | oui | |
barres |
array of object | oui | |
inversion |
integer | oui | |
is_open |
boolean | oui | |
fret_low |
integer | oui | |
fret_high |
integer | oui | |
difficulty |
integer | oui | |
tags |
array of string | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/voicings/{voicing_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/harmony/voicings/{voicing_id}
Section intitulée « DELETE /api/v1/harmony/voicings/{voicing_id} »Delete Voicing
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
voicing_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/voicings/{voicing_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/references
Section intitulée « GET /api/v1/harmony/references »List References
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
search |
query | string | null | ||
ordering |
query | string | null | ||
limit |
query | integer | ||
offset |
query | integer |
Renvoie 200 · Page_ReferenceOut_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of ReferenceOut | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/references" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/references
Section intitulée « POST /api/v1/harmony/references »Create References
Corps · ReferenceIn
| Champ | Type | Requis | Description |
|---|---|---|---|
title |
string | oui | |
author |
string | ||
details |
string |
Renvoie 201 · ReferenceOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
title |
string | oui | |
author |
string | oui | |
details |
string | oui |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/harmony/references" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"title":"…"}'GET /api/v1/harmony/references/{item_id}
Section intitulée « GET /api/v1/harmony/references/{item_id} »Get References
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 200 · ReferenceOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
title |
string | oui | |
author |
string | oui | |
details |
string | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/references/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/references/{item_id}
Section intitulée « PATCH /api/v1/harmony/references/{item_id} »Patch References
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Corps · ReferencePatch
| Champ | Type | Requis | Description |
|---|---|---|---|
title |
string | null | ||
author |
string | null | ||
details |
string | null |
Renvoie 200 · ReferenceOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
title |
string | oui | |
author |
string | oui | |
details |
string | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/references/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/harmony/references/{item_id}
Section intitulée « DELETE /api/v1/harmony/references/{item_id} »Delete References
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/references/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/voicing-references
Section intitulée « GET /api/v1/harmony/voicing-references »List Voicing References
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
voicing |
query | string (uuid) | null | ||
source |
query | string (uuid) | null | ||
search |
query | string | null | ||
ordering |
query | string | null | ||
limit |
query | integer | ||
offset |
query | integer |
Renvoie 200 · Page_VoicingReferenceOut_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of VoicingReferenceOut | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-references" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/voicing-references
Section intitulée « POST /api/v1/harmony/voicing-references »Create Voicing-References
Corps · VoicingReferenceIn
| Champ | Type | Requis | Description |
|---|---|---|---|
voicing_id |
string (uuid) | oui | |
source_id |
string (uuid) | oui | |
page |
string | ||
figure |
string |
Renvoie 201 · VoicingReferenceOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
voicing_id |
string (uuid) | oui | |
source |
ReferenceOut | oui | |
page |
string | oui | |
figure |
string | oui |
Exemple
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 /api/v1/harmony/voicing-references/{item_id}
Section intitulée « GET /api/v1/harmony/voicing-references/{item_id} »Get Voicing-References
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 200 · VoicingReferenceOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
voicing_id |
string (uuid) | oui | |
source |
ReferenceOut | oui | |
page |
string | oui | |
figure |
string | oui |
Exemple
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}
Section intitulée « PATCH /api/v1/harmony/voicing-references/{item_id} »Patch Voicing-References
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Corps · VoicingReferencePatch
| Champ | Type | Requis | Description |
|---|---|---|---|
voicing_id |
string (uuid) | null | ||
source_id |
string (uuid) | null | ||
page |
string | null | ||
figure |
string | null |
Renvoie 200 · VoicingReferenceOut
| Champ | Type | Requis | Description |
|---|---|---|---|
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
id |
string (uuid) | oui | |
voicing_id |
string (uuid) | oui | |
source |
ReferenceOut | oui | |
page |
string | oui | |
figure |
string | oui |
Exemple
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}
Section intitulée « DELETE /api/v1/harmony/voicing-references/{item_id} »Delete Voicing-References
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/voicing-references/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/entries
Section intitulée « GET /api/v1/harmony/entries »List Entries
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
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 |
Renvoie 200 · Page_EntryOut_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of EntryOut | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/entries/by-symbol
Section intitulée « GET /api/v1/harmony/entries/by-symbol »Entry By Symbol
Resolve Dbmaj7/Gb-style symbols to the canonical (sharp) entry.
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
symbol |
query | string |
Renvoie 200 · EntryOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
symbol |
string | oui | |
root |
string | oui | |
bass |
string | oui | |
quality |
QualityOut | oui | |
family |
string | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries/by-symbol" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/entries/{entry_id}
Section intitulée « GET /api/v1/harmony/entries/{entry_id} »Get Entry
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
entry_id |
path | string (uuid) | oui |
Renvoie 200 · EntryOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
symbol |
string | oui | |
root |
string | oui | |
bass |
string | oui | |
quality |
QualityOut | oui | |
family |
string | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries/{entry_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /health/live
Section intitulée « GET /health/live »Live
Renvoie 200 · object
Exemple
curl -X GET "$JAMCLOUD_API/health/live" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /health/ready
Section intitulée « GET /health/ready »Ready
Renvoie 200 · object
Exemple
curl -X GET "$JAMCLOUD_API/health/ready" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Ingestion
Section intitulée « Ingestion »POST /api/v1/groups/{group_id}/uploads/presign
Section intitulée « POST /api/v1/groups/{group_id}/uploads/presign »Presign Upload
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Corps · PresignIn
| Champ | Type | Requis | Description |
|---|---|---|---|
filename |
string | oui | |
content_type |
string | oui | |
size |
integer | oui |
Renvoie 200 · PresignOut
| Champ | Type | Requis | Description |
|---|---|---|---|
upload_url |
string | oui | |
key |
string | oui | |
audio_id |
string (uuid) | oui |
Exemple
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}'POST /api/v1/groups/{group_id}/uploads/confirm
Section intitulée « POST /api/v1/groups/{group_id}/uploads/confirm »Confirm Upload
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Corps · app__modules__ingestion__schemas__ConfirmIn
| Champ | Type | Requis | Description |
|---|---|---|---|
key |
string | oui | |
audio_id |
string (uuid) | oui | |
directory_id |
string (uuid) | null |
Renvoie 201 · ConfirmOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
title |
string | oui | |
description |
string | oui | |
favorite |
boolean | oui | |
tags |
array of string | oui | |
file_size |
integer | oui | |
total_stems_usage |
integer | oui | |
uploaded_at |
string (date-time) | oui | |
last_played_at |
string (date-time) | null | oui | |
play_count |
integer | oui | |
directory |
DirectoryRef | null | oui | |
normalized_metadata |
object | oui | |
has_cover_art |
boolean | oui | |
cover_image_url |
string | null | oui | |
stems |
array of StemOut | oui | |
analyze |
TransformationOut | null | oui | |
metadata |
TransformationOut | null | oui | |
separation |
TransformationOut | null | oui | |
ml_analysis |
TransformationOut | null | oui | |
mapping |
TransformationOut | null | ||
queued_separation |
TransformationOut | null | ||
parent_id |
string (uuid) | null | ||
clip |
ClipOut | null | ||
auto_tasks |
object | oui |
Exemple
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>"}'POST /api/v1/groups/{group_id}/ingest/url
Section intitulée « POST /api/v1/groups/{group_id}/ingest/url »Ingest Url
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Corps · IngestUrlIn
| Champ | Type | Requis | Description |
|---|---|---|---|
video_url |
string (uri) | oui | |
format |
IngestFormat |
Renvoie 202 · IngestUrlOut
| Champ | Type | Requis | Description |
|---|---|---|---|
status |
string | oui | |
job_id |
string | oui | |
audio_id |
string (uuid) | oui |
Exemple
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":"…"}'GET /api/v1/uploads/conditions
Section intitulée « GET /api/v1/uploads/conditions »Upload Conditions
Renvoie 200 · ConditionsOut
| Champ | Type | Requis | Description |
|---|---|---|---|
extensions |
array of string | oui | |
max_file_size_mb |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/uploads/conditions" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/lyrics
Section intitulée « GET /api/v1/files/{file_id}/lyrics »Get Lyrics
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 200 · LyricsOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
file_id |
string (uuid) | oui | |
lines |
array of object | oui | |
offset_ms |
integer | oui | |
source |
string | oui | |
source_ref |
string | null | oui | |
synced |
boolean | oui | |
updated_by |
string (uuid) | null | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PUT /api/v1/files/{file_id}/lyrics
Section intitulée « PUT /api/v1/files/{file_id}/lyrics »Put Lyrics
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · LyricsIn
| Champ | Type | Requis | Description |
|---|---|---|---|
lines |
array of LyricsLine | oui | |
offset_ms |
integer | ||
source |
“manual” | “file” | “lrclib” | ||
source_ref |
string | null |
Renvoie 200 · LyricsOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
file_id |
string (uuid) | oui | |
lines |
array of object | oui | |
offset_ms |
integer | oui | |
source |
string | oui | |
source_ref |
string | null | oui | |
synced |
boolean | oui | |
updated_by |
string (uuid) | null | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X PUT "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"lines":[{}]}'DELETE /api/v1/files/{file_id}/lyrics
Section intitulée « DELETE /api/v1/files/{file_id}/lyrics »Delete Lyrics
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/lyrics/search
Section intitulée « GET /api/v1/files/{file_id}/lyrics/search »Search Lyrics
LRCLIB records (at most 20). No term: the track’s own title and artist.
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui | |
track |
query | string | null | ||
artist |
query | string | null | ||
q |
query | string | null |
Renvoie 200 · array of LyricsCandidate
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics/search" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/sections
Section intitulée « GET /api/v1/files/{file_id}/sections »List Sections
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui | |
section_type |
query | string | null |
Renvoie 200 · array of SectionOut
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/sections" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/sections
Section intitulée « POST /api/v1/files/{file_id}/sections »Create Section
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · SectionIn
| Champ | Type | Requis | Description |
|---|---|---|---|
start |
number | oui | |
end |
number | null | ||
section_type |
string | oui | |
observation |
string | null |
Renvoie 201 · SectionOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
file_id |
string (uuid) | oui | |
start |
number | oui | |
end |
number | null | oui | |
label |
string | oui | |
color |
string | null | oui | |
section_type |
string | oui | |
section_number |
integer | oui | |
observation |
string | null | oui |
Exemple
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 /api/v1/sections/{section_id}
Section intitulée « PATCH /api/v1/sections/{section_id} »Patch Section
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
section_id |
path | string (uuid) | oui |
Corps · SectionPatch
| Champ | Type | Requis | Description |
|---|---|---|---|
start |
number | null | ||
end |
number | null | ||
section_type |
string | null | ||
observation |
string | null |
Renvoie 200 · SectionOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
file_id |
string (uuid) | oui | |
start |
number | oui | |
end |
number | null | oui | |
label |
string | oui | |
color |
string | null | oui | |
section_type |
string | oui | |
section_number |
integer | oui | |
observation |
string | null | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/sections/{section_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/sections/{section_id}
Section intitulée « DELETE /api/v1/sections/{section_id} »Delete Section
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
section_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/sections/{section_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/marks
Section intitulée « GET /api/v1/files/{file_id}/marks »List Marks
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 200 · array of MarkOut
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/marks" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/marks
Section intitulée « POST /api/v1/files/{file_id}/marks »Create Mark
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · MarkIn
| Champ | Type | Requis | Description |
|---|---|---|---|
start |
number | oui | |
name |
string | null | ||
observation |
string | null |
Renvoie 201 · MarkOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
file_id |
string (uuid) | oui | |
start |
number | oui | |
name |
string | oui | |
observation |
string | null | oui |
Exemple
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 /api/v1/marks/{mark_id}
Section intitulée « PATCH /api/v1/marks/{mark_id} »Patch Mark
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
mark_id |
path | string (uuid) | oui |
Corps · MarkPatch
| Champ | Type | Requis | Description |
|---|---|---|---|
start |
number | null | ||
name |
string | null | ||
observation |
string | null |
Renvoie 200 · MarkOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
file_id |
string (uuid) | oui | |
start |
number | oui | |
name |
string | oui | |
observation |
string | null | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/marks/{mark_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/marks/{mark_id}
Section intitulée « DELETE /api/v1/marks/{mark_id} »Delete Mark
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
mark_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/marks/{mark_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/loops
Section intitulée « GET /api/v1/files/{file_id}/loops »List Loops
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 200 · array of LoopOut
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/loops" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/loops
Section intitulée « POST /api/v1/files/{file_id}/loops »Create Loop
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · LoopIn
| Champ | Type | Requis | Description |
|---|---|---|---|
start |
number | oui | |
end |
number | null | ||
name |
string | null | ||
observation |
string | null |
Renvoie 201 · LoopOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
file_id |
string (uuid) | oui | |
start |
number | oui | |
end |
number | null | oui | |
name |
string | oui | |
observation |
string | null | oui |
Exemple
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 /api/v1/loops/{loop_id}
Section intitulée « PATCH /api/v1/loops/{loop_id} »Patch Loop
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
loop_id |
path | string (uuid) | oui |
Corps · LoopPatch
| Champ | Type | Requis | Description |
|---|---|---|---|
start |
number | null | ||
end |
number | null | ||
name |
string | null | ||
observation |
string | null |
Renvoie 200 · LoopOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
file_id |
string (uuid) | oui | |
start |
number | oui | |
end |
number | null | oui | |
name |
string | oui | |
observation |
string | null | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/loops/{loop_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/loops/{loop_id}
Section intitulée « DELETE /api/v1/loops/{loop_id} »Delete Loop
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
loop_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/loops/{loop_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/beats
Section intitulée « GET /api/v1/files/{file_id}/beats »Get Beats
The saved beat map, else the analysis beats with a suggested meter.
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 200 · BeatsOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | null | ||
beats |
array of object | oui | |
meter |
array of MeterEntry | oui | |
source |
string | oui | |
beat_count |
integer | oui | |
created_at |
string (date-time) | null | ||
updated_at |
string (date-time) | null |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/beats" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PUT /api/v1/files/{file_id}/beats
Section intitulée « PUT /api/v1/files/{file_id}/beats »Put Beats
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · BeatsIn
| Champ | Type | Requis | Description |
|---|---|---|---|
beats |
array of number | oui | |
meter |
array of MeterEntry |
Renvoie 200 · BeatsOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | null | ||
beats |
array of object | oui | |
meter |
array of MeterEntry | oui | |
source |
string | oui | |
beat_count |
integer | oui | |
created_at |
string (date-time) | null | ||
updated_at |
string (date-time) | null |
Exemple
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 /api/v1/files/{file_id}/beats
Section intitulée « DELETE /api/v1/files/{file_id}/beats »Delete Beats
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/beats" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Music import
Section intitulée « Music import »POST /api/v1/groups/{group_id}/imports
Section intitulée « POST /api/v1/groups/{group_id}/imports »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.
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Renvoie 202 · ImportCreated
| Champ | Type | Requis | Description |
|---|---|---|---|
import_job_id |
string (uuid) | oui | |
job_id |
string | oui | |
status |
string | oui |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/imports" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/imports/{import_id}
Section intitulée « GET /api/v1/imports/{import_id} »Import Status
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
import_id |
path | string (uuid) | oui |
Renvoie 200 · app__modules__music_import__schemas__ImportJobOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
original_filename |
string | oui | |
source_format |
string | oui | |
status |
string | oui | |
notation_id |
string (uuid) | null | oui | |
error_message |
string | oui | |
progress_percent |
integer | oui | |
progress_message |
string | oui | |
parser_logs |
object | oui | |
created_at |
string (date-time) | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/imports/{import_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/import/formats
Section intitulée « GET /api/v1/import/formats »Formats
Enabled import formats and their extensions.
Renvoie 200 · array of FormatOut
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/import/formats" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Notations
Section intitulée « Notations »GET /api/v1/groups/{group_id}/notations
Section intitulée « GET /api/v1/groups/{group_id}/notations »List Notations
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui | |
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 |
Renvoie 200 · Page_NotationSummary_
| Champ | Type | Requis | Description |
|---|---|---|---|
items |
array of NotationSummary | oui | |
total |
integer | oui | |
limit |
integer | oui | |
offset |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/notations" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/groups/{group_id}/notations
Section intitulée « POST /api/v1/groups/{group_id}/notations »Create Notation
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Corps · NotationIn
| Champ | Type | Requis | Description |
|---|---|---|---|
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) |
Renvoie 201 · NotationOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
title |
string | oui | |
author |
string | oui | |
audio_file_id |
string (uuid) | null | oui | |
audio_file_title |
string | oui | |
data |
object | oui | |
format_version |
integer | oui | |
source_format |
string | oui | |
origin |
string | oui | |
tempo |
integer | oui | |
time_signature |
string | oui | |
number_of_measures |
integer | oui | |
start_time |
number | null | oui | |
end_time |
number | null | oui | |
repeat_sync |
boolean | oui | |
sync_map |
object | oui | |
favorite |
boolean | oui | |
tags |
array of string | oui | |
category_ids |
array of string (uuid) | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/notations" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'GET /api/v1/groups/{group_id}/notations/tags
Section intitulée « GET /api/v1/groups/{group_id}/notations/tags »Notation Tags
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Renvoie 200 · TagsOut
| Champ | Type | Requis | Description |
|---|---|---|---|
tags |
array of string | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/notations/tags" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/groups/{group_id}/notations/recent
Section intitulée « GET /api/v1/groups/{group_id}/notations/recent »Recent Notations
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Renvoie 200 · array of NotationSummary
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/notations/recent" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/notations/{notation_id}
Section intitulée « GET /api/v1/notations/{notation_id} »Get Notation
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
notation_id |
path | string (uuid) | oui |
Renvoie 200 · NotationOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
title |
string | oui | |
author |
string | oui | |
audio_file_id |
string (uuid) | null | oui | |
audio_file_title |
string | oui | |
data |
object | oui | |
format_version |
integer | oui | |
source_format |
string | oui | |
origin |
string | oui | |
tempo |
integer | oui | |
time_signature |
string | oui | |
number_of_measures |
integer | oui | |
start_time |
number | null | oui | |
end_time |
number | null | oui | |
repeat_sync |
boolean | oui | |
sync_map |
object | oui | |
favorite |
boolean | oui | |
tags |
array of string | oui | |
category_ids |
array of string (uuid) | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/notations/{notation_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/notations/{notation_id}
Section intitulée « PATCH /api/v1/notations/{notation_id} »Patch Notation
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
notation_id |
path | string (uuid) | oui |
Corps · NotationPatch
| Champ | Type | Requis | Description |
|---|---|---|---|
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 |
Renvoie 200 · NotationOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
title |
string | oui | |
author |
string | oui | |
audio_file_id |
string (uuid) | null | oui | |
audio_file_title |
string | oui | |
data |
object | oui | |
format_version |
integer | oui | |
source_format |
string | oui | |
origin |
string | oui | |
tempo |
integer | oui | |
time_signature |
string | oui | |
number_of_measures |
integer | oui | |
start_time |
number | null | oui | |
end_time |
number | null | oui | |
repeat_sync |
boolean | oui | |
sync_map |
object | oui | |
favorite |
boolean | oui | |
tags |
array of string | oui | |
category_ids |
array of string (uuid) | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/notations/{notation_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/notations/{notation_id}
Section intitulée « DELETE /api/v1/notations/{notation_id} »Delete Notation
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
notation_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/notations/{notation_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/notations/{notation_id}/favorite
Section intitulée « POST /api/v1/notations/{notation_id}/favorite »Set Favorite
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
notation_id |
path | string (uuid) | oui |
Corps · FavoriteIn
| Champ | Type | Requis | Description |
|---|---|---|---|
favorite |
boolean | oui |
Renvoie 200 · NotationOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
title |
string | oui | |
author |
string | oui | |
audio_file_id |
string (uuid) | null | oui | |
audio_file_title |
string | oui | |
data |
object | oui | |
format_version |
integer | oui | |
source_format |
string | oui | |
origin |
string | oui | |
tempo |
integer | oui | |
time_signature |
string | oui | |
number_of_measures |
integer | oui | |
start_time |
number | null | oui | |
end_time |
number | null | oui | |
repeat_sync |
boolean | oui | |
sync_map |
object | oui | |
favorite |
boolean | oui | |
tags |
array of string | oui | |
category_ids |
array of string (uuid) | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/notations/{notation_id}/favorite" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"favorite":false}'GET /api/v1/notation-categories
Section intitulée « GET /api/v1/notation-categories »Categories
Renvoie 200 · array of CategoryOut
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/notation-categories" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Platform
Section intitulée « Platform »GET /api/v1/platform
Section intitulée « GET /api/v1/platform »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.
Renvoie 200 · PlatformOut
| Champ | Type | Requis | Description |
|---|---|---|---|
payments_enabled |
boolean | oui | |
site_show_signup |
boolean | oui | |
site_hidden_pages |
array of string | oui | |
site_announcement |
string | oui | |
site_announcement_url |
string | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/platform" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Playlists
Section intitulée « Playlists »GET /api/v1/groups/{group_id}/playlists
Section intitulée « GET /api/v1/groups/{group_id}/playlists »List Playlists
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Renvoie 200 · array of PlaylistOut
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/playlists" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/groups/{group_id}/playlists
Section intitulée « POST /api/v1/groups/{group_id}/playlists »Create Playlist
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Corps · PlaylistIn
| Champ | Type | Requis | Description |
|---|---|---|---|
name |
string | oui | |
repeat_mode |
“off” | “all” | “one” |
Renvoie 201 · PlaylistDetail
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
name |
string | oui | |
repeat_mode |
string | oui | |
track_count |
integer | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
tracks |
array of app__modules__playlists__schemas__TrackOut | oui |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/playlists" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"…"}'GET /api/v1/playlists/{playlist_id}
Section intitulée « GET /api/v1/playlists/{playlist_id} »Get Playlist
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | oui |
Renvoie 200 · PlaylistDetail
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
name |
string | oui | |
repeat_mode |
string | oui | |
track_count |
integer | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
tracks |
array of app__modules__playlists__schemas__TrackOut | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/playlists/{playlist_id}
Section intitulée « PATCH /api/v1/playlists/{playlist_id} »Patch Playlist
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | oui |
Corps · PlaylistPatch
| Champ | Type | Requis | Description |
|---|---|---|---|
name |
string | null | ||
repeat_mode |
“off” | “all” | “one” | null |
Renvoie 200 · PlaylistDetail
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
name |
string | oui | |
repeat_mode |
string | oui | |
track_count |
integer | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui | |
tracks |
array of app__modules__playlists__schemas__TrackOut | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/playlists/{playlist_id}
Section intitulée « DELETE /api/v1/playlists/{playlist_id} »Delete Playlist
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/playlists/{playlist_id}/tracks
Section intitulée « GET /api/v1/playlists/{playlist_id}/tracks »List Tracks
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | oui |
Renvoie 200 · array of app__modules__playlists__schemas__TrackOut
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/playlists/{playlist_id}/tracks" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/playlists/{playlist_id}/tracks
Section intitulée « POST /api/v1/playlists/{playlist_id}/tracks »Add Tracks
Appends at the end (position is accepted but ignored, as in Django).
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | oui |
Corps · TracksIn
| Champ | Type | Requis | Description |
|---|---|---|---|
tracks |
array of TrackIn | oui |
Renvoie 201 · array of app__modules__playlists__schemas__TrackOut
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/playlists/{playlist_id}/tracks" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{"tracks":[{}]}'PUT /api/v1/playlists/{playlist_id}/tracks
Section intitulée « PUT /api/v1/playlists/{playlist_id}/tracks »Reorder Tracks
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | oui |
Corps · ReorderIn
| Champ | Type | Requis | Description |
|---|---|---|---|
order |
array of string (uuid) | oui |
Renvoie 200 · array of app__modules__playlists__schemas__TrackOut
Exemple
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}
Section intitulée « DELETE /api/v1/playlists/{playlist_id}/tracks/{track_id} »Remove Track
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | oui | |
track_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/playlists/{playlist_id}/tracks/{track_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/stream
Section intitulée « GET /api/v1/files/{file_id}/stream »Stream File
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui | |
quality |
query | “low” | “medium” | “high” | null | Profile chosen by the player when the preference is auto. |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/stream" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/stream-url
Section intitulée « GET /api/v1/files/{file_id}/stream-url »Stream File Url
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui | |
quality |
query | “low” | “medium” | “high” | null | Profile chosen by the player when the preference is auto. |
Renvoie 200 · StreamUrlOut
| Champ | Type | Requis | Description |
|---|---|---|---|
url |
string | oui | |
expires_in |
integer | oui | |
quality |
string | null |
Exemple
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
Section intitulée « GET /api/v1/files/{file_id}/stems/{stem_name}/stream »Stream Stem
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui | |
stem_name |
path | string | oui |
Exemple
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
Section intitulée « GET /api/v1/files/{file_id}/stems/{stem_name}/stream-url »Stream Stem Url
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui | |
stem_name |
path | string | oui |
Renvoie 200 · StreamUrlOut
| Champ | Type | Requis | Description |
|---|---|---|---|
url |
string | oui | |
expires_in |
integer | oui | |
quality |
string | null |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/stems/{stem_name}/stream-url" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/takes/presign
Section intitulée « POST /api/v1/files/{file_id}/takes/presign »Presign Take
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · TakePresignIn
| Champ | Type | Requis | Description |
|---|---|---|---|
content_type |
“audio/wav” | “audio/x-wav” | “audio/wave” | ||
size |
integer | oui |
Renvoie 200 · TakePresignOut
| Champ | Type | Requis | Description |
|---|---|---|---|
upload_url |
string | oui | |
key |
string | oui | |
take_id |
string (uuid) | oui |
Exemple
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}'POST /api/v1/files/{file_id}/takes/confirm
Section intitulée « POST /api/v1/files/{file_id}/takes/confirm »Confirm Take
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · TakeConfirmIn
| Champ | Type | Requis | Description |
|---|---|---|---|
take_id |
string (uuid) | oui | |
key |
string | oui | |
name |
string | null | ||
duration |
number | oui | |
offset_ms |
integer | ||
latency_ms |
integer | ||
sample_rate |
integer | oui | |
speed |
number | ||
pitch_tones |
number |
Renvoie 201 · TakeOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
audio_file_id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | oui | |
author_name |
string | oui | |
mine |
boolean | oui | |
name |
string | oui | |
status |
string | oui | |
duration |
number | oui | |
offset_ms |
integer | oui | |
latency_ms |
integer | oui | |
sample_rate |
integer | oui | |
speed |
number | oui | |
pitch_tones |
number | oui | |
file_size |
integer | oui | |
shared |
boolean | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
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}'GET /api/v1/files/{file_id}/takes
Section intitulée « GET /api/v1/files/{file_id}/takes »List Takes
Mine and the shared ones, newest first (small, bounded list: a plain array).
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Renvoie 200 · array of TakeOut
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/takes" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/takes/{take_id}
Section intitulée « GET /api/v1/takes/{take_id} »Get Take
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
take_id |
path | string (uuid) | oui |
Renvoie 200 · TakeOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
audio_file_id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | oui | |
author_name |
string | oui | |
mine |
boolean | oui | |
name |
string | oui | |
status |
string | oui | |
duration |
number | oui | |
offset_ms |
integer | oui | |
latency_ms |
integer | oui | |
sample_rate |
integer | oui | |
speed |
number | oui | |
pitch_tones |
number | oui | |
file_size |
integer | oui | |
shared |
boolean | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/takes/{take_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/takes/{take_id}
Section intitulée « PATCH /api/v1/takes/{take_id} »Update Take
Author only.
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
take_id |
path | string (uuid) | oui |
Corps · TakePatch
| Champ | Type | Requis | Description |
|---|---|---|---|
name |
string | null | ||
shared |
boolean | null | ||
offset_ms |
integer | null |
Renvoie 200 · TakeOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
audio_file_id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | oui | |
author_name |
string | oui | |
mine |
boolean | oui | |
name |
string | oui | |
status |
string | oui | |
duration |
number | oui | |
offset_ms |
integer | oui | |
latency_ms |
integer | oui | |
sample_rate |
integer | oui | |
speed |
number | oui | |
pitch_tones |
number | oui | |
file_size |
integer | oui | |
shared |
boolean | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/takes/{take_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/takes/{take_id}
Section intitulée « DELETE /api/v1/takes/{take_id} »Delete Take
The author, or the workspace owner (for a take they can see: a shared one).
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
take_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/takes/{take_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/takes/{take_id}/stream-url
Section intitulée « GET /api/v1/takes/{take_id}/stream-url »Take Stream Url
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
take_id |
path | string (uuid) | oui |
Renvoie 200 · TakeStreamUrlOut
| Champ | Type | Requis | Description |
|---|---|---|---|
url |
string | oui | |
expires_in |
integer | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/takes/{take_id}/stream-url" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/tools/tuner/catalog
Section intitulée « GET /api/v1/tools/tuner/catalog »Tuner Catalog
Instruments, tunings (string notes + frequencies) and temperaments.
Renvoie 200 · object
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/tools/tuner/catalog" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/tools/metronome/catalog
Section intitulée « GET /api/v1/tools/metronome/catalog »Metronome Catalog
World-rhythm presets (clave, bell timelines, tala, aksak…) with their ethnomusicological notes, categories and sources.
Renvoie 200 · object
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/tools/metronome/catalog" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/groups/{group_id}/metronome-presets
Section intitulée « GET /api/v1/groups/{group_id}/metronome-presets »List Presets
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Renvoie 200 · array of MetronomePresetOut
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/metronome-presets" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/groups/{group_id}/metronome-presets
Section intitulée « POST /api/v1/groups/{group_id}/metronome-presets »Create Preset
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Corps · MetronomePresetIn
| Champ | Type | Requis | Description |
|---|---|---|---|
name |
string | oui | |
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 |
Renvoie 201 · MetronomePresetOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
name |
string | oui | |
base_preset_id |
string | null | oui | |
bpm |
number | oui | |
numerator |
integer | oui | |
denominator |
integer | oui | |
subdivision |
string | oui | |
bars |
integer | oui | |
pattern |
string | oui | |
swing_ratio |
number | null | oui | |
voice |
string | oui | |
layers |
array of object | oui | |
audio_file_id |
string (uuid) | null | oui | |
analysis |
object | null | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
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 /api/v1/metronome-presets/{preset_id}
Section intitulée « GET /api/v1/metronome-presets/{preset_id} »Get Preset
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
preset_id |
path | string (uuid) | oui |
Renvoie 200 · MetronomePresetOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
name |
string | oui | |
base_preset_id |
string | null | oui | |
bpm |
number | oui | |
numerator |
integer | oui | |
denominator |
integer | oui | |
subdivision |
string | oui | |
bars |
integer | oui | |
pattern |
string | oui | |
swing_ratio |
number | null | oui | |
voice |
string | oui | |
layers |
array of object | oui | |
audio_file_id |
string (uuid) | null | oui | |
analysis |
object | null | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/metronome-presets/{preset_id}
Section intitulée « PATCH /api/v1/metronome-presets/{preset_id} »Patch Preset
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
preset_id |
path | string (uuid) | oui |
Corps · MetronomePresetPatch
| Champ | Type | Requis | Description |
|---|---|---|---|
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 |
Renvoie 200 · MetronomePresetOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
name |
string | oui | |
base_preset_id |
string | null | oui | |
bpm |
number | oui | |
numerator |
integer | oui | |
denominator |
integer | oui | |
subdivision |
string | oui | |
bars |
integer | oui | |
pattern |
string | oui | |
swing_ratio |
number | null | oui | |
voice |
string | oui | |
layers |
array of object | oui | |
audio_file_id |
string (uuid) | null | oui | |
analysis |
object | null | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/metronome-presets/{preset_id}
Section intitulée « DELETE /api/v1/metronome-presets/{preset_id} »Delete Preset
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
preset_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
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
Section intitulée « 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).
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
preset_id |
path | string (uuid) | oui |
Renvoie 202 · app__modules__tools__schemas__JobOut
| Champ | Type | Requis | Description |
|---|---|---|---|
status |
string | oui | |
job_id |
string | oui | |
audio_id |
string (uuid) | null |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}/analyze-audio" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/metronome-presets/{preset_id}/render
Section intitulée « POST /api/v1/metronome-presets/{preset_id}/render »Render
Render a click track and import it into the library (same pipeline as an upload).
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
preset_id |
path | string (uuid) | oui |
Corps · RenderIn
| Champ | Type | Requis | Description |
|---|---|---|---|
bars |
integer |
Renvoie 202 · app__modules__tools__schemas__JobOut
| Champ | Type | Requis | Description |
|---|---|---|---|
status |
string | oui | |
job_id |
string | oui | |
audio_id |
string (uuid) | null |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}/render" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'GET /api/v1/groups/{group_id}/tuner-profiles
Section intitulée « GET /api/v1/groups/{group_id}/tuner-profiles »List Tunings
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Renvoie 200 · array of TunerProfileOut
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/tuner-profiles" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/groups/{group_id}/tuner-profiles
Section intitulée « POST /api/v1/groups/{group_id}/tuner-profiles »Create Tuning
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Corps · TunerProfileIn
| Champ | Type | Requis | Description |
|---|---|---|---|
instrument |
string | oui | |
name |
string | oui | |
strings |
array of string | oui | |
reference_hz |
number | ||
temperament |
string | ||
tonic |
integer |
Renvoie 201 · TunerProfileOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
instrument |
string | oui | |
name |
string | oui | |
strings |
array of string | oui | |
reference_hz |
number | oui | |
temperament |
string | oui | |
tonic |
integer | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
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 /api/v1/tuner-profiles/{tuning_id}
Section intitulée « PATCH /api/v1/tuner-profiles/{tuning_id} »Patch Tuning
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
tuning_id |
path | string (uuid) | oui |
Corps · TunerProfilePatch
| Champ | Type | Requis | Description |
|---|---|---|---|
instrument |
string | null | ||
name |
string | null | ||
strings |
array of string | null | ||
reference_hz |
number | null | ||
temperament |
string | null | ||
tonic |
integer | null |
Renvoie 200 · TunerProfileOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
group_id |
string (uuid) | oui | |
created_by |
string (uuid) | null | oui | |
instrument |
string | oui | |
name |
string | oui | |
strings |
array of string | oui | |
reference_hz |
number | oui | |
temperament |
string | oui | |
tonic |
integer | oui | |
created_at |
string (date-time) | oui | |
updated_at |
string (date-time) | oui |
Exemple
curl -X PATCH "$JAMCLOUD_API/api/v1/tuner-profiles/{tuning_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'DELETE /api/v1/tuner-profiles/{tuning_id}
Section intitulée « DELETE /api/v1/tuner-profiles/{tuning_id} »Delete Tuning
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
tuning_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/tuner-profiles/{tuning_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Transformer
Section intitulée « Transformer »PATCH /api/v1/files/{file_id}/metadata
Section intitulée « PATCH /api/v1/files/{file_id}/metadata »Update Metadata
Write tags into the audio file (async). Not quota-counted: a basic edit.
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui |
Corps · MetadataIn
| Champ | Type | Requis | Description |
|---|---|---|---|
tags |
object | oui |
Renvoie 202 · MetadataJobOut
| Champ | Type | Requis | Description |
|---|---|---|---|
status |
string | ||
job_id |
string | oui | |
transformation_id |
string (uuid) | oui |
Exemple
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}
Section intitulée « POST /api/v1/files/{file_id}/transformations/{process} »Trigger
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | oui | |
process |
path | string | oui |
Corps · TriggerIn | null
Renvoie 202 · TriggerOut
| Champ | Type | Requis | Description |
|---|---|---|---|
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 | oui | |
job_id |
string | oui | |
transformation_id |
string (uuid) | oui |
Exemple
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/transformations/{process}" \ -H "Authorization: Bearer $JAMCLOUD_KEY" \ -H "Content-Type: application/json" \ -d '{}'GET /api/v1/separation-models
Section intitulée « GET /api/v1/separation-models »Separation Models
Separation models an admin enabled, default first in catalog order.
Renvoie 200 · array of SeparationModelOut
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/separation-models" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/groups/{group_id}/files/batch-metadata
Section intitulée « POST /api/v1/groups/{group_id}/files/batch-metadata »Batch Metadata
Same tags on many files of the workspace; unknown ids are skipped.
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Corps · BatchMetadataIn
| Champ | Type | Requis | Description |
|---|---|---|---|
file_ids |
array of string (uuid) | oui | |
tags |
object | oui |
Renvoie 202 · BatchMetadataOut
| Champ | Type | Requis | Description |
|---|---|---|---|
jobs |
array of BatchJob | oui |
Exemple
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":{}}'GET /api/v1/jobs/{job_id}
Section intitulée « GET /api/v1/jobs/{job_id} »Job Status
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
job_id |
path | string | oui |
Renvoie 200 · app__modules__transformer__schemas__JobOut
| Champ | Type | Requis | Description |
|---|---|---|---|
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 | oui | |
state |
string | oui | |
status |
string | oui | |
progress |
integer | oui | |
ready |
boolean | oui | |
successful |
boolean | oui | |
transformation_id |
string (uuid) | oui |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/jobs/{job_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"DELETE /api/v1/jobs/{job_id}
Section intitulée « DELETE /api/v1/jobs/{job_id} »Cancel Job
Withdraw a request still waiting in line (editor); its quota use is refunded.
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
job_id |
path | string | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/jobs/{job_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/jobs/{job_id}/events
Section intitulée « GET /api/v1/jobs/{job_id}/events »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).
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
job_id |
path | string | oui |
Renvoie 200 · object
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/jobs/{job_id}/events" \ -H "Authorization: Bearer $JAMCLOUD_KEY"DELETE /api/v1/transformations/{transformation_id}
Section intitulée « DELETE /api/v1/transformations/{transformation_id} »Delete Transformation
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
transformation_id |
path | string (uuid) | oui |
Renvoie 204 · pas de contenu
Exemple
curl -X DELETE "$JAMCLOUD_API/api/v1/transformations/{transformation_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Workspaces
Section intitulée « Workspaces »GET /api/v1/groups
Section intitulée « GET /api/v1/groups »My Workspaces
Renvoie 200 · array of WorkspaceOut
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/groups" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/groups/{group_id}
Section intitulée « GET /api/v1/groups/{group_id} »Get Workspace
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Renvoie 200 · WorkspaceOut
| Champ | Type | Requis | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
name |
string | oui | |
kind |
string | oui | |
my_role |
GroupRole | oui | |
created_at |
string (date-time) | oui | |
owner_id |
string (uuid) | null | oui | |
member_count |
integer | oui | Members besides the owner. |
members |
array of WorkspaceMemberOut | oui | |
settings |
WorkspaceSettingsOut |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/groups/{group_id}/settings
Section intitulée « GET /api/v1/groups/{group_id}/settings »Get Settings
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | oui |
Renvoie 200 · WorkspaceSettingsOut
| Champ | Type | Requis | Description |
|---|---|---|---|
boards_viewers_can_write |
boolean |
Exemple
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/settings" \ -H "Authorization: Bearer $JAMCLOUD_KEY"