Ir al contenido

Referencia de la API

La referencia para desarrolladores: lo que espera y devuelve cada ruta. Para obtener una clave y ver a qué puede acceder, lee primero API.

La versión está en cada ruta: /api/v1. Dentro de la versión 1, las rutas y los campos solo se añaden, nunca se renombran ni se eliminan: ignora los campos que no conozcas. Un cambio que rompería tu código llega como una nueva versión (/api/v2), con la v1 funcionando a su lado.

Guarda la dirección de la API y tu clave en variables de entorno y llámala con cualquier cliente HTTP: no hay SDK que instalar.

Ventana de terminal
export JAMCLOUD_API=https://api-jamcloud.australfactory.cl
export JAMCLOUD_KEY=jc_…
curl -H "Authorization: Bearer $JAMCLOUD_KEY" "$JAMCLOUD_API/api/v1/groups"
import os, requests
api = os.environ["JAMCLOUD_API"] + "/api/v1"
s = requests.Session()
s.headers["Authorization"] = "Bearer " + os.environ["JAMCLOUD_KEY"]
workspaces = s.get(f"{api}/groups").json()
tracks = s.get(f"{api}/groups/{workspaces[0]['id']}/files", params={"limit": 20}).json()["items"]
const api = `${process.env.JAMCLOUD_API}/api/v1`;
const headers = { Authorization: `Bearer ${process.env.JAMCLOUD_KEY}` };
const res = await fetch(`${api}/groups`, { headers });
if (!res.ok) throw new Error((await res.json()).code); // stable error code
const workspaces = await res.json();
  • JSON de entrada y salida, campos en snake_case, los ids son UUID.
  • Las listas devuelven {items, total, limit, offset}; pagina con los parámetros limit y offset.
  • Los errores son problem+json {type, title, status, code, details}: comprueba code, nunca cambia.
  • Subir un archivo lleva tres llamadas: presign, PUT del archivo a la URL devuelta y confirm. La URL vale 15 minutos y solo acepta exactamente el size declarado, en un único PUT.
  • 503 circuit_open: espera los segundos de Retry-After y vuelve a intentarlo.

Cada sección de abajo es un recurso; cada ruta indica sus parámetros, campos, respuesta y un ejemplo curl.

Versión de la API: v1 · cada ruta de abajo empieza por /api/v1

List Boards

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

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí
limit query integer
offset query integer

Devuelve 200 · Page_BoardOut_

Campo Tipo Obligatorio Descripción
items array of BoardOut sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

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

Create Board

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Cuerpo · BoardIn

Campo Tipo Obligatorio Descripción
title string sí

Devuelve 201 · BoardDetail

Campo Tipo Obligatorio Descripción
id string (uuid) sí
group_id string (uuid) sí
file_id string (uuid) | null sí
created_by string (uuid) | null sí
title string sí
version integer sí
item_count integer sí
can_write boolean sí
created_at string (date-time) sí
updated_at string (date-time) sí
items array of BoardItemOut sí

Ejemplo

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

Get Track Board

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

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 200 · BoardDetail

Campo Tipo Obligatorio Descripción
id string (uuid) sí
group_id string (uuid) sí
file_id string (uuid) | null sí
created_by string (uuid) | null sí
title string sí
version integer sí
item_count integer sí
can_write boolean sí
created_at string (date-time) sí
updated_at string (date-time) sí
items array of BoardItemOut sí

Ejemplo

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

Get Board

Parámetros

Nombre En Tipo Obligatorio Descripción
board_id path string (uuid) sí

Devuelve 200 · BoardDetail

Campo Tipo Obligatorio Descripción
id string (uuid) sí
group_id string (uuid) sí
file_id string (uuid) | null sí
created_by string (uuid) | null sí
title string sí
version integer sí
item_count integer sí
can_write boolean sí
created_at string (date-time) sí
updated_at string (date-time) sí
items array of BoardItemOut sí

Ejemplo

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

Rename Board

Parámetros

Nombre En Tipo Obligatorio Descripción
board_id path string (uuid) sí

Cuerpo · BoardPatch

Campo Tipo Obligatorio Descripción
title string sí

Devuelve 200 · BoardOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
group_id string (uuid) sí
file_id string (uuid) | null sí
created_by string (uuid) | null sí
title string sí
version integer sí
item_count integer sí
can_write boolean sí
created_at string (date-time) sí
updated_at string (date-time) sí

Ejemplo

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

Delete Board

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

Parámetros

Nombre En Tipo Obligatorio Descripción
board_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

Ventana de terminal
curl -X DELETE "$JAMCLOUD_API/api/v1/boards/{board_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Apply Ops

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

Parámetros

Nombre En Tipo Obligatorio Descripción
board_id path string (uuid) sí

Cuerpo · OpsIn

Campo Tipo Obligatorio Descripción
client_id string sí
ops array of UpsertOp | DeleteOp | ClearOp sí

Devuelve 200 · OpsOut

Campo Tipo Obligatorio Descripción
version integer sí
items array of ItemRev sí

Ejemplo

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

Get Chart

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 200 · ChartOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
file_id string (uuid) sí
content object sí
anchor_bar integer sí
source string sí
created_at string (date-time) sí
updated_at string (date-time) sí

Ejemplo

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

Put Chart

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · ChartIn

Campo Tipo Obligatorio Descripción
content ChartContent sí
anchor_bar integer
source “manual” | “import”

Devuelve 200 · ChartOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
file_id string (uuid) sí
content object sí
anchor_bar integer sí
source string sí
created_at string (date-time) sí
updated_at string (date-time) sí

Ejemplo

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

Delete Chart

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

