Pular para o conteúdo

Referência da API

A referência para desenvolvedores: o que cada rota espera e retorna. Para obter uma chave e ver o que ela alcança, leia primeiro API.

A versão está em cada caminho: /api/v1. Na versão 1, rotas e campos só são adicionados, nunca renomeados ou removidos: ignore os campos que você não conhece. Uma mudança que quebraria seu código chega como uma nova versão (/api/v2), com a v1 ainda funcionando ao lado.

Guarde o endereço da API e sua chave em variáveis de ambiente e chame-a com qualquer cliente HTTP: não há SDK para instalar.

Janela do 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 na entrada e na saída, campos em snake_case, ids são UUIDs.
  • Listas respondem {items, total, limit, offset}; pagine com os parâmetros limit e offset.
  • Erros são problem+json {type, title, status, code, details}: teste code, ele nunca muda.
  • Um envio leva três chamadas: presign, PUT do arquivo na URL retornada e confirm. A URL vale 15 minutos e aceita exatamente o size declarado, em um único PUT.
  • 503 circuit_open: aguarde os segundos de Retry-After e tente de novo.

Cada seção abaixo é um recurso; cada rota traz seus parâmetros, campos, resposta e um exemplo curl.

Versão da API: v1 · cada rota abaixo começa com /api/v1

List Boards

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

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim
limit query integer
offset query integer

Retorna 200 · Page_BoardOut_

Campo Tipo Obrigatório Descrição
items array of BoardOut sim
total integer sim
limit integer sim
offset integer sim

Exemplo

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

Create Board

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Corpo · BoardIn

Campo Tipo Obrigatório Descrição
title string sim

Retorna 201 · BoardDetail

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
file_id string (uuid) | null sim
created_by string (uuid) | null sim
title string sim
version integer sim
item_count integer sim
can_write boolean sim
created_at string (date-time) sim
updated_at string (date-time) sim
items array of BoardItemOut sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 200 · BoardDetail

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
file_id string (uuid) | null sim
created_by string (uuid) | null sim
title string sim
version integer sim
item_count integer sim
can_write boolean sim
created_at string (date-time) sim
updated_at string (date-time) sim
items array of BoardItemOut sim

Exemplo

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

Get Board

Parâmetros

Nome Em Tipo Obrigatório Descrição
board_id path string (uuid) sim

Retorna 200 · BoardDetail

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
file_id string (uuid) | null sim
created_by string (uuid) | null sim
title string sim
version integer sim
item_count integer sim
can_write boolean sim
created_at string (date-time) sim
updated_at string (date-time) sim
items array of BoardItemOut sim

Exemplo

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

Rename Board

Parâmetros

Nome Em Tipo Obrigatório Descrição
board_id path string (uuid) sim

Corpo · BoardPatch

Campo Tipo Obrigatório Descrição
title string sim

Retorna 200 · BoardOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
file_id string (uuid) | null sim
created_by string (uuid) | null sim
title string sim
version integer sim
item_count integer sim
can_write boolean sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
board_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
board_id path string (uuid) sim

Corpo · OpsIn

Campo Tipo Obrigatório Descrição
client_id string sim
ops array of UpsertOp | DeleteOp | ClearOp sim

Retorna 200 · OpsOut

Campo Tipo Obrigatório Descrição
version integer sim
items array of ItemRev sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 200 · ChartOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
file_id string (uuid) sim
content object sim
anchor_bar integer sim
source string sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

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

Put Chart

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · ChartIn

Campo Tipo Obrigatório Descrição
content ChartContent sim
anchor_bar integer
source “manual” | “import”

Retorna 200 · ChartOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
file_id string (uuid) sim
content object sim
anchor_bar integer sim
source string sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

Get Score

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 200 · ScoreOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
file_id string (uuid) sim
status “processing” | “ready” | “failed” sim
format “guitarpro” | “musicxml” | null sim
source_format string sim
original_filename string sim
title string sim
anchor_bar integer sim
settings object sim
error_code string | null sim
error_message string | null sim
url string | null sim
original_url string sim
revision integer sim
edited_at string (date-time) | null sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 201 · ScoreOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
file_id string (uuid) sim
status “processing” | “ready” | “failed” sim
format “guitarpro” | “musicxml” | null sim
source_format string sim
original_filename string sim
title string sim
anchor_bar integer sim
settings object sim
error_code string | null sim
error_message string | null sim
url string | null sim
original_url string sim
revision integer sim
edited_at string (date-time) | null sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

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

Patch Score

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · ScorePatch

Campo Tipo Obrigatório Descrição
anchor_bar integer | null
settings object | null

Retorna 200 · ScoreOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
file_id string (uuid) sim
status “processing” | “ready” | “failed” sim
format “guitarpro” | “musicxml” | null sim
source_format string sim
original_filename string sim
title string sim
anchor_bar integer sim
settings object sim
error_code string | null sim
error_message string | null sim
url string | null sim
original_url string sim
revision integer sim
edited_at string (date-time) | null sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 200 · ScoreOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
file_id string (uuid) sim
status “processing” | “ready” | “failed” sim
format “guitarpro” | “musicxml” | null sim
source_format string sim
original_filename string sim
title string sim
anchor_bar integer sim
settings object sim
error_code string | null sim
error_message string | null sim
url string | null sim
original_url string sim
revision integer sim
edited_at string (date-time) | null sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

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

Export File

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · ExportIn

Campo Tipo Obrigatório Descrição
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

Retorna 202 · ExportJobOut

