API reference
The reference for developers: what each route expects and returns. To get a key and see what it can reach, read API first.
Versions
Section titled “Versions”The version is in every path: /api/v1. Within version 1, routes and fields are only added, never renamed or removed, so ignore the fields you don’t know. A change that would break your code comes as a new version (/api/v2), with v1 still running next to it.
Quick start
Section titled “Quick start”Keep the API address and your key in environment variables, then call it with any HTTP client: no SDK to install.
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 titled “Conventions”- JSON in and out,
snake_casefields, ids are UUIDs. - Lists answer
{items, total, limit, offset}; page with thelimitandoffsetparameters. - Errors are problem+json
{type, title, status, code, details}: testcode, it never changes. - Uploads take three calls: presign,
PUTthe file to the returned URL, then confirm. The URL works for 15 minutes and accepts exactly thesizeyou declared, in onePUT. - 503
circuit_open: wait theRetry-Afterseconds, then retry.
Each section below is one resource; each route gives its parameters, fields, answer and a curl example.
API version v1 · every route below starts with /api/v1
Boards
Section titled “Boards”GET /api/v1/groups/{group_id}/boards
Section titled “GET /api/v1/groups/{group_id}/boards”List Boards
The workspace’s free boards (track boards are reached through their file).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes | |
limit |
query | integer | ||
offset |
query | integer |
Returns 200 · Page_BoardOut_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of BoardOut | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/boards" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/groups/{group_id}/boards
Section titled “POST /api/v1/groups/{group_id}/boards”Create Board
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Body · BoardIn
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | yes |
Returns 201 · BoardDetail
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
file_id |
string (uuid) | null | yes | |
created_by |
string (uuid) | null | yes | |
title |
string | yes | |
version |
integer | yes | |
item_count |
integer | yes | |
can_write |
boolean | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
items |
array of BoardItemOut | yes |
Example
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 titled “GET /api/v1/files/{file_id}/board”Get Track Board
The file’s board, created empty on first read.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 200 · BoardDetail
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
file_id |
string (uuid) | null | yes | |
created_by |
string (uuid) | null | yes | |
title |
string | yes | |
version |
integer | yes | |
item_count |
integer | yes | |
can_write |
boolean | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
items |
array of BoardItemOut | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/board" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/boards/{board_id}
Section titled “GET /api/v1/boards/{board_id}”Get Board
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
board_id |
path | string (uuid) | yes |
Returns 200 · BoardDetail
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
file_id |
string (uuid) | null | yes | |
created_by |
string (uuid) | null | yes | |
title |
string | yes | |
version |
integer | yes | |
item_count |
integer | yes | |
can_write |
boolean | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
items |
array of BoardItemOut | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/boards/{board_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/boards/{board_id}
Section titled “PATCH /api/v1/boards/{board_id}”Rename Board
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
board_id |
path | string (uuid) | yes |
Body · BoardPatch
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | yes |
Returns 200 · BoardOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
file_id |
string (uuid) | null | yes | |
created_by |
string (uuid) | null | yes | |
title |
string | yes | |
version |
integer | yes | |
item_count |
integer | yes | |
can_write |
boolean | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “DELETE /api/v1/boards/{board_id}”Delete Board
Owner only; a track’s board can’t be deleted on its own.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
board_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/boards/{board_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/boards/{board_id}/ops
Section titled “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"}).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
board_id |
path | string (uuid) | yes |
Body · OpsIn
| Field | Type | Required | Description |
|---|---|---|---|
client_id |
string | yes | |
ops |
array of UpsertOp | DeleteOp | ClearOp | yes |
Returns 200 · OpsOut
| Field | Type | Required | Description |
|---|---|---|---|
version |
integer | yes | |
items |
array of ItemRev | yes |
Example
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":[{}]}'Charts
Section titled “Charts”GET /api/v1/files/{file_id}/chart
Section titled “GET /api/v1/files/{file_id}/chart”Get Chart
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 200 · ChartOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
file_id |
string (uuid) | yes | |
content |
object | yes | |
anchor_bar |
integer | yes | |
source |
string | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/chart" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PUT /api/v1/files/{file_id}/chart
Section titled “PUT /api/v1/files/{file_id}/chart”Put Chart
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · ChartIn
| Field | Type | Required | Description |
|---|---|---|---|
content |
ChartContent | yes | |
anchor_bar |
integer | ||
source |
“manual” | “import” |
Returns 200 · ChartOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
file_id |
string (uuid) | yes | |
content |
object | yes | |
anchor_bar |
integer | yes | |
source |
string | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “DELETE /api/v1/files/{file_id}/chart”Delete Chart
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/chart" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/score
Section titled “GET /api/v1/files/{file_id}/score”Get Score
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 200 · ScoreOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
file_id |
string (uuid) | yes | |
status |
“processing” | “ready” | “failed” | yes | |
format |
“guitarpro” | “musicxml” | null | yes | |
source_format |
string | yes | |
original_filename |
string | yes | |
title |
string | yes | |
anchor_bar |
integer | yes | |
settings |
object | yes | |
error_code |
string | null | yes | |
error_message |
string | null | yes | |
url |
string | null | yes | |
original_url |
string | yes | |
revision |
integer | yes | |
edited_at |
string (date-time) | null | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/score" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/score
Section titled “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).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 201 · ScoreOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
file_id |
string (uuid) | yes | |
status |
“processing” | “ready” | “failed” | yes | |
format |
“guitarpro” | “musicxml” | null | yes | |
source_format |
string | yes | |
original_filename |
string | yes | |
title |
string | yes | |
anchor_bar |
integer | yes | |
settings |
object | yes | |
error_code |
string | null | yes | |
error_message |
string | null | yes | |
url |
string | null | yes | |
original_url |
string | yes | |
revision |
integer | yes | |
edited_at |
string (date-time) | null | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/score" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/files/{file_id}/score
Section titled “PATCH /api/v1/files/{file_id}/score”Patch Score
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · ScorePatch
| Field | Type | Required | Description |
|---|---|---|---|
anchor_bar |
integer | null | ||
settings |
object | null |
Returns 200 · ScoreOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
file_id |
string (uuid) | yes | |
status |
“processing” | “ready” | “failed” | yes | |
format |
“guitarpro” | “musicxml” | null | yes | |
source_format |
string | yes | |
original_filename |
string | yes | |
title |
string | yes | |
anchor_bar |
integer | yes | |
settings |
object | yes | |
error_code |
string | null | yes | |
error_message |
string | null | yes | |
url |
string | null | yes | |
original_url |
string | yes | |
revision |
integer | yes | |
edited_at |
string (date-time) | null | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “DELETE /api/v1/files/{file_id}/score”Delete Score
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
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 titled “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).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 200 · ScoreOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
file_id |
string (uuid) | yes | |
status |
“processing” | “ready” | “failed” | yes | |
format |
“guitarpro” | “musicxml” | null | yes | |
source_format |
string | yes | |
original_filename |
string | yes | |
title |
string | yes | |
anchor_bar |
integer | yes | |
settings |
object | yes | |
error_code |
string | null | yes | |
error_message |
string | null | yes | |
url |
string | null | yes | |
original_url |
string | yes | |
revision |
integer | yes | |
edited_at |
string (date-time) | null | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
curl -X PUT "$JAMCLOUD_API/api/v1/files/{file_id}/score/content" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Export
Section titled “Export”POST /api/v1/files/{file_id}/export
Section titled “POST /api/v1/files/{file_id}/export”Export File
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · ExportIn
| Field | Type | Required | 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 |
Returns 202 · ExportJobOut
| Field | Type | Required | Description |
|---|---|---|---|
job_id |
string | yes | |
file_id |
string | null | ||
status |
“queued” | “processing” | “ready” | “failed” | yes | |
filename |
string | null | ||
url |
string | null | ||
expires_in |
integer | null | ||
code |
string | null |
Example
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 titled “GET /api/v1/exports/{job_id}”Export Status
The requester’s export job; a fresh download link while it is ready.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
job_id |
path | string (uuid) | yes |
Returns 200 · ExportJobOut
| Field | Type | Required | Description |
|---|---|---|---|
job_id |
string | yes | |
file_id |
string | null | ||
status |
“queued” | “processing” | “ready” | “failed” | yes | |
filename |
string | null | ||
url |
string | null | ||
expires_in |
integer | null | ||
code |
string | null |
Example
curl -X GET "$JAMCLOUD_API/api/v1/exports/{job_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Feedback
Section titled “Feedback”POST /api/v1/feedback
Section titled “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.
Body · FeedbackIn
| Field | Type | Required | Description |
|---|---|---|---|
category |
“bug” | “idea” | “question” | “other” | yes | |
message |
string | yes | |
group_id |
string | null | The workspace open in the app. | |
context |
FeedbackContext |
Returns 201 · FeedbackOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | yes | |
category |
“bug” | “idea” | “question” | “other” | yes | |
status |
“new” | “done” | yes | |
created_at |
string (date-time) | yes |
Example
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 titled “GET /api/v1/groups/{group_id}/directories”List Directories
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Returns 200 · array of DirectoryOut
Example
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/directories" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/groups/{group_id}/directories
Section titled “POST /api/v1/groups/{group_id}/directories”Create Directory
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Body · DirectoryIn
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes |
Returns 200 · object
Example
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 titled “DELETE /api/v1/directories/{directory_id}”Delete Directory
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
directory_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/directories/{directory_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/groups/{group_id}/files
Section titled “GET /api/v1/groups/{group_id}/files”List Files
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes | |
tags |
query | array of string | ||
favorite |
query | boolean | null | ||
search |
query | string | ||
directory_id |
query | string (uuid) | null | ||
limit |
query | integer | ||
offset |
query | integer |
Returns 200 · Page_FileSummary_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of FileSummary | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
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 titled “GET /api/v1/groups/{group_id}/files/recent”Recent Files
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Returns 200 · array of FileSummary
Example
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 titled “GET /api/v1/groups/{group_id}/tags”Group Tags
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Returns 200 · TagsOut
| Field | Type | Required | Description |
|---|---|---|---|
tags |
array of string | yes |
Example
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 titled “POST /api/v1/groups/{group_id}/files/batch-delete”Batch Delete
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Body · BatchIds
| Field | Type | Required | Description |
|---|---|---|---|
file_ids |
array of string (uuid) | yes |
Returns 200 · BatchDeleteOut
| Field | Type | Required | Description |
|---|---|---|---|
deleted |
integer | yes |
Example
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 titled “POST /api/v1/groups/{group_id}/files/batch-move”Batch Move
Move files to another workspace the caller owns (personal <-> shared, same owner).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Body · BatchMoveIn
| Field | Type | Required | Description |
|---|---|---|---|
file_ids |
array of string (uuid) | yes | |
target_group_id |
string (uuid) | yes |
Returns 200 · BatchMoveOut
| Field | Type | Required | Description |
|---|---|---|---|
moved |
integer | yes |
Example
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 titled “GET /api/v1/files”List All Files
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tags |
query | array of string | ||
favorite |
query | boolean | null | ||
search |
query | string | ||
limit |
query | integer | ||
offset |
query | integer |
Returns 200 · Page_FileSummary_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of FileSummary | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/files" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/recent
Section titled “GET /api/v1/files/recent”Recent All Files
Returns 200 · array of FileSummary
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/recent" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/tags
Section titled “GET /api/v1/files/tags”All Tags
Returns 200 · TagsOut
| Field | Type | Required | Description |
|---|---|---|---|
tags |
array of string | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/tags" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}
Section titled “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.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes | |
play |
query | boolean |
Returns 200 · FileOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
title |
string | yes | |
description |
string | yes | |
favorite |
boolean | yes | |
tags |
array of string | yes | |
file_size |
integer | yes | |
total_stems_usage |
integer | yes | |
uploaded_at |
string (date-time) | yes | |
last_played_at |
string (date-time) | null | yes | |
play_count |
integer | yes | |
directory |
DirectoryRef | null | yes | |
normalized_metadata |
object | yes | |
has_cover_art |
boolean | yes | |
cover_image_url |
string | null | yes | |
stems |
array of StemOut | yes | |
analyze |
TransformationOut | null | yes | |
metadata |
TransformationOut | null | yes | |
separation |
TransformationOut | null | yes | |
ml_analysis |
TransformationOut | null | yes | |
mapping |
TransformationOut | null | ||
queued_separation |
TransformationOut | null | ||
parent_id |
string (uuid) | null | ||
clip |
ClipOut | null |
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/files/{file_id}
Section titled “PATCH /api/v1/files/{file_id}”Patch File
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · FilePatch
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | null | ||
description |
string | null | ||
favorite |
boolean | null | ||
tags |
array of string | null | ||
directory_id |
string (uuid) | null | ||
parent_id |
null |
Returns 200 · FileOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
title |
string | yes | |
description |
string | yes | |
favorite |
boolean | yes | |
tags |
array of string | yes | |
file_size |
integer | yes | |
total_stems_usage |
integer | yes | |
uploaded_at |
string (date-time) | yes | |
last_played_at |
string (date-time) | null | yes | |
play_count |
integer | yes | |
directory |
DirectoryRef | null | yes | |
normalized_metadata |
object | yes | |
has_cover_art |
boolean | yes | |
cover_image_url |
string | null | yes | |
stems |
array of StemOut | yes | |
analyze |
TransformationOut | null | yes | |
metadata |
TransformationOut | null | yes | |
separation |
TransformationOut | null | yes | |
ml_analysis |
TransformationOut | null | yes | |
mapping |
TransformationOut | null | ||
queued_separation |
TransformationOut | null | ||
parent_id |
string (uuid) | null | ||
clip |
ClipOut | null |
Example
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 titled “DELETE /api/v1/files/{file_id}”Delete File
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/extract
Section titled “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).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · ExtractIn
| Field | Type | Required | Description |
|---|---|---|---|
start |
number | yes | |
end |
number | yes | |
title |
string | null |
Returns 202 · ExtractOut
| Field | Type | Required | Description |
|---|---|---|---|
status |
string | yes | |
job_id |
string | yes | |
audio_id |
string (uuid) | yes |
Example
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 titled “POST /api/v1/files/{file_id}/favorite”Set Favorite
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · FavoriteIn
| Field | Type | Required | Description |
|---|---|---|---|
favorite |
boolean | yes |
Returns 200 · FileSummary
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
favorite |
boolean | yes | |
title |
string | yes | |
description |
string | yes | |
tags |
array of string | yes | |
size |
integer | yes | |
stems_usage |
integer | yes | |
uploaded_at |
string (date-time) | yes | |
last_played_at |
string (date-time) | null | yes | |
directory |
DirectoryRef | null | yes | |
has_cover_art |
boolean | yes | |
parent_id |
string (uuid) | null | ||
clip |
ClipOut | null | ||
processes |
object | ||
queue |
object | ||
bpm |
number | null | ||
key |
string | null |
Example
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 titled “GET /api/v1/files/{file_id}/tags”File Tags
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 200 · TagsOut
| Field | Type | Required | Description |
|---|---|---|---|
tags |
array of string | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/tags" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/tags
Section titled “POST /api/v1/files/{file_id}/tags”Add Tags
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · TagsIn
| Field | Type | Required | Description |
|---|---|---|---|
tags |
array of string | yes |
Returns 200 · TagsOut
| Field | Type | Required | Description |
|---|---|---|---|
tags |
array of string | yes |
Example
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 titled “DELETE /api/v1/files/{file_id}/tags/{tag}”Remove Tag
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes | |
tag |
path | string | yes |
Returns 200 · TagsOut
| Field | Type | Required | Description |
|---|---|---|---|
tags |
array of string | yes |
Example
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 titled “GET /api/v1/files/{file_id}/metadata”Get Metadata
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 200 · MetadataOut
| Field | Type | Required | Description |
|---|---|---|---|
normalized |
object | yes | |
has_cover_art |
boolean | yes | |
cover_image_url |
string | null | yes | |
technical |
object | null | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/metadata" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/status
Section titled “GET /api/v1/files/{file_id}/status”File Status
Latest state of every process run on the file (any status).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 200 · StatusOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
transformations |
object | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/status" \ -H "Authorization: Bearer $JAMCLOUD_KEY"DELETE /api/v1/files/{file_id}/stems
Section titled “DELETE /api/v1/files/{file_id}/stems”Delete All Stems
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
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 titled “DELETE /api/v1/files/{file_id}/stems/{stem_name}”Delete Stem
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes | |
stem_name |
path | string | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/stems/{stem_name}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Harmony
Section titled “Harmony”GET /api/v1/harmony/families
Section titled “GET /api/v1/harmony/families”List Families
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
search |
query | string | null | ||
ordering |
query | string | null | ||
limit |
query | integer | ||
offset |
query | integer |
Returns 200 · Page_FamilyOut_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of FamilyOut | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/families" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/families
Section titled “POST /api/v1/harmony/families”Create Families
Body · FamilyIn
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes | |
description |
string |
Returns 201 · FamilyOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
name |
string | yes | |
description |
string | yes |
Example
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 titled “GET /api/v1/harmony/families/{item_id}”Get Families
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 200 · FamilyOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
name |
string | yes | |
description |
string | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/families/{item_id}
Section titled “PATCH /api/v1/harmony/families/{item_id}”Patch Families
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Body · FamilyPatch
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | null | ||
description |
string | null |
Returns 200 · FamilyOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
name |
string | yes | |
description |
string | yes |
Example
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 titled “DELETE /api/v1/harmony/families/{item_id}”Delete Families
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/qualities
Section titled “GET /api/v1/harmony/qualities”List Qualities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
family |
query | string (uuid) | null | ||
search |
query | string | null | ||
ordering |
query | string | null | ||
limit |
query | integer | ||
offset |
query | integer |
Returns 200 · Page_QualityOut_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of QualityOut | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/qualities" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/qualities
Section titled “POST /api/v1/harmony/qualities”Create Quality
Body · QualityIn
| Field | Type | Required | Description |
|---|---|---|---|
key |
string | yes | |
family_id |
string (uuid) | yes | |
formula |
array of integer | yes | |
description |
string |
Returns 201 · QualityOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
key |
string | yes | |
family |
string | yes | |
family_id |
string (uuid) | yes | |
formula |
array of integer | yes | |
aliases |
array of AliasOut | yes | |
description |
string | yes |
Example
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 titled “GET /api/v1/harmony/qualities/{key}”Get Quality
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
key |
path | string | yes |
Returns 200 · QualityOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
key |
string | yes | |
family |
string | yes | |
family_id |
string (uuid) | yes | |
formula |
array of integer | yes | |
aliases |
array of AliasOut | yes | |
description |
string | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/qualities/{key}
Section titled “PATCH /api/v1/harmony/qualities/{key}”Patch Quality
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
key |
path | string | yes |
Body · QualityPatch
| Field | Type | Required | Description |
|---|---|---|---|
key |
string | null | ||
family_id |
string (uuid) | null | ||
formula |
array of integer | null | ||
description |
string | null |
Returns 200 · QualityOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
key |
string | yes | |
family |
string | yes | |
family_id |
string (uuid) | yes | |
formula |
array of integer | yes | |
aliases |
array of AliasOut | yes | |
description |
string | yes |
Example
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 titled “DELETE /api/v1/harmony/qualities/{key}”Delete Quality
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
key |
path | string | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/aliases
Section titled “GET /api/v1/harmony/aliases”List Aliases
Parameters
| Name | In | Type | Required | 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 |
Returns 200 · Page_AliasOut_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of AliasOut | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/aliases" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/aliases
Section titled “POST /api/v1/harmony/aliases”Create Aliases
Body · AliasIn
| Field | Type | Required | Description |
|---|---|---|---|
quality_id |
string (uuid) | yes | |
alias |
string | yes | |
is_preferred |
boolean |
Returns 201 · AliasOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
quality_id |
string (uuid) | yes | |
alias |
string | yes | |
is_preferred |
boolean | yes |
Example
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 titled “GET /api/v1/harmony/aliases/{item_id}”Get Aliases
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 200 · AliasOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
quality_id |
string (uuid) | yes | |
alias |
string | yes | |
is_preferred |
boolean | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/aliases/{item_id}
Section titled “PATCH /api/v1/harmony/aliases/{item_id}”Patch Aliases
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Body · AliasPatch
| Field | Type | Required | Description |
|---|---|---|---|
quality_id |
string (uuid) | null | ||
alias |
string | null | ||
is_preferred |
boolean | null |
Returns 200 · AliasOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
quality_id |
string (uuid) | yes | |
alias |
string | yes | |
is_preferred |
boolean | yes |
Example
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 titled “DELETE /api/v1/harmony/aliases/{item_id}”Delete Aliases
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/types
Section titled “GET /api/v1/harmony/types”List Types
Parameters
| Name | In | Type | Required | 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 |
Returns 200 · Page_ChordTypeOut_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of ChordTypeOut | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/types" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/types
Section titled “POST /api/v1/harmony/types”Create Types
Body · ChordTypeIn
| Field | Type | Required | Description |
|---|---|---|---|
label |
string | yes | |
description |
string | ||
quality_id |
string (uuid) | null |
Returns 201 · ChordTypeOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
label |
string | yes | |
description |
string | yes | |
quality_id |
string (uuid) | null | yes | |
quality_key |
string | null | yes | |
family |
string | null | yes |
Example
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 titled “GET /api/v1/harmony/types/{item_id}”Get Types
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 200 · ChordTypeOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
label |
string | yes | |
description |
string | yes | |
quality_id |
string (uuid) | null | yes | |
quality_key |
string | null | yes | |
family |
string | null | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/types/{item_id}
Section titled “PATCH /api/v1/harmony/types/{item_id}”Patch Types
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Body · ChordTypePatch
| Field | Type | Required | Description |
|---|---|---|---|
label |
string | null | ||
description |
string | null | ||
quality_id |
string (uuid) | null |
Returns 200 · ChordTypeOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
label |
string | yes | |
description |
string | yes | |
quality_id |
string (uuid) | null | yes | |
quality_key |
string | null | yes | |
family |
string | null | yes |
Example
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 titled “DELETE /api/v1/harmony/types/{item_id}”Delete Types
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/instruments
Section titled “GET /api/v1/harmony/instruments”List Instruments
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
search |
query | string | null | ||
ordering |
query | string | null | ||
limit |
query | integer | ||
offset |
query | integer |
Returns 200 · Page_InstrumentOut_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of InstrumentOut | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/instruments" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/instruments
Section titled “POST /api/v1/harmony/instruments”Create Instruments
Body · InstrumentIn
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes | |
string_count |
integer |
Returns 201 · InstrumentOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
name |
string | yes | |
string_count |
integer | yes |
Example
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 titled “GET /api/v1/harmony/instruments/{item_id}”Get Instruments
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 200 · InstrumentOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
name |
string | yes | |
string_count |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/instruments/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/instruments/{item_id}
Section titled “PATCH /api/v1/harmony/instruments/{item_id}”Patch Instruments
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Body · InstrumentPatch
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | null | ||
string_count |
integer | null |
Returns 200 · InstrumentOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
name |
string | yes | |
string_count |
integer | yes |
Example
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 titled “DELETE /api/v1/harmony/instruments/{item_id}”Delete Instruments
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/instruments/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/tunings
Section titled “GET /api/v1/harmony/tunings”List Tunings
Parameters
| Name | In | Type | Required | 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 |
Returns 200 · Page_TuningOut_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of TuningOut | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/tunings" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/tunings
Section titled “POST /api/v1/harmony/tunings”Create Tunings
Body · TuningIn
| Field | Type | Required | Description |
|---|---|---|---|
instrument_id |
string (uuid) | yes | |
name |
string | yes | |
open_strings |
array of string | yes | |
is_default |
boolean |
Returns 201 · TuningOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
instrument |
InstrumentOut | yes | |
name |
string | yes | |
open_strings |
array of string | yes | |
is_default |
boolean | yes |
Example
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 titled “GET /api/v1/harmony/tunings/{item_id}”Get Tunings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 200 · TuningOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
instrument |
InstrumentOut | yes | |
name |
string | yes | |
open_strings |
array of string | yes | |
is_default |
boolean | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/tunings/{item_id}
Section titled “PATCH /api/v1/harmony/tunings/{item_id}”Patch Tunings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Body · TuningPatch
| Field | Type | Required | Description |
|---|---|---|---|
instrument_id |
string (uuid) | null | ||
name |
string | null | ||
open_strings |
array of string | null | ||
is_default |
boolean | null |
Returns 200 · TuningOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
instrument |
InstrumentOut | yes | |
name |
string | yes | |
open_strings |
array of string | yes | |
is_default |
boolean | yes |
Example
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 titled “DELETE /api/v1/harmony/tunings/{item_id}”Delete Tunings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/voicing-tags
Section titled “GET /api/v1/harmony/voicing-tags”List Voicing Tags
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
search |
query | string | null | ||
ordering |
query | string | null | ||
limit |
query | integer | ||
offset |
query | integer |
Returns 200 · Page_VoicingTagOut_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of VoicingTagOut | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-tags" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/voicing-tags
Section titled “POST /api/v1/harmony/voicing-tags”Create Voicing-Tags
Body · VoicingTagIn
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes |
Returns 201 · VoicingTagOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
name |
string | yes |
Example
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 titled “GET /api/v1/harmony/voicing-tags/{item_id}”Get Voicing-Tags
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 200 · VoicingTagOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
name |
string | yes |
Example
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 titled “PATCH /api/v1/harmony/voicing-tags/{item_id}”Patch Voicing-Tags
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Body · VoicingTagPatch
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | null |
Returns 200 · VoicingTagOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
name |
string | yes |
Example
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 titled “DELETE /api/v1/harmony/voicing-tags/{item_id}”Delete Voicing-Tags
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/voicing-tags/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/voicings
Section titled “GET /api/v1/harmony/voicings”List Voicings
Parameters
| Name | In | Type | Required | 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 |
Returns 200 · Page_VoicingOut_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of VoicingOut | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicings" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/voicings
Section titled “POST /api/v1/harmony/voicings”Create Voicing
Body · VoicingIn
| Field | Type | Required | Description |
|---|---|---|---|
entry_id |
string (uuid) | yes | |
tuning_id |
string (uuid) | yes | |
name |
string | ||
source |
string | ||
caged |
"" | “C” | “A” | “G” | “E” | “D” | ||
frets |
array of integer | yes | |
fingers |
array of integer | null | ||
barres |
array of object | ||
inversion |
integer | ||
difficulty |
integer | ||
tag_names |
array of string |
Returns 201 · VoicingOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
entry |
EntryLite | yes | |
tuning |
TuningLite | yes | |
name |
string | yes | |
source |
string | yes | |
caged |
string | yes | |
frets |
array of integer | yes | |
fingers |
array of integer | null | yes | |
barres |
array of object | yes | |
inversion |
integer | yes | |
is_open |
boolean | yes | |
fret_low |
integer | yes | |
fret_high |
integer | yes | |
difficulty |
integer | yes | |
tags |
array of string | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “GET /api/v1/harmony/voicings/{voicing_id}”Get Voicing
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
voicing_id |
path | string (uuid) | yes |
Returns 200 · VoicingOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
entry |
EntryLite | yes | |
tuning |
TuningLite | yes | |
name |
string | yes | |
source |
string | yes | |
caged |
string | yes | |
frets |
array of integer | yes | |
fingers |
array of integer | null | yes | |
barres |
array of object | yes | |
inversion |
integer | yes | |
is_open |
boolean | yes | |
fret_low |
integer | yes | |
fret_high |
integer | yes | |
difficulty |
integer | yes | |
tags |
array of string | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicings/{voicing_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/voicings/{voicing_id}
Section titled “PATCH /api/v1/harmony/voicings/{voicing_id}”Patch Voicing
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
voicing_id |
path | string (uuid) | yes |
Body · VoicingPatch
| Field | Type | Required | 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 |
Returns 200 · VoicingOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
entry |
EntryLite | yes | |
tuning |
TuningLite | yes | |
name |
string | yes | |
source |
string | yes | |
caged |
string | yes | |
frets |
array of integer | yes | |
fingers |
array of integer | null | yes | |
barres |
array of object | yes | |
inversion |
integer | yes | |
is_open |
boolean | yes | |
fret_low |
integer | yes | |
fret_high |
integer | yes | |
difficulty |
integer | yes | |
tags |
array of string | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “DELETE /api/v1/harmony/voicings/{voicing_id}”Delete Voicing
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
voicing_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/voicings/{voicing_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/references
Section titled “GET /api/v1/harmony/references”List References
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
search |
query | string | null | ||
ordering |
query | string | null | ||
limit |
query | integer | ||
offset |
query | integer |
Returns 200 · Page_ReferenceOut_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of ReferenceOut | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/references" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/references
Section titled “POST /api/v1/harmony/references”Create References
Body · ReferenceIn
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | yes | |
author |
string | ||
details |
string |
Returns 201 · ReferenceOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
title |
string | yes | |
author |
string | yes | |
details |
string | yes |
Example
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 titled “GET /api/v1/harmony/references/{item_id}”Get References
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 200 · ReferenceOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
title |
string | yes | |
author |
string | yes | |
details |
string | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/references/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/harmony/references/{item_id}
Section titled “PATCH /api/v1/harmony/references/{item_id}”Patch References
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Body · ReferencePatch
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | null | ||
author |
string | null | ||
details |
string | null |
Returns 200 · ReferenceOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
title |
string | yes | |
author |
string | yes | |
details |
string | yes |
Example
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 titled “DELETE /api/v1/harmony/references/{item_id}”Delete References
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/references/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/voicing-references
Section titled “GET /api/v1/harmony/voicing-references”List Voicing References
Parameters
| Name | In | Type | Required | 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 |
Returns 200 · Page_VoicingReferenceOut_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of VoicingReferenceOut | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-references" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/harmony/voicing-references
Section titled “POST /api/v1/harmony/voicing-references”Create Voicing-References
Body · VoicingReferenceIn
| Field | Type | Required | Description |
|---|---|---|---|
voicing_id |
string (uuid) | yes | |
source_id |
string (uuid) | yes | |
page |
string | ||
figure |
string |
Returns 201 · VoicingReferenceOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
voicing_id |
string (uuid) | yes | |
source |
ReferenceOut | yes | |
page |
string | yes | |
figure |
string | yes |
Example
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 titled “GET /api/v1/harmony/voicing-references/{item_id}”Get Voicing-References
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 200 · VoicingReferenceOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
voicing_id |
string (uuid) | yes | |
source |
ReferenceOut | yes | |
page |
string | yes | |
figure |
string | yes |
Example
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 titled “PATCH /api/v1/harmony/voicing-references/{item_id}”Patch Voicing-References
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Body · VoicingReferencePatch
| Field | Type | Required | Description |
|---|---|---|---|
voicing_id |
string (uuid) | null | ||
source_id |
string (uuid) | null | ||
page |
string | null | ||
figure |
string | null |
Returns 200 · VoicingReferenceOut
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
id |
string (uuid) | yes | |
voicing_id |
string (uuid) | yes | |
source |
ReferenceOut | yes | |
page |
string | yes | |
figure |
string | yes |
Example
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 titled “DELETE /api/v1/harmony/voicing-references/{item_id}”Delete Voicing-References
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/voicing-references/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/entries
Section titled “GET /api/v1/harmony/entries”List Entries
Parameters
| Name | In | Type | Required | 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 |
Returns 200 · Page_EntryOut_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of EntryOut | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/entries/by-symbol
Section titled “GET /api/v1/harmony/entries/by-symbol”Entry By Symbol
Resolve Dbmaj7/Gb-style symbols to the canonical (sharp) entry.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
symbol |
query | string |
Returns 200 · EntryOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
symbol |
string | yes | |
root |
string | yes | |
bass |
string | yes | |
quality |
QualityOut | yes | |
family |
string | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries/by-symbol" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/entries/{entry_id}
Section titled “GET /api/v1/harmony/entries/{entry_id}”Get Entry
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
entry_id |
path | string (uuid) | yes |
Returns 200 · EntryOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
symbol |
string | yes | |
root |
string | yes | |
bass |
string | yes | |
quality |
QualityOut | yes | |
family |
string | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries/{entry_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Health
Section titled “Health”GET /health/live
Section titled “GET /health/live”Live
Returns 200 · object
Example
curl -X GET "$JAMCLOUD_API/health/live" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /health/ready
Section titled “GET /health/ready”Ready
Returns 200 · object
Example
curl -X GET "$JAMCLOUD_API/health/ready" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Ingestion
Section titled “Ingestion”POST /api/v1/groups/{group_id}/uploads/presign
Section titled “POST /api/v1/groups/{group_id}/uploads/presign”Presign Upload
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Body · PresignIn
| Field | Type | Required | Description |
|---|---|---|---|
filename |
string | yes | |
content_type |
string | yes | |
size |
integer | yes |
Returns 200 · PresignOut
| Field | Type | Required | Description |
|---|---|---|---|
upload_url |
string | yes | |
key |
string | yes | |
audio_id |
string (uuid) | yes |
Example
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 titled “POST /api/v1/groups/{group_id}/uploads/confirm”Confirm Upload
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Body · app__modules__ingestion__schemas__ConfirmIn
| Field | Type | Required | Description |
|---|---|---|---|
key |
string | yes | |
audio_id |
string (uuid) | yes | |
directory_id |
string (uuid) | null |
Returns 201 · ConfirmOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
title |
string | yes | |
description |
string | yes | |
favorite |
boolean | yes | |
tags |
array of string | yes | |
file_size |
integer | yes | |
total_stems_usage |
integer | yes | |
uploaded_at |
string (date-time) | yes | |
last_played_at |
string (date-time) | null | yes | |
play_count |
integer | yes | |
directory |
DirectoryRef | null | yes | |
normalized_metadata |
object | yes | |
has_cover_art |
boolean | yes | |
cover_image_url |
string | null | yes | |
stems |
array of StemOut | yes | |
analyze |
TransformationOut | null | yes | |
metadata |
TransformationOut | null | yes | |
separation |
TransformationOut | null | yes | |
ml_analysis |
TransformationOut | null | yes | |
mapping |
TransformationOut | null | ||
queued_separation |
TransformationOut | null | ||
parent_id |
string (uuid) | null | ||
clip |
ClipOut | null | ||
auto_tasks |
object | yes |
Example
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 titled “POST /api/v1/groups/{group_id}/ingest/url”Ingest Url
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Body · IngestUrlIn
| Field | Type | Required | Description |
|---|---|---|---|
video_url |
string (uri) | yes | |
format |
IngestFormat |
Returns 202 · IngestUrlOut
| Field | Type | Required | Description |
|---|---|---|---|
status |
string | yes | |
job_id |
string | yes | |
audio_id |
string (uuid) | yes |
Example
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 titled “GET /api/v1/uploads/conditions”Upload Conditions
Returns 200 · ConditionsOut
| Field | Type | Required | Description |
|---|---|---|---|
extensions |
array of string | yes | |
max_file_size_mb |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/uploads/conditions" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Lyrics
Section titled “Lyrics”GET /api/v1/files/{file_id}/lyrics
Section titled “GET /api/v1/files/{file_id}/lyrics”Get Lyrics
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 200 · LyricsOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
file_id |
string (uuid) | yes | |
lines |
array of object | yes | |
offset_ms |
integer | yes | |
source |
string | yes | |
source_ref |
string | null | yes | |
synced |
boolean | yes | |
updated_by |
string (uuid) | null | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PUT /api/v1/files/{file_id}/lyrics
Section titled “PUT /api/v1/files/{file_id}/lyrics”Put Lyrics
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · LyricsIn
| Field | Type | Required | Description |
|---|---|---|---|
lines |
array of LyricsLine | yes | |
offset_ms |
integer | ||
source |
“manual” | “file” | “lrclib” | ||
source_ref |
string | null |
Returns 200 · LyricsOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
file_id |
string (uuid) | yes | |
lines |
array of object | yes | |
offset_ms |
integer | yes | |
source |
string | yes | |
source_ref |
string | null | yes | |
synced |
boolean | yes | |
updated_by |
string (uuid) | null | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “DELETE /api/v1/files/{file_id}/lyrics”Delete Lyrics
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
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 titled “GET /api/v1/files/{file_id}/lyrics/search”Search Lyrics
LRCLIB records (at most 20). No term: the track’s own title and artist.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes | |
track |
query | string | null | ||
artist |
query | string | null | ||
q |
query | string | null |
Returns 200 · array of LyricsCandidate
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics/search" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Mapping
Section titled “Mapping”GET /api/v1/files/{file_id}/sections
Section titled “GET /api/v1/files/{file_id}/sections”List Sections
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes | |
section_type |
query | string | null |
Returns 200 · array of SectionOut
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/sections" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/sections
Section titled “POST /api/v1/files/{file_id}/sections”Create Section
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · SectionIn
| Field | Type | Required | Description |
|---|---|---|---|
start |
number | yes | |
end |
number | null | ||
section_type |
string | yes | |
observation |
string | null |
Returns 201 · SectionOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
file_id |
string (uuid) | yes | |
start |
number | yes | |
end |
number | null | yes | |
label |
string | yes | |
color |
string | null | yes | |
section_type |
string | yes | |
section_number |
integer | yes | |
observation |
string | null | yes |
Example
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 titled “PATCH /api/v1/sections/{section_id}”Patch Section
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
section_id |
path | string (uuid) | yes |
Body · SectionPatch
| Field | Type | Required | Description |
|---|---|---|---|
start |
number | null | ||
end |
number | null | ||
section_type |
string | null | ||
observation |
string | null |
Returns 200 · SectionOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
file_id |
string (uuid) | yes | |
start |
number | yes | |
end |
number | null | yes | |
label |
string | yes | |
color |
string | null | yes | |
section_type |
string | yes | |
section_number |
integer | yes | |
observation |
string | null | yes |
Example
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 titled “DELETE /api/v1/sections/{section_id}”Delete Section
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
section_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/sections/{section_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/marks
Section titled “GET /api/v1/files/{file_id}/marks”List Marks
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 200 · array of MarkOut
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/marks" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/marks
Section titled “POST /api/v1/files/{file_id}/marks”Create Mark
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · MarkIn
| Field | Type | Required | Description |
|---|---|---|---|
start |
number | yes | |
name |
string | null | ||
observation |
string | null |
Returns 201 · MarkOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
file_id |
string (uuid) | yes | |
start |
number | yes | |
name |
string | yes | |
observation |
string | null | yes |
Example
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 titled “PATCH /api/v1/marks/{mark_id}”Patch Mark
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
mark_id |
path | string (uuid) | yes |
Body · MarkPatch
| Field | Type | Required | Description |
|---|---|---|---|
start |
number | null | ||
name |
string | null | ||
observation |
string | null |
Returns 200 · MarkOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
file_id |
string (uuid) | yes | |
start |
number | yes | |
name |
string | yes | |
observation |
string | null | yes |
Example
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 titled “DELETE /api/v1/marks/{mark_id}”Delete Mark
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
mark_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/marks/{mark_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/loops
Section titled “GET /api/v1/files/{file_id}/loops”List Loops
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 200 · array of LoopOut
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/loops" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/loops
Section titled “POST /api/v1/files/{file_id}/loops”Create Loop
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · LoopIn
| Field | Type | Required | Description |
|---|---|---|---|
start |
number | yes | |
end |
number | null | ||
name |
string | null | ||
observation |
string | null |
Returns 201 · LoopOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
file_id |
string (uuid) | yes | |
start |
number | yes | |
end |
number | null | yes | |
name |
string | yes | |
observation |
string | null | yes |
Example
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 titled “PATCH /api/v1/loops/{loop_id}”Patch Loop
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
loop_id |
path | string (uuid) | yes |
Body · LoopPatch
| Field | Type | Required | Description |
|---|---|---|---|
start |
number | null | ||
end |
number | null | ||
name |
string | null | ||
observation |
string | null |
Returns 200 · LoopOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
file_id |
string (uuid) | yes | |
start |
number | yes | |
end |
number | null | yes | |
name |
string | yes | |
observation |
string | null | yes |
Example
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 titled “DELETE /api/v1/loops/{loop_id}”Delete Loop
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
loop_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/loops/{loop_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/beats
Section titled “GET /api/v1/files/{file_id}/beats”Get Beats
The saved beat map, else the analysis beats with a suggested meter.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 200 · BeatsOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | null | ||
beats |
array of object | yes | |
meter |
array of MeterEntry | yes | |
source |
string | yes | |
beat_count |
integer | yes | |
created_at |
string (date-time) | null | ||
updated_at |
string (date-time) | null |
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/beats" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PUT /api/v1/files/{file_id}/beats
Section titled “PUT /api/v1/files/{file_id}/beats”Put Beats
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · BeatsIn
| Field | Type | Required | Description |
|---|---|---|---|
beats |
array of number | yes | |
meter |
array of MeterEntry |
Returns 200 · BeatsOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | null | ||
beats |
array of object | yes | |
meter |
array of MeterEntry | yes | |
source |
string | yes | |
beat_count |
integer | yes | |
created_at |
string (date-time) | null | ||
updated_at |
string (date-time) | null |
Example
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 titled “DELETE /api/v1/files/{file_id}/beats”Delete Beats
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/beats" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Music import
Section titled “Music import”POST /api/v1/groups/{group_id}/imports
Section titled “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.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Returns 202 · ImportCreated
| Field | Type | Required | Description |
|---|---|---|---|
import_job_id |
string (uuid) | yes | |
job_id |
string | yes | |
status |
string | yes |
Example
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/imports" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/imports/{import_id}
Section titled “GET /api/v1/imports/{import_id}”Import Status
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
import_id |
path | string (uuid) | yes |
Returns 200 · app__modules__music_import__schemas__ImportJobOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
original_filename |
string | yes | |
source_format |
string | yes | |
status |
string | yes | |
notation_id |
string (uuid) | null | yes | |
error_message |
string | yes | |
progress_percent |
integer | yes | |
progress_message |
string | yes | |
parser_logs |
object | yes | |
created_at |
string (date-time) | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/imports/{import_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/import/formats
Section titled “GET /api/v1/import/formats”Formats
Enabled import formats and their extensions.
Returns 200 · array of FormatOut
Example
curl -X GET "$JAMCLOUD_API/api/v1/import/formats" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Notations
Section titled “Notations”GET /api/v1/groups/{group_id}/notations
Section titled “GET /api/v1/groups/{group_id}/notations”List Notations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes | |
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 |
Returns 200 · Page_NotationSummary_
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of NotationSummary | yes | |
total |
integer | yes | |
limit |
integer | yes | |
offset |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/notations" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/groups/{group_id}/notations
Section titled “POST /api/v1/groups/{group_id}/notations”Create Notation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Body · NotationIn
| Field | Type | Required | 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) |
Returns 201 · NotationOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
title |
string | yes | |
author |
string | yes | |
audio_file_id |
string (uuid) | null | yes | |
audio_file_title |
string | yes | |
data |
object | yes | |
format_version |
integer | yes | |
source_format |
string | yes | |
origin |
string | yes | |
tempo |
integer | yes | |
time_signature |
string | yes | |
number_of_measures |
integer | yes | |
start_time |
number | null | yes | |
end_time |
number | null | yes | |
repeat_sync |
boolean | yes | |
sync_map |
object | yes | |
favorite |
boolean | yes | |
tags |
array of string | yes | |
category_ids |
array of string (uuid) | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “GET /api/v1/groups/{group_id}/notations/tags”Notation Tags
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Returns 200 · TagsOut
| Field | Type | Required | Description |
|---|---|---|---|
tags |
array of string | yes |
Example
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 titled “GET /api/v1/groups/{group_id}/notations/recent”Recent Notations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Returns 200 · array of NotationSummary
Example
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/notations/recent" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/notations/{notation_id}
Section titled “GET /api/v1/notations/{notation_id}”Get Notation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
notation_id |
path | string (uuid) | yes |
Returns 200 · NotationOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
title |
string | yes | |
author |
string | yes | |
audio_file_id |
string (uuid) | null | yes | |
audio_file_title |
string | yes | |
data |
object | yes | |
format_version |
integer | yes | |
source_format |
string | yes | |
origin |
string | yes | |
tempo |
integer | yes | |
time_signature |
string | yes | |
number_of_measures |
integer | yes | |
start_time |
number | null | yes | |
end_time |
number | null | yes | |
repeat_sync |
boolean | yes | |
sync_map |
object | yes | |
favorite |
boolean | yes | |
tags |
array of string | yes | |
category_ids |
array of string (uuid) | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/notations/{notation_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/notations/{notation_id}
Section titled “PATCH /api/v1/notations/{notation_id}”Patch Notation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
notation_id |
path | string (uuid) | yes |
Body · NotationPatch
| Field | Type | Required | 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 |
Returns 200 · NotationOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
title |
string | yes | |
author |
string | yes | |
audio_file_id |
string (uuid) | null | yes | |
audio_file_title |
string | yes | |
data |
object | yes | |
format_version |
integer | yes | |
source_format |
string | yes | |
origin |
string | yes | |
tempo |
integer | yes | |
time_signature |
string | yes | |
number_of_measures |
integer | yes | |
start_time |
number | null | yes | |
end_time |
number | null | yes | |
repeat_sync |
boolean | yes | |
sync_map |
object | yes | |
favorite |
boolean | yes | |
tags |
array of string | yes | |
category_ids |
array of string (uuid) | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “DELETE /api/v1/notations/{notation_id}”Delete Notation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
notation_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/notations/{notation_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/notations/{notation_id}/favorite
Section titled “POST /api/v1/notations/{notation_id}/favorite”Set Favorite
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
notation_id |
path | string (uuid) | yes |
Body · FavoriteIn
| Field | Type | Required | Description |
|---|---|---|---|
favorite |
boolean | yes |
Returns 200 · NotationOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
title |
string | yes | |
author |
string | yes | |
audio_file_id |
string (uuid) | null | yes | |
audio_file_title |
string | yes | |
data |
object | yes | |
format_version |
integer | yes | |
source_format |
string | yes | |
origin |
string | yes | |
tempo |
integer | yes | |
time_signature |
string | yes | |
number_of_measures |
integer | yes | |
start_time |
number | null | yes | |
end_time |
number | null | yes | |
repeat_sync |
boolean | yes | |
sync_map |
object | yes | |
favorite |
boolean | yes | |
tags |
array of string | yes | |
category_ids |
array of string (uuid) | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “GET /api/v1/notation-categories”Categories
Returns 200 · array of CategoryOut
Example
curl -X GET "$JAMCLOUD_API/api/v1/notation-categories" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Platform
Section titled “Platform”GET /api/v1/platform
Section titled “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.
Returns 200 · PlatformOut
| Field | Type | Required | Description |
|---|---|---|---|
payments_enabled |
boolean | yes | |
site_show_signup |
boolean | yes | |
site_hidden_pages |
array of string | yes | |
site_announcement |
string | yes | |
site_announcement_url |
string | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/platform" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Playlists
Section titled “Playlists”GET /api/v1/groups/{group_id}/playlists
Section titled “GET /api/v1/groups/{group_id}/playlists”List Playlists
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Returns 200 · array of PlaylistOut
Example
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/playlists" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/groups/{group_id}/playlists
Section titled “POST /api/v1/groups/{group_id}/playlists”Create Playlist
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Body · PlaylistIn
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes | |
repeat_mode |
“off” | “all” | “one” |
Returns 201 · PlaylistDetail
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
name |
string | yes | |
repeat_mode |
string | yes | |
track_count |
integer | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
tracks |
array of app__modules__playlists__schemas__TrackOut | yes |
Example
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 titled “GET /api/v1/playlists/{playlist_id}”Get Playlist
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | yes |
Returns 200 · PlaylistDetail
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
name |
string | yes | |
repeat_mode |
string | yes | |
track_count |
integer | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
tracks |
array of app__modules__playlists__schemas__TrackOut | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/playlists/{playlist_id}
Section titled “PATCH /api/v1/playlists/{playlist_id}”Patch Playlist
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | yes |
Body · PlaylistPatch
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | null | ||
repeat_mode |
“off” | “all” | “one” | null |
Returns 200 · PlaylistDetail
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
name |
string | yes | |
repeat_mode |
string | yes | |
track_count |
integer | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes | |
tracks |
array of app__modules__playlists__schemas__TrackOut | yes |
Example
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 titled “DELETE /api/v1/playlists/{playlist_id}”Delete Playlist
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/playlists/{playlist_id}/tracks
Section titled “GET /api/v1/playlists/{playlist_id}/tracks”List Tracks
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | yes |
Returns 200 · array of app__modules__playlists__schemas__TrackOut
Example
curl -X GET "$JAMCLOUD_API/api/v1/playlists/{playlist_id}/tracks" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/playlists/{playlist_id}/tracks
Section titled “POST /api/v1/playlists/{playlist_id}/tracks”Add Tracks
Appends at the end (position is accepted but ignored, as in Django).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | yes |
Body · TracksIn
| Field | Type | Required | Description |
|---|---|---|---|
tracks |
array of TrackIn | yes |
Returns 201 · array of app__modules__playlists__schemas__TrackOut
Example
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 titled “PUT /api/v1/playlists/{playlist_id}/tracks”Reorder Tracks
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | yes |
Body · ReorderIn
| Field | Type | Required | Description |
|---|---|---|---|
order |
array of string (uuid) | yes |
Returns 200 · array of app__modules__playlists__schemas__TrackOut
Example
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 titled “DELETE /api/v1/playlists/{playlist_id}/tracks/{track_id}”Remove Track
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | yes | |
track_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/playlists/{playlist_id}/tracks/{track_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Stream
Section titled “Stream”GET /api/v1/files/{file_id}/stream
Section titled “GET /api/v1/files/{file_id}/stream”Stream File
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes | |
quality |
query | “low” | “medium” | “high” | null | Profile chosen by the player when the preference is auto. |
Example
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 titled “GET /api/v1/files/{file_id}/stream-url”Stream File Url
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes | |
quality |
query | “low” | “medium” | “high” | null | Profile chosen by the player when the preference is auto. |
Returns 200 · StreamUrlOut
| Field | Type | Required | Description |
|---|---|---|---|
url |
string | yes | |
expires_in |
integer | yes | |
quality |
string | null |
Example
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 titled “GET /api/v1/files/{file_id}/stems/{stem_name}/stream”Stream Stem
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes | |
stem_name |
path | string | yes |
Example
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 titled “GET /api/v1/files/{file_id}/stems/{stem_name}/stream-url”Stream Stem Url
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes | |
stem_name |
path | string | yes |
Returns 200 · StreamUrlOut
| Field | Type | Required | Description |
|---|---|---|---|
url |
string | yes | |
expires_in |
integer | yes | |
quality |
string | null |
Example
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 titled “POST /api/v1/files/{file_id}/takes/presign”Presign Take
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · TakePresignIn
| Field | Type | Required | Description |
|---|---|---|---|
content_type |
“audio/wav” | “audio/x-wav” | “audio/wave” | ||
size |
integer | yes |
Returns 200 · TakePresignOut
| Field | Type | Required | Description |
|---|---|---|---|
upload_url |
string | yes | |
key |
string | yes | |
take_id |
string (uuid) | yes |
Example
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 titled “POST /api/v1/files/{file_id}/takes/confirm”Confirm Take
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · TakeConfirmIn
| Field | Type | Required | Description |
|---|---|---|---|
take_id |
string (uuid) | yes | |
key |
string | yes | |
name |
string | null | ||
duration |
number | yes | |
offset_ms |
integer | ||
latency_ms |
integer | ||
sample_rate |
integer | yes | |
speed |
number | ||
pitch_tones |
number |
Returns 201 · TakeOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
audio_file_id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | yes | |
author_name |
string | yes | |
mine |
boolean | yes | |
name |
string | yes | |
status |
string | yes | |
duration |
number | yes | |
offset_ms |
integer | yes | |
latency_ms |
integer | yes | |
sample_rate |
integer | yes | |
speed |
number | yes | |
pitch_tones |
number | yes | |
file_size |
integer | yes | |
shared |
boolean | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “GET /api/v1/files/{file_id}/takes”List Takes
Mine and the shared ones, newest first (small, bounded list: a plain array).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Returns 200 · array of TakeOut
Example
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/takes" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/takes/{take_id}
Section titled “GET /api/v1/takes/{take_id}”Get Take
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
take_id |
path | string (uuid) | yes |
Returns 200 · TakeOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
audio_file_id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | yes | |
author_name |
string | yes | |
mine |
boolean | yes | |
name |
string | yes | |
status |
string | yes | |
duration |
number | yes | |
offset_ms |
integer | yes | |
latency_ms |
integer | yes | |
sample_rate |
integer | yes | |
speed |
number | yes | |
pitch_tones |
number | yes | |
file_size |
integer | yes | |
shared |
boolean | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/takes/{take_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/takes/{take_id}
Section titled “PATCH /api/v1/takes/{take_id}”Update Take
Author only.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
take_id |
path | string (uuid) | yes |
Body · TakePatch
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | null | ||
shared |
boolean | null | ||
offset_ms |
integer | null |
Returns 200 · TakeOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
audio_file_id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | yes | |
author_name |
string | yes | |
mine |
boolean | yes | |
name |
string | yes | |
status |
string | yes | |
duration |
number | yes | |
offset_ms |
integer | yes | |
latency_ms |
integer | yes | |
sample_rate |
integer | yes | |
speed |
number | yes | |
pitch_tones |
number | yes | |
file_size |
integer | yes | |
shared |
boolean | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “DELETE /api/v1/takes/{take_id}”Delete Take
The author, or the workspace owner (for a take they can see: a shared one).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
take_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/takes/{take_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/takes/{take_id}/stream-url
Section titled “GET /api/v1/takes/{take_id}/stream-url”Take Stream Url
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
take_id |
path | string (uuid) | yes |
Returns 200 · TakeStreamUrlOut
| Field | Type | Required | Description |
|---|---|---|---|
url |
string | yes | |
expires_in |
integer | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/takes/{take_id}/stream-url" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/tools/tuner/catalog
Section titled “GET /api/v1/tools/tuner/catalog”Tuner Catalog
Instruments, tunings (string notes + frequencies) and temperaments.
Returns 200 · object
Example
curl -X GET "$JAMCLOUD_API/api/v1/tools/tuner/catalog" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/tools/metronome/catalog
Section titled “GET /api/v1/tools/metronome/catalog”Metronome Catalog
World-rhythm presets (clave, bell timelines, tala, aksak…) with their ethnomusicological notes, categories and sources.
Returns 200 · object
Example
curl -X GET "$JAMCLOUD_API/api/v1/tools/metronome/catalog" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/groups/{group_id}/metronome-presets
Section titled “GET /api/v1/groups/{group_id}/metronome-presets”List Presets
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Returns 200 · array of MetronomePresetOut
Example
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 titled “POST /api/v1/groups/{group_id}/metronome-presets”Create Preset
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Body · MetronomePresetIn
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes | |
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 |
Returns 201 · MetronomePresetOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
name |
string | yes | |
base_preset_id |
string | null | yes | |
bpm |
number | yes | |
numerator |
integer | yes | |
denominator |
integer | yes | |
subdivision |
string | yes | |
bars |
integer | yes | |
pattern |
string | yes | |
swing_ratio |
number | null | yes | |
voice |
string | yes | |
layers |
array of object | yes | |
audio_file_id |
string (uuid) | null | yes | |
analysis |
object | null | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “GET /api/v1/metronome-presets/{preset_id}”Get Preset
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
preset_id |
path | string (uuid) | yes |
Returns 200 · MetronomePresetOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
name |
string | yes | |
base_preset_id |
string | null | yes | |
bpm |
number | yes | |
numerator |
integer | yes | |
denominator |
integer | yes | |
subdivision |
string | yes | |
bars |
integer | yes | |
pattern |
string | yes | |
swing_ratio |
number | null | yes | |
voice |
string | yes | |
layers |
array of object | yes | |
audio_file_id |
string (uuid) | null | yes | |
analysis |
object | null | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PATCH /api/v1/metronome-presets/{preset_id}
Section titled “PATCH /api/v1/metronome-presets/{preset_id}”Patch Preset
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
preset_id |
path | string (uuid) | yes |
Body · MetronomePresetPatch
| Field | Type | Required | 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 |
Returns 200 · MetronomePresetOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
name |
string | yes | |
base_preset_id |
string | null | yes | |
bpm |
number | yes | |
numerator |
integer | yes | |
denominator |
integer | yes | |
subdivision |
string | yes | |
bars |
integer | yes | |
pattern |
string | yes | |
swing_ratio |
number | null | yes | |
voice |
string | yes | |
layers |
array of object | yes | |
audio_file_id |
string (uuid) | null | yes | |
analysis |
object | null | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “DELETE /api/v1/metronome-presets/{preset_id}”Delete Preset
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
preset_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
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 titled “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).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
preset_id |
path | string (uuid) | yes |
Returns 202 · app__modules__tools__schemas__JobOut
| Field | Type | Required | Description |
|---|---|---|---|
status |
string | yes | |
job_id |
string | yes | |
audio_id |
string (uuid) | null |
Example
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 titled “POST /api/v1/metronome-presets/{preset_id}/render”Render
Render a click track and import it into the library (same pipeline as an upload).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
preset_id |
path | string (uuid) | yes |
Body · RenderIn
| Field | Type | Required | Description |
|---|---|---|---|
bars |
integer |
Returns 202 · app__modules__tools__schemas__JobOut
| Field | Type | Required | Description |
|---|---|---|---|
status |
string | yes | |
job_id |
string | yes | |
audio_id |
string (uuid) | null |
Example
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 titled “GET /api/v1/groups/{group_id}/tuner-profiles”List Tunings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Returns 200 · array of TunerProfileOut
Example
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 titled “POST /api/v1/groups/{group_id}/tuner-profiles”Create Tuning
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Body · TunerProfileIn
| Field | Type | Required | Description |
|---|---|---|---|
instrument |
string | yes | |
name |
string | yes | |
strings |
array of string | yes | |
reference_hz |
number | ||
temperament |
string | ||
tonic |
integer |
Returns 201 · TunerProfileOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
instrument |
string | yes | |
name |
string | yes | |
strings |
array of string | yes | |
reference_hz |
number | yes | |
temperament |
string | yes | |
tonic |
integer | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “PATCH /api/v1/tuner-profiles/{tuning_id}”Patch Tuning
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tuning_id |
path | string (uuid) | yes |
Body · TunerProfilePatch
| Field | Type | Required | Description |
|---|---|---|---|
instrument |
string | null | ||
name |
string | null | ||
strings |
array of string | null | ||
reference_hz |
number | null | ||
temperament |
string | null | ||
tonic |
integer | null |
Returns 200 · TunerProfileOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
group_id |
string (uuid) | yes | |
created_by |
string (uuid) | null | yes | |
instrument |
string | yes | |
name |
string | yes | |
strings |
array of string | yes | |
reference_hz |
number | yes | |
temperament |
string | yes | |
tonic |
integer | yes | |
created_at |
string (date-time) | yes | |
updated_at |
string (date-time) | yes |
Example
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 titled “DELETE /api/v1/tuner-profiles/{tuning_id}”Delete Tuning
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tuning_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/tuner-profiles/{tuning_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Transformer
Section titled “Transformer”PATCH /api/v1/files/{file_id}/metadata
Section titled “PATCH /api/v1/files/{file_id}/metadata”Update Metadata
Write tags into the audio file (async). Not quota-counted: a basic edit.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes |
Body · MetadataIn
| Field | Type | Required | Description |
|---|---|---|---|
tags |
object | yes |
Returns 202 · MetadataJobOut
| Field | Type | Required | Description |
|---|---|---|---|
status |
string | ||
job_id |
string | yes | |
transformation_id |
string (uuid) | yes |
Example
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 titled “POST /api/v1/files/{file_id}/transformations/{process}”Trigger
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
file_id |
path | string (uuid) | yes | |
process |
path | string | yes |
Body · TriggerIn | null
Returns 202 · TriggerOut
| Field | Type | Required | 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 | yes | |
job_id |
string | yes | |
transformation_id |
string (uuid) | yes |
Example
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 titled “GET /api/v1/separation-models”Separation Models
Separation models an admin enabled, default first in catalog order.
Returns 200 · array of SeparationModelOut
Example
curl -X GET "$JAMCLOUD_API/api/v1/separation-models" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/groups/{group_id}/files/batch-metadata
Section titled “POST /api/v1/groups/{group_id}/files/batch-metadata”Batch Metadata
Same tags on many files of the workspace; unknown ids are skipped.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Body · BatchMetadataIn
| Field | Type | Required | Description |
|---|---|---|---|
file_ids |
array of string (uuid) | yes | |
tags |
object | yes |
Returns 202 · BatchMetadataOut
| Field | Type | Required | Description |
|---|---|---|---|
jobs |
array of BatchJob | yes |
Example
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 titled “GET /api/v1/jobs/{job_id}”Job Status
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
job_id |
path | string | yes |
Returns 200 · app__modules__transformer__schemas__JobOut
| Field | Type | Required | 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 | yes | |
state |
string | yes | |
status |
string | yes | |
progress |
integer | yes | |
ready |
boolean | yes | |
successful |
boolean | yes | |
transformation_id |
string (uuid) | yes |
Example
curl -X GET "$JAMCLOUD_API/api/v1/jobs/{job_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"DELETE /api/v1/jobs/{job_id}
Section titled “DELETE /api/v1/jobs/{job_id}”Cancel Job
Withdraw a request still waiting in line (editor); its quota use is refunded.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
job_id |
path | string | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/jobs/{job_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/jobs/{job_id}/events
Section titled “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).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
job_id |
path | string | yes |
Returns 200 · object
Example
curl -X GET "$JAMCLOUD_API/api/v1/jobs/{job_id}/events" \ -H "Authorization: Bearer $JAMCLOUD_KEY"DELETE /api/v1/transformations/{transformation_id}
Section titled “DELETE /api/v1/transformations/{transformation_id}”Delete Transformation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
transformation_id |
path | string (uuid) | yes |
Returns 204 · no content
Example
curl -X DELETE "$JAMCLOUD_API/api/v1/transformations/{transformation_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Workspaces
Section titled “Workspaces”GET /api/v1/groups
Section titled “GET /api/v1/groups”My Workspaces
Returns 200 · array of WorkspaceOut
Example
curl -X GET "$JAMCLOUD_API/api/v1/groups" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/groups/{group_id}
Section titled “GET /api/v1/groups/{group_id}”Get Workspace
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Returns 200 · WorkspaceOut
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
name |
string | yes | |
kind |
string | yes | |
my_role |
GroupRole | yes | |
created_at |
string (date-time) | yes | |
owner_id |
string (uuid) | null | yes | |
member_count |
integer | yes | Members besides the owner. |
members |
array of WorkspaceMemberOut | yes | |
settings |
WorkspaceSettingsOut |
Example
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/groups/{group_id}/settings
Section titled “GET /api/v1/groups/{group_id}/settings”Get Settings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
group_id |
path | string (uuid) | yes |
Returns 200 · WorkspaceSettingsOut
| Field | Type | Required | Description |
|---|---|---|---|
boards_viewers_can_write |
boolean |
Example
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/settings" \ -H "Authorization: Bearer $JAMCLOUD_KEY"