Get Score

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 200 · ScoreOut

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

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/score" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Upload Score

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

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 201 · ScoreOut

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

Ejemplo

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

Patch Score

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · ScorePatch

Campo Tipo Obligatorio Descripción
anchor_bar integer | null
settings object | null

Devuelve 200 · ScoreOut

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

Ejemplo

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

Delete Score

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

Ventana de terminal
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/score" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Save Score Content

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

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 200 · ScoreOut

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

Ejemplo

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

Export File

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · ExportIn

Campo Tipo Obligatorio Descripción
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

Devuelve 202 · ExportJobOut

Campo Tipo Obligatorio Descripción
job_id string sí
file_id string | null
status “queued” | “processing” | “ready” | “failed” sí
filename string | null
url string | null
expires_in integer | null
code string | null

Ejemplo

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

Export Status

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

Parámetros

Nombre En Tipo Obligatorio Descripción
job_id path string (uuid) sí

Devuelve 200 · ExportJobOut

Campo Tipo Obligatorio Descripción
job_id string sí
file_id string | null
status “queued” | “processing” | “ready” | “failed” sí
filename string | null
url string | null
expires_in integer | null
code string | null

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/exports/{job_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Send Feedback

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

Cuerpo · FeedbackIn

Campo Tipo Obligatorio Descripción
category “bug” | “idea” | “question” | “other” sí
message string sí
group_id string | null The workspace open in the app.
context FeedbackContext

Devuelve 201 · FeedbackOut

Campo Tipo Obligatorio Descripción
id string sí
category “bug” | “idea” | “question” | “other” sí
status “new” | “done” sí
created_at string (date-time) sí

Ejemplo

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

List Directories

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Devuelve 200 · array of DirectoryOut

Ejemplo

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

Create Directory

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Cuerpo · DirectoryIn

Campo Tipo Obligatorio Descripción
name string sí

Devuelve 200 · object

Ejemplo

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

Delete Directory

Parámetros

Nombre En Tipo Obligatorio Descripción
directory_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

List Files

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí
tags query array of string
favorite query boolean | null
search query string
directory_id query string (uuid) | null
limit query integer
offset query integer

Devuelve 200 · Page_FileSummary_

Campo Tipo Obligatorio Descripción
items array of FileSummary sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

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

Recent Files

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Devuelve 200 · array of FileSummary

Ejemplo

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

Group Tags

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Devuelve 200 · TagsOut

Campo Tipo Obligatorio Descripción
tags array of string sí

Ejemplo

Ventana de terminal
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

Sección titulada «POST /api/v1/groups/{group_id}/files/batch-delete»

Batch Delete

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Cuerpo · BatchIds

Campo Tipo Obligatorio Descripción
file_ids array of string (uuid) sí

Devuelve 200 · BatchDeleteOut

Campo Tipo Obligatorio Descripción
deleted integer sí

Ejemplo

Ventana de terminal
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

Sección titulada «POST /api/v1/groups/{group_id}/files/batch-move»

Batch Move

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

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Cuerpo · BatchMoveIn

Campo Tipo Obligatorio Descripción
file_ids array of string (uuid) sí
target_group_id string (uuid) sí

Devuelve 200 · BatchMoveOut

Campo Tipo Obligatorio Descripción
moved integer sí

Ejemplo

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

List All Files

Parámetros

Nombre En Tipo Obligatorio Descripción
tags query array of string
favorite query boolean | null
search query string
limit query integer
offset query integer

Devuelve 200 · Page_FileSummary_

Campo Tipo Obligatorio Descripción
items array of FileSummary sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/files" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Recent All Files

Devuelve 200 · array of FileSummary

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/files/recent" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

All Tags

Devuelve 200 · TagsOut

Campo Tipo Obligatorio Descripción
tags array of string sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/files/tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get File

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

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí
play query boolean

Devuelve 200 · FileOut

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

Ejemplo

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

Patch File

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · FilePatch

Campo Tipo Obligatorio Descripción
title string | null
description string | null
favorite boolean | null
tags array of string | null
directory_id string (uuid) | null
parent_id null

Devuelve 200 · FileOut

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

Ejemplo

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

Delete File

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

Ventana de terminal
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Extract Clip

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

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · ExtractIn

Campo Tipo Obligatorio Descripción
start number sí
end number sí
title string | null

Devuelve 202 · ExtractOut

Campo Tipo Obligatorio Descripción
status string sí
job_id string sí
audio_id string (uuid) sí

Ejemplo

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

Set Favorite

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · FavoriteIn

Campo Tipo Obligatorio Descripción
favorite boolean sí

Devuelve 200 · FileSummary

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

Ejemplo

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

File Tags

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 200 · TagsOut

Campo Tipo Obligatorio Descripción
tags array of string sí

Ejemplo

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

Add Tags

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · TagsIn

Campo Tipo Obligatorio Descripción
tags array of string sí

Devuelve 200 · TagsOut

Campo Tipo Obligatorio Descripción
tags array of string sí

Ejemplo

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

Remove Tag

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí
tag path string sí

Devuelve 200 · TagsOut

Campo Tipo Obligatorio Descripción
tags array of string sí

Ejemplo

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

Get Metadata

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 200 · MetadataOut

Campo Tipo Obligatorio Descripción
normalized object sí
has_cover_art boolean sí
cover_image_url string | null sí
technical object | null sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/metadata" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

File Status

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

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 200 · StatusOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
transformations object sí

Ejemplo

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

Delete All Stems

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

Ventana de terminal
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}

Sección titulada «DELETE /api/v1/files/{file_id}/stems/{stem_name}»

Delete Stem

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí
stem_name path string sí

Devuelve 204 · sin contenido

Ejemplo

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

List Families

Parámetros