Campo Tipo Obrigatório Descrição
job_id string sim
file_id string | null
status “queued” | “processing” | “ready” | “failed” sim
filename string | null
url string | null
expires_in integer | null
code string | null

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
job_id path string (uuid) sim

Retorna 200 · ExportJobOut

Campo Tipo Obrigatório Descrição
job_id string sim
file_id string | null
status “queued” | “processing” | “ready” | “failed” sim
filename string | null
url string | null
expires_in integer | null
code string | null

Exemplo

Janela do 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.

Corpo · FeedbackIn

Campo Tipo Obrigatório Descrição
category “bug” | “idea” | “question” | “other” sim
message string sim
group_id string | null The workspace open in the app.
context FeedbackContext

Retorna 201 · FeedbackOut

Campo Tipo Obrigatório Descrição
id string sim
category “bug” | “idea” | “question” | “other” sim
status “new” | “done” sim
created_at string (date-time) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Retorna 200 · array of DirectoryOut

Exemplo

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

Create Directory

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Corpo · DirectoryIn

Campo Tipo Obrigatório Descrição
name string sim

Retorna 200 · object

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
directory_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

List Files

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim
tags query array of string
favorite query boolean | null
search query string
directory_id query string (uuid) | null
limit query integer
offset query integer

Retorna 200 · Page_FileSummary_

Campo Tipo Obrigatório Descrição
items array of FileSummary sim
total integer sim
limit integer sim
offset integer sim

Exemplo

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

Recent Files

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Retorna 200 · array of FileSummary

Exemplo

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

Group Tags

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Retorna 200 · TagsOut

Campo Tipo Obrigatório Descrição
tags array of string sim

Exemplo

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

Batch Delete

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Corpo · BatchIds

Campo Tipo Obrigatório Descrição
file_ids array of string (uuid) sim

Retorna 200 · BatchDeleteOut

Campo Tipo Obrigatório Descrição
deleted integer sim

Exemplo

Janela do 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>"]}'

Batch Move

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

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Corpo · BatchMoveIn

Campo Tipo Obrigatório Descrição
file_ids array of string (uuid) sim
target_group_id string (uuid) sim

Retorna 200 · BatchMoveOut

Campo Tipo Obrigatório Descrição
moved integer sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
tags query array of string
favorite query boolean | null
search query string
limit query integer
offset query integer

Retorna 200 · Page_FileSummary_

Campo Tipo Obrigatório Descrição
items array of FileSummary sim
total integer sim
limit integer sim
offset integer sim

Exemplo

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

Recent All Files

Retorna 200 · array of FileSummary

Exemplo

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

All Tags

Retorna 200 · TagsOut

Campo Tipo Obrigatório Descrição
tags array of string sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim
play query boolean

Retorna 200 · FileOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
title string sim
description string sim
favorite boolean sim
tags array of string sim
file_size integer sim
total_stems_usage integer sim
uploaded_at string (date-time) sim
last_played_at string (date-time) | null sim
play_count integer sim
directory DirectoryRef | null sim
normalized_metadata object sim
has_cover_art boolean sim
cover_image_url string | null sim
stems array of StemOut sim
analyze TransformationOut | null sim
metadata TransformationOut | null sim
separation TransformationOut | null sim
ml_analysis TransformationOut | null sim
mapping TransformationOut | null
queued_separation TransformationOut | null
parent_id string (uuid) | null
clip ClipOut | null

Exemplo

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

Patch File

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · FilePatch

Campo Tipo Obrigatório Descrição
title string | null
description string | null
favorite boolean | null
tags array of string | null
directory_id string (uuid) | null
parent_id null

Retorna 200 · FileOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
title string sim
description string sim
favorite boolean sim
tags array of string sim
file_size integer sim
total_stems_usage integer sim
uploaded_at string (date-time) sim
last_played_at string (date-time) | null sim
play_count integer sim
directory DirectoryRef | null sim
normalized_metadata object sim
has_cover_art boolean sim
cover_image_url string | null sim
stems array of StemOut sim
analyze TransformationOut | null sim
metadata TransformationOut | null sim
separation TransformationOut | null sim
ml_analysis TransformationOut | null sim
mapping TransformationOut | null
queued_separation TransformationOut | null
parent_id string (uuid) | null
clip ClipOut | null

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · ExtractIn

Campo Tipo Obrigatório Descrição
start number sim
end number sim
title string | null

Retorna 202 · ExtractOut

Campo Tipo Obrigatório Descrição
status string sim
job_id string sim
audio_id string (uuid) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · FavoriteIn

Campo Tipo Obrigatório Descrição
favorite boolean sim

Retorna 200 · FileSummary

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
favorite boolean sim
title string sim
description string sim
tags array of string sim
size integer sim
stems_usage integer sim
uploaded_at string (date-time) sim
last_played_at string (date-time) | null sim
directory DirectoryRef | null sim
has_cover_art boolean sim
parent_id string (uuid) | null
clip ClipOut | null
processes object
queue object
bpm number | null
key string | null

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 200 · TagsOut

Campo Tipo Obrigatório Descrição
tags array of string sim

Exemplo

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

Add Tags

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · TagsIn

Campo Tipo Obrigatório Descrição
tags array of string sim

Retorna 200 · TagsOut

Campo Tipo Obrigatório Descrição
tags array of string sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim
tag path string sim

Retorna 200 · TagsOut

Campo Tipo Obrigatório Descrição
tags array of string sim

Exemplo

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

Get Metadata

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 200 · MetadataOut

Campo Tipo Obrigatório Descrição
normalized object sim
has_cover_art boolean sim
cover_image_url string | null sim
technical object | null sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 200 · StatusOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
transformations object sim

Exemplo

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

Delete All Stems

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

Delete Stem

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim
stem_name path string sim

Retorna 204 · sem conteúdo

Exemplo

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

List Families

Parâmetros

Nome Em Tipo Obrigatório Descrição
search query string | null
ordering query string | null
limit query integer
offset query integer

Retorna 200 · Page_FamilyOut_

Campo Tipo Obrigatório Descrição
items array of FamilyOut sim
total integer sim
limit integer sim
offset integer sim

Exemplo

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

Create Families

Corpo · FamilyIn

Campo Tipo Obrigatório Descrição
name string sim
description string

Retorna 201 · FamilyOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
name string sim
description string sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 200 · FamilyOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
name string sim
description string sim

Exemplo

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

Patch Families

Parâmetros

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Corpo · FamilyPatch

Campo Tipo Obrigatório Descrição
name string | null
description string | null

Retorna 200 · FamilyOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
name string sim
description string sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

List Qualities

Parâmetros

Nome Em Tipo Obrigatório Descrição
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Retorna 200 · Page_QualityOut_

Campo Tipo Obrigatório Descrição
items array of QualityOut sim
total integer sim
limit integer sim
offset integer sim

Exemplo

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

Create Quality

Corpo · QualityIn

Campo Tipo Obrigatório Descrição
key string sim
family_id string (uuid) sim
formula array of integer sim
description string

Retorna 201 · QualityOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
key string sim
family string sim
family_id string (uuid) sim
formula array of integer sim
aliases array of AliasOut sim
description string sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
key path string sim

Retorna 200 · QualityOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
key string sim
family string sim
family_id string (uuid) sim
formula array of integer sim
aliases array of AliasOut sim
description string sim

Exemplo

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

Patch Quality

Parâmetros

Nome Em Tipo Obrigatório Descrição
key path string sim

Corpo · QualityPatch

Campo Tipo Obrigatório Descrição
key string | null
family_id string (uuid) | null
formula array of integer | null
description string | null

Retorna 200 · QualityOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
key string sim
family string sim
family_id string (uuid) sim
formula array of integer sim
aliases array of AliasOut sim
description string sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
key path string sim

Retorna 204 · sem conteúdo

Exemplo

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

List Aliases

Parâmetros

Nome Em Tipo Obrigatório Descrição
quality query string (uuid) | null
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Retorna 200 · Page_AliasOut_

Campo Tipo Obrigatório Descrição
items array of AliasOut sim
total integer sim
limit integer sim
offset integer sim

Exemplo

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

Create Aliases

Corpo · AliasIn

Campo Tipo Obrigatório Descrição
quality_id string (uuid) sim
alias string sim
is_preferred boolean

Retorna 201 · AliasOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
quality_id string (uuid) sim
alias string sim
is_preferred boolean sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 200 · AliasOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
quality_id string (uuid) sim
alias string sim
is_preferred boolean sim

Exemplo

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

Patch Aliases

Parâmetros

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Corpo · AliasPatch

Campo Tipo Obrigatório Descrição
quality_id string (uuid) | null
alias string | null
is_preferred boolean | null

Retorna 200 · AliasOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
quality_id string (uuid) sim
alias string sim
is_preferred boolean sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

List Types

Parâmetros

Nome Em Tipo Obrigatório Descrição
quality query string (uuid) | null
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Retorna 200 · Page_ChordTypeOut_

Campo Tipo Obrigatório Descrição
items array of ChordTypeOut sim
total integer sim
limit integer sim
offset integer sim

Exemplo

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

Create Types

Corpo · ChordTypeIn

Campo Tipo Obrigatório Descrição
label string sim
description string
quality_id string (uuid) | null

Retorna 201 · ChordTypeOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
label string sim
description string sim
quality_id string (uuid) | null sim
quality_key string | null sim
family string | null sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 200 · ChordTypeOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
label string sim
description string sim
quality_id string (uuid) | null sim
quality_key string | null sim
family string | null sim

Exemplo

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

Patch Types

Parâmetros

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Corpo · ChordTypePatch

Campo Tipo Obrigatório Descrição
label string | null
description string | null
quality_id string (uuid) | null

Retorna 200 · ChordTypeOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
label string sim
description string sim
quality_id string (uuid) | null sim
quality_key string | null sim
family string | null sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

List Instruments

Parâmetros

Nome Em Tipo Obrigatório Descrição
search query string | null
ordering query string | null
limit query integer
offset query integer

Retorna 200 · Page_InstrumentOut_

Campo Tipo Obrigatório Descrição
items array of InstrumentOut sim
total integer sim
limit integer sim
offset integer sim

Exemplo

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

Create Instruments

Corpo · InstrumentIn

Campo Tipo Obrigatório Descrição
name string sim
string_count integer

Retorna 201 · InstrumentOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
name string sim
string_count integer sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 200 · InstrumentOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
name string sim
string_count integer sim

Exemplo

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

Patch Instruments

Parâmetros

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Corpo · InstrumentPatch

Campo Tipo Obrigatório Descrição
name string | null
string_count integer | null

Retorna 200 · InstrumentOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
name string sim
string_count integer sim

Exemplo

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

Delete Instruments

Parâmetros

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

List Tunings

Parâmetros