Nombre En Tipo Obligatorio Descripción
search query string | null
ordering query string | null
limit query integer
offset query integer

Devuelve 200 · Page_FamilyOut_

Campo Tipo Obligatorio Descripción
items array of FamilyOut sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/harmony/families" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Families

Cuerpo · FamilyIn

Campo Tipo Obligatorio Descripción
name string sí
description string

Devuelve 201 · FamilyOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
name string sí
description string sí

Ejemplo

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

Get Families

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 200 · FamilyOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
name string sí
description string sí

Ejemplo

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

Patch Families

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Cuerpo · FamilyPatch

Campo Tipo Obligatorio Descripción
name string | null
description string | null

Devuelve 200 · FamilyOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
name string sí
description string sí

Ejemplo

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

Delete Families

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

List Qualities

Parámetros

Nombre En Tipo Obligatorio Descripción
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Devuelve 200 · Page_QualityOut_

Campo Tipo Obligatorio Descripción
items array of QualityOut sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/harmony/qualities" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Quality

Cuerpo · QualityIn

Campo Tipo Obligatorio Descripción
key string sí
family_id string (uuid) sí
formula array of integer sí
description string

Devuelve 201 · QualityOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
key string sí
family string sí
family_id string (uuid) sí
formula array of integer sí
aliases array of AliasOut sí
description string sí

Ejemplo

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

Get Quality

Parámetros

Nombre En Tipo Obligatorio Descripción
key path string sí

Devuelve 200 · QualityOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
key string sí
family string sí
family_id string (uuid) sí
formula array of integer sí
aliases array of AliasOut sí
description string sí

Ejemplo

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

Patch Quality

Parámetros

Nombre En Tipo Obligatorio Descripción
key path string sí

Cuerpo · QualityPatch

Campo Tipo Obligatorio Descripción
key string | null
family_id string (uuid) | null
formula array of integer | null
description string | null

Devuelve 200 · QualityOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
key string sí
family string sí
family_id string (uuid) sí
formula array of integer sí
aliases array of AliasOut sí
description string sí

Ejemplo

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

Delete Quality

Parámetros

Nombre En Tipo Obligatorio Descripción
key path string sí

Devuelve 204 · sin contenido

Ejemplo

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

List Aliases

Parámetros

Nombre En Tipo Obligatorio Descripción
quality query string (uuid) | null
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Devuelve 200 · Page_AliasOut_

Campo Tipo Obligatorio Descripción
items array of AliasOut sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/harmony/aliases" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Aliases

Cuerpo · AliasIn

Campo Tipo Obligatorio Descripción
quality_id string (uuid) sí
alias string sí
is_preferred boolean

Devuelve 201 · AliasOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
quality_id string (uuid) sí
alias string sí
is_preferred boolean sí

Ejemplo

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

Get Aliases

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 200 · AliasOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
quality_id string (uuid) sí
alias string sí
is_preferred boolean sí

Ejemplo

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

Patch Aliases

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Cuerpo · AliasPatch

Campo Tipo Obligatorio Descripción
quality_id string (uuid) | null
alias string | null
is_preferred boolean | null

Devuelve 200 · AliasOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
quality_id string (uuid) sí
alias string sí
is_preferred boolean sí

Ejemplo

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

Delete Aliases

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

List Types

Parámetros

Nombre En Tipo Obligatorio Descripción
quality query string (uuid) | null
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Devuelve 200 · Page_ChordTypeOut_

Campo Tipo Obligatorio Descripción
items array of ChordTypeOut sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/harmony/types" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Types

Cuerpo · ChordTypeIn

Campo Tipo Obligatorio Descripción
label string sí
description string
quality_id string (uuid) | null

Devuelve 201 · ChordTypeOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
label string sí
description string sí
quality_id string (uuid) | null sí
quality_key string | null sí
family string | null sí

Ejemplo

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

Get Types

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 200 · ChordTypeOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
label string sí
description string sí
quality_id string (uuid) | null sí
quality_key string | null sí
family string | null sí

Ejemplo

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

Patch Types

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Cuerpo · ChordTypePatch

Campo Tipo Obligatorio Descripción
label string | null
description string | null
quality_id string (uuid) | null

Devuelve 200 · ChordTypeOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
label string sí
description string sí
quality_id string (uuid) | null sí
quality_key string | null sí
family string | null sí

Ejemplo

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

Delete Types

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

List Instruments

Parámetros

Nombre En Tipo Obligatorio Descripción
search query string | null
ordering query string | null
limit query integer
offset query integer

Devuelve 200 · Page_InstrumentOut_

Campo Tipo Obligatorio Descripción
items array of InstrumentOut sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/harmony/instruments" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Instruments

Cuerpo · InstrumentIn

Campo Tipo Obligatorio Descripción
name string sí
string_count integer

Devuelve 201 · InstrumentOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
name string sí
string_count integer sí

Ejemplo

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

Get Instruments

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 200 · InstrumentOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
name string sí
string_count integer sí

Ejemplo

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

Patch Instruments

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Cuerpo · InstrumentPatch

Campo Tipo Obligatorio Descripción
name string | null
string_count integer | null

Devuelve 200 · InstrumentOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
name string sí
string_count integer sí

Ejemplo

Ventana de terminal
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}

Sección titulada «DELETE /api/v1/harmony/instruments/{item_id}»

Delete Instruments

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

List Tunings

Parámetros

Nombre En Tipo Obligatorio Descripción
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

Devuelve 200 · Page_TuningOut_

Campo Tipo Obligatorio Descripción
items array of TuningOut sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/harmony/tunings" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Tunings

Cuerpo · TuningIn

Campo Tipo Obligatorio Descripción
instrument_id string (uuid) sí
name string sí
open_strings array of string sí
is_default boolean

Devuelve 201 · TuningOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
instrument InstrumentOut sí
name string sí
open_strings array of string sí
is_default boolean sí

Ejemplo

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

Get Tunings

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 200 · TuningOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
instrument InstrumentOut sí
name string sí
open_strings array of string sí
is_default boolean sí

Ejemplo

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

Patch Tunings

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Cuerpo · TuningPatch

Campo Tipo Obligatorio Descripción
instrument_id string (uuid) | null
name string | null
open_strings array of string | null
is_default boolean | null

Devuelve 200 · TuningOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
instrument InstrumentOut sí
name string sí
open_strings array of string sí
is_default boolean sí

Ejemplo

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

Delete Tunings

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

List Voicing Tags

Parámetros

Nombre En Tipo Obligatorio Descripción
search query string | null
ordering query string | null
limit query integer
offset query integer

Devuelve 200 · Page_VoicingTagOut_

Campo Tipo Obligatorio Descripción
items array of VoicingTagOut sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing-Tags

Cuerpo · VoicingTagIn

Campo Tipo Obligatorio Descripción
name string sí

Devuelve 201 · VoicingTagOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
name string sí

Ejemplo

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

Get Voicing-Tags

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 200 · VoicingTagOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
name string sí

Ejemplo

Ventana de terminal
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}

Sección titulada «PATCH /api/v1/harmony/voicing-tags/{item_id}»

Patch Voicing-Tags

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Cuerpo · VoicingTagPatch

Campo Tipo Obligatorio Descripción
name string | null

Devuelve 200 · VoicingTagOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
name string sí

Ejemplo

Ventana de terminal
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}

Sección titulada «DELETE /api/v1/harmony/voicing-tags/{item_id}»

Delete Voicing-Tags

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

List Voicings

Parámetros

Nombre En Tipo Obligatorio Descripción
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

Devuelve 200 · Page_VoicingOut_

Campo Tipo Obligatorio Descripción
items array of VoicingOut sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicings" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing

Cuerpo · VoicingIn

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

Devuelve 201 · VoicingOut

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

Ejemplo

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

Get Voicing

Parámetros

Nombre En Tipo Obligatorio Descripción
voicing_id path string (uuid) sí

Devuelve 200 · VoicingOut

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

Ejemplo

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

Patch Voicing

Parámetros

Nombre En Tipo Obligatorio Descripción
voicing_id path string (uuid) sí

Cuerpo · VoicingPatch

Campo Tipo Obligatorio Descripción
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

Devuelve 200 · VoicingOut

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

Ejemplo

Ventana de terminal
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}

Sección titulada «DELETE /api/v1/harmony/voicings/{voicing_id}»

Delete Voicing

Parámetros

Nombre En Tipo Obligatorio Descripción
voicing_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

List References

Parámetros

Nombre En Tipo Obligatorio Descripción
search query string | null
ordering query string | null
limit query integer
offset query integer

Devuelve 200 · Page_ReferenceOut_

Campo Tipo Obligatorio Descripción
items array of ReferenceOut sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/harmony/references" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create References

Cuerpo · ReferenceIn

Campo Tipo Obligatorio Descripción
title string sí
author string
details string

Devuelve 201 · ReferenceOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
title string sí
author string sí
details string sí

Ejemplo

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

Get References

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 200 · ReferenceOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
title string sí
author string sí
details string sí

Ejemplo

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

Patch References

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Cuerpo · ReferencePatch

Campo Tipo Obligatorio Descripción
title string | null
author string | null
details string | null

Devuelve 200 · ReferenceOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
title string sí
author string sí
details string sí

Ejemplo

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

Delete References

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

List Voicing References

Parámetros

Nombre En Tipo Obligatorio Descripción
voicing query string (uuid) | null
source query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Devuelve 200 · Page_VoicingReferenceOut_

Campo Tipo Obligatorio Descripción
items array of VoicingReferenceOut sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-references" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing-References

Cuerpo · VoicingReferenceIn

Campo Tipo Obligatorio Descripción
voicing_id string (uuid) sí
source_id string (uuid) sí
page string
figure string

Devuelve 201 · VoicingReferenceOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
voicing_id string (uuid) sí
source ReferenceOut sí
page string sí
figure string sí

Ejemplo

Ventana de terminal
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}

Sección titulada «GET /api/v1/harmony/voicing-references/{item_id}»

Get Voicing-References

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 200 · VoicingReferenceOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
voicing_id string (uuid) sí
source ReferenceOut sí
page string sí
figure string sí

Ejemplo

Ventana de terminal
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}

Sección titulada «PATCH /api/v1/harmony/voicing-references/{item_id}»

Patch Voicing-References

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Cuerpo · VoicingReferencePatch

Campo Tipo Obligatorio Descripción
voicing_id string (uuid) | null
source_id string (uuid) | null
page string | null
figure string | null

Devuelve 200 · VoicingReferenceOut

Campo Tipo Obligatorio Descripción
created_at string (date-time) sí
updated_at string (date-time) sí
id string (uuid) sí
voicing_id string (uuid) sí
source ReferenceOut sí
page string sí
figure string sí

Ejemplo

Ventana de terminal
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}

Sección titulada «DELETE /api/v1/harmony/voicing-references/{item_id}»

Delete Voicing-References

Parámetros

Nombre En Tipo Obligatorio Descripción
item_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

List Entries

Parámetros

Nombre En Tipo Obligatorio Descripción
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

Devuelve 200 · Page_EntryOut_

Campo Tipo Obligatorio Descripción
items array of EntryOut sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Entry By Symbol

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

Parámetros