Nome Em Tipo Obrigatório Descrição
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

Retorna 200 · Page_TuningOut_

Campo Tipo Obrigatório Descrição
items array of TuningOut sim
total integer sim
limit integer sim
offset integer sim

Exemplo

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

Create Tunings

Corpo · TuningIn

Campo Tipo Obrigatório Descrição
instrument_id string (uuid) sim
name string sim
open_strings array of string sim
is_default boolean

Retorna 201 · TuningOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
instrument InstrumentOut sim
name string sim
open_strings array of string sim
is_default boolean sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 200 · TuningOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
instrument InstrumentOut sim
name string sim
open_strings array of string sim
is_default boolean sim

Exemplo

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

Patch Tunings

Parâmetros

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Corpo · TuningPatch

Campo Tipo Obrigatório Descrição
instrument_id string (uuid) | null
name string | null
open_strings array of string | null
is_default boolean | null

Retorna 200 · TuningOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
instrument InstrumentOut sim
name string sim
open_strings array of string sim
is_default boolean sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

List Voicing Tags

Parâmetros

Nome Em Tipo Obrigatório Descrição
search query string | null
ordering query string | null
limit query integer
offset query integer

Retorna 200 · Page_VoicingTagOut_

Campo Tipo Obrigatório Descrição
items array of VoicingTagOut sim
total integer sim
limit integer sim
offset integer sim

Exemplo

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

Create Voicing-Tags

Corpo · VoicingTagIn

Campo Tipo Obrigatório Descrição
name string sim

Retorna 201 · VoicingTagOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
name string sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 200 · VoicingTagOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
name string sim

Exemplo

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

Patch Voicing-Tags

Parâmetros

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Corpo · VoicingTagPatch

Campo Tipo Obrigatório Descrição
name string | null

Retorna 200 · VoicingTagOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
name string sim

Exemplo

Janela do 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 Voicing-Tags

Parâmetros

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

List Voicings

Parâmetros

Nome Em Tipo Obrigatório Descrição
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

Retorna 200 · Page_VoicingOut_

Campo Tipo Obrigatório Descrição
items array of VoicingOut sim
total integer sim
limit integer sim
offset integer sim

Exemplo

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

Create Voicing

Corpo · VoicingIn

Campo Tipo Obrigatório Descrição
entry_id string (uuid) sim
tuning_id string (uuid) sim
name string
source string
caged "" | “C” | “A” | “G” | “E” | “D”
frets array of integer sim
fingers array of integer | null
barres array of object
inversion integer
difficulty integer
tag_names array of string

Retorna 201 · VoicingOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
entry EntryLite sim
tuning TuningLite sim
name string sim
source string sim
caged string sim
frets array of integer sim
fingers array of integer | null sim
barres array of object sim
inversion integer sim
is_open boolean sim
fret_low integer sim
fret_high integer sim
difficulty integer sim
tags array of string sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
voicing_id path string (uuid) sim

Retorna 200 · VoicingOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
entry EntryLite sim
tuning TuningLite sim
name string sim
source string sim
caged string sim
frets array of integer sim
fingers array of integer | null sim
barres array of object sim
inversion integer sim
is_open boolean sim
fret_low integer sim
fret_high integer sim
difficulty integer sim
tags array of string sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

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

Patch Voicing

Parâmetros

Nome Em Tipo Obrigatório Descrição
voicing_id path string (uuid) sim

Corpo · VoicingPatch

Campo Tipo Obrigatório Descrição
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

Retorna 200 · VoicingOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
entry EntryLite sim
tuning TuningLite sim
name string sim
source string sim
caged string sim
frets array of integer sim
fingers array of integer | null sim
barres array of object sim
inversion integer sim
is_open boolean sim
fret_low integer sim
fret_high integer sim
difficulty integer sim
tags array of string sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

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

Delete Voicing

Parâmetros

Nome Em Tipo Obrigatório Descrição
voicing_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

List References

Parâmetros

Nome Em Tipo Obrigatório Descrição
search query string | null
ordering query string | null
limit query integer
offset query integer

Retorna 200 · Page_ReferenceOut_

Campo Tipo Obrigatório Descrição
items array of ReferenceOut sim
total integer sim
limit integer sim
offset integer sim

Exemplo

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

Create References

Corpo · ReferenceIn

Campo Tipo Obrigatório Descrição
title string sim
author string
details string

Retorna 201 · ReferenceOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
title string sim
author string sim
details string sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 200 · ReferenceOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
title string sim
author string sim
details string sim

Exemplo

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

Patch References

Parâmetros

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Corpo · ReferencePatch

Campo Tipo Obrigatório Descrição
title string | null
author string | null
details string | null

Retorna 200 · ReferenceOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
title string sim
author string sim
details string sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

List Voicing References

Parâmetros

Nome Em Tipo Obrigatório Descrição
voicing query string (uuid) | null
source query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Retorna 200 · Page_VoicingReferenceOut_

Campo Tipo Obrigatório Descrição
items array of VoicingReferenceOut sim
total integer sim
limit integer sim
offset integer sim

Exemplo

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

Create Voicing-References

Corpo · VoicingReferenceIn

Campo Tipo Obrigatório Descrição
voicing_id string (uuid) sim
source_id string (uuid) sim
page string
figure string

Retorna 201 · VoicingReferenceOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
voicing_id string (uuid) sim
source ReferenceOut sim
page string sim
figure string sim

Exemplo

Janela do 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 Voicing-References