Nombre En Tipo Obligatorio Descripción
symbol query string

Devuelve 200 · EntryOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
symbol string sí
root string sí
bass string sí
quality QualityOut sí
family string sí

Ejemplo

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

Get Entry

Parámetros

Nombre En Tipo Obligatorio Descripción
entry_id path string (uuid) sí

Devuelve 200 · EntryOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
symbol string sí
root string sí
bass string sí
quality QualityOut sí
family string sí

Ejemplo

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

Live

Devuelve 200 · object

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/health/live" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Ready

Devuelve 200 · object

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/health/ready" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

POST /api/v1/groups/{group_id}/uploads/presign

Sección titulada «POST /api/v1/groups/{group_id}/uploads/presign»

Presign Upload

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Cuerpo · PresignIn

Campo Tipo Obligatorio Descripción
filename string sí
content_type string sí
size integer sí

Devuelve 200 · PresignOut

Campo Tipo Obligatorio Descripción
upload_url string sí
key string sí
audio_id string (uuid) sí

Ejemplo

Ventana de terminal
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

Sección titulada «POST /api/v1/groups/{group_id}/uploads/confirm»

Confirm Upload

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Cuerpo · app__modules__ingestion__schemas__ConfirmIn

Campo Tipo Obligatorio Descripción
key string sí
audio_id string (uuid) sí
directory_id string (uuid) | null

Devuelve 201 · ConfirmOut

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

Ejemplo

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

Ingest Url

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Cuerpo · IngestUrlIn

Campo Tipo Obligatorio Descripción
video_url string (uri) sí
format IngestFormat

Devuelve 202 · IngestUrlOut

Campo Tipo Obligatorio Descripción
status string sí
job_id string sí
audio_id string (uuid) sí

Ejemplo

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

Upload Conditions

Devuelve 200 · ConditionsOut

Campo Tipo Obligatorio Descripción
extensions array of string sí
max_file_size_mb integer sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/uploads/conditions" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Lyrics

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 200 · LyricsOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
file_id string (uuid) sí
lines array of object sí
offset_ms integer sí
source string sí
source_ref string | null sí
synced boolean sí
updated_by string (uuid) | null sí
created_at string (date-time) sí
updated_at string (date-time) sí

Ejemplo

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

Put Lyrics

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · LyricsIn

Campo Tipo Obligatorio Descripción
lines array of LyricsLine sí
offset_ms integer
source “manual” | “file” | “lrclib”
source_ref string | null

Devuelve 200 · LyricsOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
file_id string (uuid) sí
lines array of object sí
offset_ms integer sí
source string sí
source_ref string | null sí
synced boolean sí
updated_by string (uuid) | null sí
created_at string (date-time) sí
updated_at string (date-time) sí

Ejemplo

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

Delete Lyrics

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

Ventana de terminal
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Search Lyrics

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

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí
track query string | null
artist query string | null
q query string | null

Devuelve 200 · array of LyricsCandidate

Ejemplo

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

List Sections

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí
section_type query string | null

Devuelve 200 · array of SectionOut

Ejemplo

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

Create Section

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · SectionIn

Campo Tipo Obligatorio Descripción
start number sí
end number | null
section_type string sí
observation string | null

Devuelve 201 · SectionOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
file_id string (uuid) sí
start number sí
end number | null sí
label string sí
color string | null sí
section_type string sí
section_number integer sí
observation string | null sí

Ejemplo

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

Patch Section

Parámetros

Nombre En Tipo Obligatorio Descripción
section_id path string (uuid) sí

Cuerpo · SectionPatch

Campo Tipo Obligatorio Descripción
start number | null
end number | null
section_type string | null
observation string | null

Devuelve 200 · SectionOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
file_id string (uuid) sí
start number sí
end number | null sí
label string sí
color string | null sí
section_type string sí
section_number integer sí
observation string | null sí

Ejemplo

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

Delete Section

Parámetros

Nombre En Tipo Obligatorio Descripción
section_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

List Marks

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 200 · array of MarkOut

Ejemplo

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

Create Mark

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · MarkIn

Campo Tipo Obligatorio Descripción
start number sí
name string | null
observation string | null

Devuelve 201 · MarkOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
file_id string (uuid) sí
start number sí
name string sí
observation string | null sí

Ejemplo

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

Patch Mark

Parámetros

Nombre En Tipo Obligatorio Descripción
mark_id path string (uuid) sí

Cuerpo · MarkPatch

Campo Tipo Obligatorio Descripción
start number | null
name string | null
observation string | null

Devuelve 200 · MarkOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
file_id string (uuid) sí
start number sí
name string sí
observation string | null sí

Ejemplo

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

Delete Mark

Parámetros

Nombre En Tipo Obligatorio Descripción
mark_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

List Loops

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 200 · array of LoopOut

Ejemplo

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

Create Loop

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · LoopIn

Campo Tipo Obligatorio Descripción
start number sí
end number | null
name string | null
observation string | null

Devuelve 201 · LoopOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
file_id string (uuid) sí
start number sí
end number | null sí
name string sí
observation string | null sí

Ejemplo

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

Patch Loop

Parámetros

Nombre En Tipo Obligatorio Descripción
loop_id path string (uuid) sí

Cuerpo · LoopPatch

Campo Tipo Obligatorio Descripción
start number | null
end number | null
name string | null
observation string | null

Devuelve 200 · LoopOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
file_id string (uuid) sí
start number sí
end number | null sí
name string sí
observation string | null sí

Ejemplo

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

Delete Loop

Parámetros

Nombre En Tipo Obligatorio Descripción
loop_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

Ventana de terminal
curl -X DELETE "$JAMCLOUD_API/api/v1/loops/{loop_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Beats

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

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 200 · BeatsOut