Parâmetros

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 200 · VoicingReferenceOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
voicing_id string (uuid) sim
source ReferenceOut sim
page string sim
figure string sim

Exemplo

Janela do 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}

Seção intitulada “PATCH /api/v1/harmony/voicing-references/{item_id}”

Patch Voicing-References

Parâmetros

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Corpo · VoicingReferencePatch

Campo Tipo Obrigatório Descrição
voicing_id string (uuid) | null
source_id string (uuid) | null
page string | null
figure string | null

Retorna 200 · VoicingReferenceOut

Campo Tipo Obrigatório Descrição
created_at string (date-time) sim
updated_at string (date-time) sim
id string (uuid) sim
voicing_id string (uuid) sim
source ReferenceOut sim
page string sim
figure string sim

Exemplo

Janela do 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}

Seção intitulada “DELETE /api/v1/harmony/voicing-references/{item_id}”

Delete Voicing-References

Parâmetros

Nome Em Tipo Obrigatório Descrição
item_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

List Entries

Parâmetros

Nome Em Tipo Obrigatório Descrição
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

Retorna 200 · Page_EntryOut_

Campo Tipo Obrigatório Descrição
items array of EntryOut sim
total integer sim
limit integer sim
offset integer sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
symbol query string

Retorna 200 · EntryOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
symbol string sim
root string sim
bass string sim
quality QualityOut sim
family string sim

Exemplo

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

Get Entry

Parâmetros

Nome Em Tipo Obrigatório Descrição
entry_id path string (uuid) sim

Retorna 200 · EntryOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
symbol string sim
root string sim
bass string sim
quality QualityOut sim
family string sim

Exemplo

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

Live

Retorna 200 · object

Exemplo

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

Ready

Retorna 200 · object

Exemplo

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

Presign Upload

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Corpo · PresignIn

Campo Tipo Obrigatório Descrição
filename string sim
content_type string sim
size integer sim

Retorna 200 · PresignOut

Campo Tipo Obrigatório Descrição
upload_url string sim
key string sim
audio_id string (uuid) sim

Exemplo

Janela do 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}'

Confirm Upload

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Corpo · app__modules__ingestion__schemas__ConfirmIn

Campo Tipo Obrigatório Descrição
key string sim
audio_id string (uuid) sim
directory_id string (uuid) | null

Retorna 201 · ConfirmOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
title string sim
description string sim
favorite boolean sim
tags array of string sim
file_size integer sim
total_stems_usage integer sim
uploaded_at string (date-time) sim
last_played_at string (date-time) | null sim
play_count integer sim
directory DirectoryRef | null sim
normalized_metadata object sim
has_cover_art boolean sim
cover_image_url string | null sim
stems array of StemOut sim
analyze TransformationOut | null sim
metadata TransformationOut | null sim
separation TransformationOut | null sim
ml_analysis TransformationOut | null sim
mapping TransformationOut | null
queued_separation TransformationOut | null
parent_id string (uuid) | null
clip ClipOut | null
auto_tasks object sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Corpo · IngestUrlIn

Campo Tipo Obrigatório Descrição
video_url string (uri) sim
format IngestFormat

Retorna 202 · IngestUrlOut

Campo Tipo Obrigatório Descrição
status string sim
job_id string sim
audio_id string (uuid) sim

Exemplo

Janela do 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

Retorna 200 · ConditionsOut

Campo Tipo Obrigatório Descrição
extensions array of string sim
max_file_size_mb integer sim

Exemplo

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

Get Lyrics

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 200 · LyricsOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
file_id string (uuid) sim
lines array of object sim
offset_ms integer sim
source string sim
source_ref string | null sim
synced boolean sim
updated_by string (uuid) | null sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

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

Put Lyrics

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · LyricsIn

Campo Tipo Obrigatório Descrição
lines array of LyricsLine sim
offset_ms integer
source “manual” | “file” | “lrclib”
source_ref string | null

Retorna 200 · LyricsOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
file_id string (uuid) sim
lines array of object sim
offset_ms integer sim
source string sim
source_ref string | null sim
synced boolean sim
updated_by string (uuid) | null sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim
track query string | null
artist query string | null
q query string | null

Retorna 200 · array of LyricsCandidate

Exemplo

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

List Sections

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim
section_type query string | null

Retorna 200 · array of SectionOut

Exemplo

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

Create Section

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · SectionIn

Campo Tipo Obrigatório Descrição
start number sim
end number | null
section_type string sim
observation string | null

Retorna 201 · SectionOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
file_id string (uuid) sim
start number sim
end number | null sim
label string sim
color string | null sim
section_type string sim
section_number integer sim
observation string | null sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
section_id path string (uuid) sim

Corpo · SectionPatch

Campo Tipo Obrigatório Descrição
start number | null
end number | null
section_type string | null
observation string | null

Retorna 200 · SectionOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
file_id string (uuid) sim
start number sim
end number | null sim
label string sim
color string | null sim
section_type string sim
section_number integer sim
observation string | null sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
section_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

List Marks

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 200 · array of MarkOut

Exemplo

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

Create Mark

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · MarkIn

Campo Tipo Obrigatório Descrição
start number sim
name string | null
observation string | null

Retorna 201 · MarkOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
file_id string (uuid) sim
start number sim
name string sim
observation string | null sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
mark_id path string (uuid) sim

Corpo · MarkPatch

Campo Tipo Obrigatório Descrição
start number | null
name string | null
observation string | null

Retorna 200 · MarkOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
file_id string (uuid) sim
start number sim
name string sim
observation string | null sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
mark_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