Campo Tipo Obligatorio Descripción
id string (uuid) | null
beats array of object sí
meter array of MeterEntry sí
source string sí
beat_count integer sí
created_at string (date-time) | null
updated_at string (date-time) | null

Ejemplo

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

Put Beats

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · BeatsIn

Campo Tipo Obligatorio Descripción
beats array of number sí
meter array of MeterEntry

Devuelve 200 · BeatsOut

Campo Tipo Obligatorio Descripción
id string (uuid) | null
beats array of object sí
meter array of MeterEntry sí
source string sí
beat_count integer sí
created_at string (date-time) | null
updated_at string (date-time) | null

Ejemplo

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

Delete Beats

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

Ventana de terminal
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/beats" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Import

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

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

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Devuelve 202 · ImportCreated

Campo Tipo Obligatorio Descripción
import_job_id string (uuid) sí
job_id string sí
status string sí

Ejemplo

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

Import Status

Parámetros

Nombre En Tipo Obligatorio Descripción
import_id path string (uuid) sí

Devuelve 200 · app__modules__music_import__schemas__ImportJobOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
original_filename string sí
source_format string sí
status string sí
notation_id string (uuid) | null sí
error_message string sí
progress_percent integer sí
progress_message string sí
parser_logs object sí
created_at string (date-time) sí

Ejemplo

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

Formats

Enabled import formats and their extensions.

Devuelve 200 · array of FormatOut

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/import/formats" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Notations

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí
audio_file_id query string (uuid) | null
favorite query boolean | null
tags query array of string
search query string
limit query integer
offset query integer

Devuelve 200 · Page_NotationSummary_

Campo Tipo Obligatorio Descripción
items array of NotationSummary sí
total integer sí
limit integer sí
offset integer sí

Ejemplo

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

Create Notation

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Cuerpo · NotationIn

Campo Tipo Obligatorio Descripción
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)

Devuelve 201 · NotationOut

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

Ejemplo

Ventana de terminal
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

Sección titulada «GET /api/v1/groups/{group_id}/notations/tags»

Notation Tags

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Devuelve 200 · TagsOut

Campo Tipo Obligatorio Descripción
tags array of string sí

Ejemplo

Ventana de terminal
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

Sección titulada «GET /api/v1/groups/{group_id}/notations/recent»

Recent Notations

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Devuelve 200 · array of NotationSummary

Ejemplo

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

Get Notation

Parámetros

Nombre En Tipo Obligatorio Descripción
notation_id path string (uuid) sí

Devuelve 200 · NotationOut

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

Ejemplo

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

Patch Notation

Parámetros

Nombre En Tipo Obligatorio Descripción
notation_id path string (uuid) sí

Cuerpo · NotationPatch

Campo Tipo Obligatorio Descripción
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

Devuelve 200 · NotationOut

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

Ejemplo

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

Delete Notation

Parámetros

Nombre En Tipo Obligatorio Descripción
notation_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

POST /api/v1/notations/{notation_id}/favorite

Sección titulada «POST /api/v1/notations/{notation_id}/favorite»

Set Favorite

Parámetros

Nombre En Tipo Obligatorio Descripción
notation_id path string (uuid) sí

Cuerpo · FavoriteIn

Campo Tipo Obligatorio Descripción
favorite boolean sí

Devuelve 200 · NotationOut

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

Ejemplo

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

Categories

Devuelve 200 · array of CategoryOut

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/notation-categories" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Platform

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

Devuelve 200 · PlatformOut

Campo Tipo Obligatorio Descripción
payments_enabled boolean sí
site_show_signup boolean sí
site_hidden_pages array of string sí
site_announcement string sí
site_announcement_url string sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/platform" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Playlists

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Devuelve 200 · array of PlaylistOut

Ejemplo

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

Create Playlist

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Cuerpo · PlaylistIn

Campo Tipo Obligatorio Descripción
name string sí
repeat_mode “off” | “all” | “one”

Devuelve 201 · PlaylistDetail

Campo Tipo Obligatorio Descripción
id string (uuid) sí
group_id string (uuid) sí
created_by string (uuid) | null sí
name string sí
repeat_mode string sí
track_count integer sí
created_at string (date-time) sí
updated_at string (date-time) sí
tracks array of app__modules__playlists__schemas__TrackOut sí

Ejemplo

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

Get Playlist

Parámetros

Nombre En Tipo Obligatorio Descripción
playlist_id path string (uuid) sí

Devuelve 200 · PlaylistDetail

Campo Tipo Obligatorio Descripción
id string (uuid) sí
group_id string (uuid) sí
created_by string (uuid) | null sí
name string sí
repeat_mode string sí
track_count integer sí
created_at string (date-time) sí
updated_at string (date-time) sí
tracks array of app__modules__playlists__schemas__TrackOut sí

Ejemplo

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

Patch Playlist

Parámetros

Nombre En Tipo Obligatorio Descripción
playlist_id path string (uuid) sí

Cuerpo · PlaylistPatch

Campo Tipo Obligatorio Descripción
name string | null
repeat_mode “off” | “all” | “one” | null

Devuelve 200 · PlaylistDetail

Campo Tipo Obligatorio Descripción
id string (uuid) sí
group_id string (uuid) sí
created_by string (uuid) | null sí
name string sí
repeat_mode string sí
track_count integer sí
created_at string (date-time) sí
updated_at string (date-time) sí
tracks array of app__modules__playlists__schemas__TrackOut sí

Ejemplo

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

Delete Playlist

Parámetros

Nombre En Tipo Obligatorio Descripción
playlist_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

List Tracks

Parámetros