List Loops

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 200 · array of LoopOut

Exemplo

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

Create Loop

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · LoopIn

Campo Tipo Obrigatório Descrição
start number sim
end number | null
name string | null
observation string | null

Retorna 201 · LoopOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
file_id string (uuid) sim
start number sim
end number | null sim
name string sim
observation string | null sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
loop_id path string (uuid) sim

Corpo · LoopPatch

Campo Tipo Obrigatório Descrição
start number | null
end number | null
name string | null
observation string | null

Retorna 200 · LoopOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
file_id string (uuid) sim
start number sim
end number | null sim
name string sim
observation string | null sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
loop_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 200 · BeatsOut

Campo Tipo Obrigatório Descrição
id string (uuid) | null
beats array of object sim
meter array of MeterEntry sim
source string sim
beat_count integer sim
created_at string (date-time) | null
updated_at string (date-time) | null

Exemplo

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

Put Beats

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · BeatsIn

Campo Tipo Obrigatório Descrição
beats array of number sim
meter array of MeterEntry

Retorna 200 · BeatsOut

Campo Tipo Obrigatório Descrição
id string (uuid) | null
beats array of object sim
meter array of MeterEntry sim
source string sim
beat_count integer sim
created_at string (date-time) | null
updated_at string (date-time) | null

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Retorna 202 · ImportCreated

Campo Tipo Obrigatório Descrição
import_job_id string (uuid) sim
job_id string sim
status string sim

Exemplo

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

Import Status

Parâmetros

Nome Em Tipo Obrigatório Descrição
import_id path string (uuid) sim

Retorna 200 · app__modules__music_import__schemas__ImportJobOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
original_filename string sim
source_format string sim
status string sim
notation_id string (uuid) | null sim
error_message string sim
progress_percent integer sim
progress_message string sim
parser_logs object sim
created_at string (date-time) sim

Exemplo

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

Formats

Enabled import formats and their extensions.

Retorna 200 · array of FormatOut

Exemplo

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

List Notations

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim
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

Retorna 200 · Page_NotationSummary_

Campo Tipo Obrigatório Descrição
items array of NotationSummary sim
total integer sim
limit integer sim
offset integer sim

Exemplo

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

Create Notation

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Corpo · NotationIn

Campo Tipo Obrigatório Descrição
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)

Retorna 201 · NotationOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
title string sim
author string sim
audio_file_id string (uuid) | null sim
audio_file_title string sim
data object sim
format_version integer sim
source_format string sim
origin string sim
tempo integer sim
time_signature string sim
number_of_measures integer sim
start_time number | null sim
end_time number | null sim
repeat_sync boolean sim
sync_map object sim
favorite boolean sim
tags array of string sim
category_ids array of string (uuid) sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

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

Notation Tags

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Retorna 200 · TagsOut

Campo Tipo Obrigatório Descrição
tags array of string sim

Exemplo

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

Recent Notations

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Retorna 200 · array of NotationSummary

Exemplo

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

Get Notation

Parâmetros

Nome Em Tipo Obrigatório Descrição
notation_id path string (uuid) sim

Retorna 200 · NotationOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
title string sim
author string sim
audio_file_id string (uuid) | null sim
audio_file_title string sim
data object sim
format_version integer sim
source_format string sim
origin string sim
tempo integer sim
time_signature string sim
number_of_measures integer sim
start_time number | null sim
end_time number | null sim
repeat_sync boolean sim
sync_map object sim
favorite boolean sim
tags array of string sim
category_ids array of string (uuid) sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

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

Patch Notation

Parâmetros

Nome Em Tipo Obrigatório Descrição
notation_id path string (uuid) sim

Corpo · NotationPatch

Campo Tipo Obrigatório Descrição
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

Retorna 200 · NotationOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
title string sim
author string sim
audio_file_id string (uuid) | null sim
audio_file_title string sim
data object sim
format_version integer sim
source_format string sim
origin string sim
tempo integer sim
time_signature string sim
number_of_measures integer sim
start_time number | null sim
end_time number | null sim
repeat_sync boolean sim
sync_map object sim
favorite boolean sim
tags array of string sim
category_ids array of string (uuid) sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
notation_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

Set Favorite

Parâmetros

Nome Em Tipo Obrigatório Descrição
notation_id path string (uuid) sim

Corpo · FavoriteIn

Campo Tipo Obrigatório Descrição
favorite boolean sim

Retorna 200 · NotationOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
title string sim
author string sim
audio_file_id string (uuid) | null sim
audio_file_title string sim
data object sim
format_version integer sim
source_format string sim
origin string sim
tempo integer sim
time_signature string sim
number_of_measures integer sim
start_time number | null sim
end_time number | null sim
repeat_sync boolean sim
sync_map object sim
favorite boolean sim
tags array of string sim
category_ids array of string (uuid) sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

Janela do 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

Retorna 200 · array of CategoryOut

Exemplo

Janela do 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.

Retorna 200 · PlatformOut

Campo Tipo Obrigatório Descrição
payments_enabled boolean sim
site_show_signup boolean sim
site_hidden_pages array of string sim
site_announcement string sim
site_announcement_url string sim

Exemplo

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

List Playlists

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Retorna 200 · array of PlaylistOut

Exemplo

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

Create Playlist

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Corpo · PlaylistIn

Campo Tipo Obrigatório Descrição
name string sim
repeat_mode “off” | “all” | “one”