Nombre En Tipo Obligatorio Descripción
playlist_id path string (uuid) sí

Devuelve 200 · array of app__modules__playlists__schemas__TrackOut

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/playlists/{playlist_id}/tracks" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Add Tracks

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

Parámetros

Nombre En Tipo Obligatorio Descripción
playlist_id path string (uuid) sí

Cuerpo · TracksIn

Campo Tipo Obligatorio Descripción
tracks array of TrackIn sí

Devuelve 201 · array of app__modules__playlists__schemas__TrackOut

Ejemplo

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

Reorder Tracks

Parámetros

Nombre En Tipo Obligatorio Descripción
playlist_id path string (uuid) sí

Cuerpo · ReorderIn

Campo Tipo Obligatorio Descripción
order array of string (uuid) sí

Devuelve 200 · array of app__modules__playlists__schemas__TrackOut

Ejemplo

Ventana de terminal
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}

Sección titulada «DELETE /api/v1/playlists/{playlist_id}/tracks/{track_id}»

Remove Track

Parámetros

Nombre En Tipo Obligatorio Descripción
playlist_id path string (uuid) sí
track_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

Stream File

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí
quality query “low” | “medium” | “high” | null Profile chosen by the player when the preference is auto.

Ejemplo

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

Stream File Url

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí
quality query “low” | “medium” | “high” | null Profile chosen by the player when the preference is auto.

Devuelve 200 · StreamUrlOut

Campo Tipo Obligatorio Descripción
url string sí
expires_in integer sí
quality string | null

Ejemplo

Ventana de terminal
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

Sección titulada «GET /api/v1/files/{file_id}/stems/{stem_name}/stream»

Stream Stem

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí
stem_name path string sí

Ejemplo

Ventana de terminal
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

Sección titulada «GET /api/v1/files/{file_id}/stems/{stem_name}/stream-url»

Stream Stem Url

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí
stem_name path string sí

Devuelve 200 · StreamUrlOut

Campo Tipo Obligatorio Descripción
url string sí
expires_in integer sí
quality string | null

Ejemplo

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

Presign Take

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · TakePresignIn

Campo Tipo Obligatorio Descripción
content_type “audio/wav” | “audio/x-wav” | “audio/wave”
size integer sí

Devuelve 200 · TakePresignOut

Campo Tipo Obligatorio Descripción
upload_url string sí
key string sí
take_id string (uuid) sí

Ejemplo

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

Confirm Take

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · TakeConfirmIn

Campo Tipo Obligatorio Descripción
take_id string (uuid) sí
key string sí
name string | null
duration number sí
offset_ms integer
latency_ms integer
sample_rate integer sí
speed number
pitch_tones number

Devuelve 201 · TakeOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
audio_file_id string (uuid) sí
group_id string (uuid) sí
created_by string (uuid) sí
author_name string sí
mine boolean sí
name string sí
status string sí
duration number sí
offset_ms integer sí
latency_ms integer sí
sample_rate integer sí
speed number sí
pitch_tones number sí
file_size integer sí
shared boolean sí
created_at string (date-time) sí
updated_at string (date-time) sí

Ejemplo

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

List Takes

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

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Devuelve 200 · array of TakeOut

Ejemplo

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

Get Take

Parámetros

Nombre En Tipo Obligatorio Descripción
take_id path string (uuid) sí

Devuelve 200 · TakeOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
audio_file_id string (uuid) sí
group_id string (uuid) sí
created_by string (uuid) sí
author_name string sí
mine boolean sí
name string sí
status string sí
duration number sí
offset_ms integer sí
latency_ms integer sí
sample_rate integer sí
speed number sí
pitch_tones number sí
file_size integer sí
shared boolean sí
created_at string (date-time) sí
updated_at string (date-time) sí

Ejemplo

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

Update Take

Author only.

Parámetros

Nombre En Tipo Obligatorio Descripción
take_id path string (uuid) sí

Cuerpo · TakePatch

Campo Tipo Obligatorio Descripción
name string | null
shared boolean | null
offset_ms integer | null

Devuelve 200 · TakeOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
audio_file_id string (uuid) sí
group_id string (uuid) sí
created_by string (uuid) sí
author_name string sí
mine boolean sí
name string sí
status string sí
duration number sí
offset_ms integer sí
latency_ms integer sí
sample_rate integer sí
speed number sí
pitch_tones number sí
file_size integer sí
shared boolean sí
created_at string (date-time) sí
updated_at string (date-time) sí

Ejemplo

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

Delete Take

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

Parámetros

Nombre En Tipo Obligatorio Descripción
take_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

Take Stream Url

Parámetros

Nombre En Tipo Obligatorio Descripción
take_id path string (uuid) sí

Devuelve 200 · TakeStreamUrlOut

Campo Tipo Obligatorio Descripción
url string sí
expires_in integer sí

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/takes/{take_id}/stream-url" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Tuner Catalog

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

Devuelve 200 · object

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/tools/tuner/catalog" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Metronome Catalog

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

Devuelve 200 · object

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/tools/metronome/catalog" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

GET /api/v1/groups/{group_id}/metronome-presets

Sección titulada «GET /api/v1/groups/{group_id}/metronome-presets»

List Presets

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Devuelve 200 · array of MetronomePresetOut

Ejemplo

Ventana de terminal
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

Sección titulada «POST /api/v1/groups/{group_id}/metronome-presets»

Create Preset

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Cuerpo · MetronomePresetIn

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

Devuelve 201 · MetronomePresetOut

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

Ejemplo

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

Get Preset

Parámetros

Nombre En Tipo Obligatorio Descripción
preset_id path string (uuid) sí

Devuelve 200 · MetronomePresetOut

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

Ejemplo

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

Patch Preset

Parámetros

Nombre En Tipo Obligatorio Descripción
preset_id path string (uuid) sí

Cuerpo · MetronomePresetPatch

Campo Tipo Obligatorio Descripción
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

Devuelve 200 · MetronomePresetOut

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

Ejemplo

Ventana de terminal
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}

Sección titulada «DELETE /api/v1/metronome-presets/{preset_id}»

Delete Preset

Parámetros

Nombre En Tipo Obligatorio Descripción
preset_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

Ventana de terminal
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

Sección titulada «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).

Parámetros

Nombre En Tipo Obligatorio Descripción
preset_id path string (uuid) sí

Devuelve 202 · app__modules__tools__schemas__JobOut

Campo Tipo Obligatorio Descripción
status string sí
job_id string sí
audio_id string (uuid) | null

Ejemplo

Ventana de terminal
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

Sección titulada «POST /api/v1/metronome-presets/{preset_id}/render»

Render

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

Parámetros

Nombre En Tipo Obligatorio Descripción
preset_id path string (uuid) sí

Cuerpo · RenderIn

Campo Tipo Obligatorio Descripción
bars integer

Devuelve 202 · app__modules__tools__schemas__JobOut

Campo Tipo Obligatorio Descripción
status string sí
job_id string sí
audio_id string (uuid) | null

Ejemplo

Ventana de terminal
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

Sección titulada «GET /api/v1/groups/{group_id}/tuner-profiles»

List Tunings

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Devuelve 200 · array of TunerProfileOut

Ejemplo

Ventana de terminal
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

Sección titulada «POST /api/v1/groups/{group_id}/tuner-profiles»

Create Tuning

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Cuerpo · TunerProfileIn

Campo Tipo Obligatorio Descripción
instrument string sí
name string sí
strings array of string sí
reference_hz number
temperament string
tonic integer

Devuelve 201 · TunerProfileOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
group_id string (uuid) sí
created_by string (uuid) | null sí
instrument string sí
name string sí
strings array of string sí
reference_hz number sí
temperament string sí
tonic integer sí
created_at string (date-time) sí
updated_at string (date-time) sí

Ejemplo

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

Patch Tuning

Parámetros

Nombre En Tipo Obligatorio Descripción
tuning_id path string (uuid) sí

Cuerpo · TunerProfilePatch

Campo Tipo Obligatorio Descripción
instrument string | null
name string | null
strings array of string | null
reference_hz number | null
temperament string | null
tonic integer | null

Devuelve 200 · TunerProfileOut

Campo Tipo Obligatorio Descripción
id string (uuid) sí
group_id string (uuid) sí
created_by string (uuid) | null sí
instrument string sí
name string sí
strings array of string sí
reference_hz number sí
temperament string sí
tonic integer sí
created_at string (date-time) sí
updated_at string (date-time) sí

Ejemplo

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

Delete Tuning

Parámetros

Nombre En Tipo Obligatorio Descripción
tuning_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

Ventana de terminal
curl -X DELETE "$JAMCLOUD_API/api/v1/tuner-profiles/{tuning_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Update Metadata

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

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí

Cuerpo · MetadataIn

Campo Tipo Obligatorio Descripción
tags object sí

Devuelve 202 · MetadataJobOut

Campo Tipo Obligatorio Descripción
status string
job_id string sí
transformation_id string (uuid) sí

Ejemplo

Ventana de terminal
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}

Sección titulada «POST /api/v1/files/{file_id}/transformations/{process}»

Trigger

Parámetros

Nombre En Tipo Obligatorio Descripción
file_id path string (uuid) sí
process path string sí

Cuerpo · TriggerIn | null

Devuelve 202 · TriggerOut

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

Ejemplo

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

Separation Models

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

Devuelve 200 · array of SeparationModelOut

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/separation-models" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

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

Sección titulada «POST /api/v1/groups/{group_id}/files/batch-metadata»

Batch Metadata

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

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Cuerpo · BatchMetadataIn

Campo Tipo Obligatorio Descripción
file_ids array of string (uuid) sí
tags object sí

Devuelve 202 · BatchMetadataOut

Campo Tipo Obligatorio Descripción
jobs array of BatchJob sí

Ejemplo

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

Job Status

Parámetros

Nombre En Tipo Obligatorio Descripción
job_id path string sí

Devuelve 200 · app__modules__transformer__schemas__JobOut

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

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/jobs/{job_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Cancel Job

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

Parámetros

Nombre En Tipo Obligatorio Descripción
job_id path string sí

Devuelve 204 · sin contenido

Ejemplo

Ventana de terminal
curl -X DELETE "$JAMCLOUD_API/api/v1/jobs/{job_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Job Events

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

Parámetros

Nombre En Tipo Obligatorio Descripción
job_id path string sí

Devuelve 200 · object

Ejemplo

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

DELETE /api/v1/transformations/{transformation_id}

Sección titulada «DELETE /api/v1/transformations/{transformation_id}»

Delete Transformation

Parámetros

Nombre En Tipo Obligatorio Descripción
transformation_id path string (uuid) sí

Devuelve 204 · sin contenido

Ejemplo

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

My Workspaces

Devuelve 200 · array of WorkspaceOut

Ejemplo

Ventana de terminal
curl -X GET "$JAMCLOUD_API/api/v1/groups" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Workspace

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Devuelve 200 · WorkspaceOut

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

Ejemplo

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

Get Settings

Parámetros

Nombre En Tipo Obligatorio Descripción
group_id path string (uuid) sí

Devuelve 200 · WorkspaceSettingsOut

Campo Tipo Obligatorio Descripción
boards_viewers_can_write boolean

Ejemplo

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