Retorna 201 · PlaylistDetail

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
name string sim
repeat_mode string sim
track_count integer sim
created_at string (date-time) sim
updated_at string (date-time) sim
tracks array of app__modules__playlists__schemas__TrackOut sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
playlist_id path string (uuid) sim

Retorna 200 · PlaylistDetail

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
name string sim
repeat_mode string sim
track_count integer sim
created_at string (date-time) sim
updated_at string (date-time) sim
tracks array of app__modules__playlists__schemas__TrackOut sim

Exemplo

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

Patch Playlist

Parâmetros

Nome Em Tipo Obrigatório Descrição
playlist_id path string (uuid) sim

Corpo · PlaylistPatch

Campo Tipo Obrigatório Descrição
name string | null
repeat_mode “off” | “all” | “one” | null

Retorna 200 · PlaylistDetail

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
name string sim
repeat_mode string sim
track_count integer sim
created_at string (date-time) sim
updated_at string (date-time) sim
tracks array of app__modules__playlists__schemas__TrackOut sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
playlist_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

List Tracks

Parâmetros

Nome Em Tipo Obrigatório Descrição
playlist_id path string (uuid) sim

Retorna 200 · array of app__modules__playlists__schemas__TrackOut

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
playlist_id path string (uuid) sim

Corpo · TracksIn

Campo Tipo Obrigatório Descrição
tracks array of TrackIn sim

Retorna 201 · array of app__modules__playlists__schemas__TrackOut

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
playlist_id path string (uuid) sim

Corpo · ReorderIn

Campo Tipo Obrigatório Descrição
order array of string (uuid) sim

Retorna 200 · array of app__modules__playlists__schemas__TrackOut

Exemplo

Janela do 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}

Seção intitulada “DELETE /api/v1/playlists/{playlist_id}/tracks/{track_id}”

Remove Track

Parâmetros

Nome Em Tipo Obrigatório Descrição
playlist_id path string (uuid) sim
track_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

Stream File

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim
quality query “low” | “medium” | “high” | null Profile chosen by the player when the preference is auto.

Exemplo

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

Stream File Url

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim
quality query “low” | “medium” | “high” | null Profile chosen by the player when the preference is auto.

Retorna 200 · StreamUrlOut

Campo Tipo Obrigatório Descrição
url string sim
expires_in integer sim
quality string | null

Exemplo

Janela do 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

Seção intitulada “GET /api/v1/files/{file_id}/stems/{stem_name}/stream”

Stream Stem

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim
stem_name path string sim

Exemplo

Janela do 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

Seção intitulada “GET /api/v1/files/{file_id}/stems/{stem_name}/stream-url”

Stream Stem Url

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim
stem_name path string sim

Retorna 200 · StreamUrlOut

Campo Tipo Obrigatório Descrição
url string sim
expires_in integer sim
quality string | null

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · TakePresignIn

Campo Tipo Obrigatório Descrição
content_type “audio/wav” | “audio/x-wav” | “audio/wave”
size integer sim

Retorna 200 · TakePresignOut

Campo Tipo Obrigatório Descrição
upload_url string sim
key string sim
take_id string (uuid) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · TakeConfirmIn

Campo Tipo Obrigatório Descrição
take_id string (uuid) sim
key string sim
name string | null
duration number sim
offset_ms integer
latency_ms integer
sample_rate integer sim
speed number
pitch_tones number

Retorna 201 · TakeOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
audio_file_id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) sim
author_name string sim
mine boolean sim
name string sim
status string sim
duration number sim
offset_ms integer sim
latency_ms integer sim
sample_rate integer sim
speed number sim
pitch_tones number sim
file_size integer sim
shared boolean sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Retorna 200 · array of TakeOut

Exemplo

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

Get Take

Parâmetros

Nome Em Tipo Obrigatório Descrição
take_id path string (uuid) sim

Retorna 200 · TakeOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
audio_file_id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) sim
author_name string sim
mine boolean sim
name string sim
status string sim
duration number sim
offset_ms integer sim
latency_ms integer sim
sample_rate integer sim
speed number sim
pitch_tones number sim
file_size integer sim
shared boolean sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

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

Update Take

Author only.

Parâmetros

Nome Em Tipo Obrigatório Descrição
take_id path string (uuid) sim

Corpo · TakePatch

Campo Tipo Obrigatório Descrição
name string | null
shared boolean | null
offset_ms integer | null

Retorna 200 · TakeOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
audio_file_id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) sim
author_name string sim
mine boolean sim
name string sim
status string sim
duration number sim
offset_ms integer sim
latency_ms integer sim
sample_rate integer sim
speed number sim
pitch_tones number sim
file_size integer sim
shared boolean sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
take_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

Take Stream Url

Parâmetros

Nome Em Tipo Obrigatório Descrição
take_id path string (uuid) sim

Retorna 200 · TakeStreamUrlOut

Campo Tipo Obrigatório Descrição
url string sim
expires_in integer sim

Exemplo

Janela do 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.

Retorna 200 · object

Exemplo

Janela do 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.

Retorna 200 · object

Exemplo

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

List Presets

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Retorna 200 · array of MetronomePresetOut

Exemplo

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

Create Preset

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Corpo · MetronomePresetIn

Campo Tipo Obrigatório Descrição
name string sim
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

Retorna 201 · MetronomePresetOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
name string sim
base_preset_id string | null sim
bpm number sim
numerator integer sim
denominator integer sim
subdivision string sim
bars integer sim
pattern string sim
swing_ratio number | null sim
voice string sim
layers array of object sim
audio_file_id string (uuid) | null sim
analysis object | null sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
preset_id path string (uuid) sim

Retorna 200 · MetronomePresetOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
name string sim
base_preset_id string | null sim
bpm number sim
numerator integer sim
denominator integer sim
subdivision string sim
bars integer sim
pattern string sim
swing_ratio number | null sim
voice string sim
layers array of object sim
audio_file_id string (uuid) | null sim
analysis object | null sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

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

Patch Preset

Parâmetros

Nome Em Tipo Obrigatório Descrição
preset_id path string (uuid) sim

Corpo · MetronomePresetPatch

Campo Tipo Obrigatório Descrição
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

Retorna 200 · MetronomePresetOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
name string sim
base_preset_id string | null sim
bpm number sim
numerator integer sim
denominator integer sim
subdivision string sim
bars integer sim
pattern string sim
swing_ratio number | null sim
voice string sim
layers array of object sim
audio_file_id string (uuid) | null sim
analysis object | null sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

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

Delete Preset

Parâmetros

Nome Em Tipo Obrigatório Descrição
preset_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

Janela do 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

Seção intitulada “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

Nome Em Tipo Obrigatório Descrição
preset_id path string (uuid) sim

Retorna 202 · app__modules__tools__schemas__JobOut

Campo Tipo Obrigatório Descrição
status string sim
job_id string sim
audio_id string (uuid) | null

Exemplo

Janela do terminal
curl -X POST "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}/analyze-audio" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Render

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

Parâmetros

Nome Em Tipo Obrigatório Descrição
preset_id path string (uuid) sim

Corpo · RenderIn

Campo Tipo Obrigatório Descrição
bars integer

Retorna 202 · app__modules__tools__schemas__JobOut

Campo Tipo Obrigatório Descrição
status string sim
job_id string sim
audio_id string (uuid) | null

Exemplo

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

List Tunings

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Retorna 200 · array of TunerProfileOut

Exemplo

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

Create Tuning

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Corpo · TunerProfileIn

Campo Tipo Obrigatório Descrição
instrument string sim
name string sim
strings array of string sim
reference_hz number
temperament string
tonic integer

Retorna 201 · TunerProfileOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
instrument string sim
name string sim
strings array of string sim
reference_hz number sim
temperament string sim
tonic integer sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
tuning_id path string (uuid) sim

Corpo · TunerProfilePatch

Campo Tipo Obrigatório Descrição
instrument string | null
name string | null
strings array of string | null
reference_hz number | null
temperament string | null
tonic integer | null

Retorna 200 · TunerProfileOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
group_id string (uuid) sim
created_by string (uuid) | null sim
instrument string sim
name string sim
strings array of string sim
reference_hz number sim
temperament string sim
tonic integer sim
created_at string (date-time) sim
updated_at string (date-time) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
tuning_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim

Corpo · MetadataIn

Campo Tipo Obrigatório Descrição
tags object sim

Retorna 202 · MetadataJobOut

Campo Tipo Obrigatório Descrição
status string
job_id string sim
transformation_id string (uuid) sim

Exemplo

Janela do 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}

Seção intitulada “POST /api/v1/files/{file_id}/transformations/{process}”

Trigger

Parâmetros

Nome Em Tipo Obrigatório Descrição
file_id path string (uuid) sim
process path string sim

Corpo · TriggerIn | null

Retorna 202 · TriggerOut

Campo Tipo Obrigatório Descrição
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 sim
job_id string sim
transformation_id string (uuid) sim

Exemplo

Janela do 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.

Retorna 200 · array of SeparationModelOut

Exemplo

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

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

Seção intitulada “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

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Corpo · BatchMetadataIn

Campo Tipo Obrigatório Descrição
file_ids array of string (uuid) sim
tags object sim

Retorna 202 · BatchMetadataOut

Campo Tipo Obrigatório Descrição
jobs array of BatchJob sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
job_id path string sim

Retorna 200 · app__modules__transformer__schemas__JobOut

Campo Tipo Obrigatório Descrição
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 sim
state string sim
status string sim
progress integer sim
ready boolean sim
successful boolean sim
transformation_id string (uuid) sim

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
job_id path string sim

Retorna 204 · sem conteúdo

Exemplo

Janela do 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

Nome Em Tipo Obrigatório Descrição
job_id path string sim

Retorna 200 · object

Exemplo

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

DELETE /api/v1/transformations/{transformation_id}

Seção intitulada “DELETE /api/v1/transformations/{transformation_id}”

Delete Transformation

Parâmetros

Nome Em Tipo Obrigatório Descrição
transformation_id path string (uuid) sim

Retorna 204 · sem conteúdo

Exemplo

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

My Workspaces

Retorna 200 · array of WorkspaceOut

Exemplo

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

Get Workspace

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Retorna 200 · WorkspaceOut

Campo Tipo Obrigatório Descrição
id string (uuid) sim
name string sim
kind string sim
my_role GroupRole sim
created_at string (date-time) sim
owner_id string (uuid) | null sim
member_count integer sim Members besides the owner.
members array of WorkspaceMemberOut sim
settings WorkspaceSettingsOut

Exemplo

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

Get Settings

Parâmetros

Nome Em Tipo Obrigatório Descrição
group_id path string (uuid) sim

Retorna 200 · WorkspaceSettingsOut

Campo Tipo Obrigatório Descrição
boards_viewers_can_write boolean

Exemplo

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