Перейти к содержимому

Справочник API

Справочник для разработчиков: что принимает и возвращает каждый маршрут. Как получить ключ и к чему он даёт доступ, сначала прочитайте в разделе API.

Версия указана в каждом пути: /api/v1. В пределах версии 1 маршруты и поля только добавляются, но не переименовываются и не удаляются: игнорируйте незнакомые поля. Изменение, которое сломало бы ваш код, выходит новой версией (/api/v2), а v1 продолжает работать рядом.

Храните адрес API и ключ в переменных окружения и вызывайте API любым HTTP-клиентом: устанавливать SDK не нужно.

Окно терминала
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 на входе и выходе, поля в snake_case, идентификаторы — UUID.
  • Списки возвращают {items, total, limit, offset}; листайте параметрами limit и offset.
  • Ошибки — problem+json {type, title, status, code, details}: проверяйте code, он не меняется.
  • Загрузка файла — три запроса: presign, PUT файла по полученному URL, затем confirm. URL действует 15 минут и принимает ровно заявленный size одним PUT.
  • 503 circuit_open: подождите столько секунд, сколько указано в Retry-After, и повторите.

Каждый раздел ниже — один ресурс; у каждого маршрута есть параметры, поля, ответ и пример curl.

Версия API: v1 · все маршруты ниже начинаются с /api/v1

List Boards

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

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да
limit query integer
offset query integer

Возвращает 200 · Page_BoardOut_

Поле Тип Обязательно Описание
items array of BoardOut да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/boards" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Board

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Тело · BoardIn

Поле Тип Обязательно Описание
title string да

Возвращает 201 · BoardDetail

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
file_id string (uuid) | null да
created_by string (uuid) | null да
title string да
version integer да
item_count integer да
can_write boolean да
created_at string (date-time) да
updated_at string (date-time) да
items array of BoardItemOut да

Пример

Окно терминала
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.

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 200 · BoardDetail

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
file_id string (uuid) | null да
created_by string (uuid) | null да
title string да
version integer да
item_count integer да
can_write boolean да
created_at string (date-time) да
updated_at string (date-time) да
items array of BoardItemOut да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/board" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Board

Параметры

Имя Где Тип Обязательно Описание
board_id path string (uuid) да

Возвращает 200 · BoardDetail

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
file_id string (uuid) | null да
created_by string (uuid) | null да
title string да
version integer да
item_count integer да
can_write boolean да
created_at string (date-time) да
updated_at string (date-time) да
items array of BoardItemOut да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/boards/{board_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Rename Board

Параметры

Имя Где Тип Обязательно Описание
board_id path string (uuid) да

Тело · BoardPatch

Поле Тип Обязательно Описание
title string да

Возвращает 200 · BoardOut

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
file_id string (uuid) | null да
created_by string (uuid) | null да
title string да
version integer да
item_count integer да
can_write boolean да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
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.

Параметры

Имя Где Тип Обязательно Описание
board_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
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"}).

Параметры

Имя Где Тип Обязательно Описание
board_id path string (uuid) да

Тело · OpsIn

Поле Тип Обязательно Описание
client_id string да
ops array of UpsertOp | DeleteOp | ClearOp да

Возвращает 200 · OpsOut

Поле Тип Обязательно Описание
version integer да
items array of ItemRev да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 200 · ChartOut

Поле Тип Обязательно Описание
id string (uuid) да
file_id string (uuid) да
content object да
anchor_bar integer да
source string да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/chart" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Put Chart

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · ChartIn

Поле Тип Обязательно Описание
content ChartContent да
anchor_bar integer
source “manual” | “import”

Возвращает 200 · ChartOut

Поле Тип Обязательно Описание
id string (uuid) да
file_id string (uuid) да
content object да
anchor_bar integer да
source string да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/chart" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Score

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 200 · ScoreOut

Поле Тип Обязательно Описание
id string (uuid) да
file_id string (uuid) да
status “processing” | “ready” | “failed” да
format “guitarpro” | “musicxml” | null да
source_format string да
original_filename string да
title string да
anchor_bar integer да
settings object да
error_code string | null да
error_message string | null да
url string | null да
original_url string да
revision integer да
edited_at string (date-time) | null да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
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).

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 201 · ScoreOut

Поле Тип Обязательно Описание
id string (uuid) да
file_id string (uuid) да
status “processing” | “ready” | “failed” да
format “guitarpro” | “musicxml” | null да
source_format string да
original_filename string да
title string да
anchor_bar integer да
settings object да
error_code string | null да
error_message string | null да
url string | null да
original_url string да
revision integer да
edited_at string (date-time) | null да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/score" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Score

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · ScorePatch

Поле Тип Обязательно Описание
anchor_bar integer | null
settings object | null

Возвращает 200 · ScoreOut

Поле Тип Обязательно Описание
id string (uuid) да
file_id string (uuid) да
status “processing” | “ready” | “failed” да
format “guitarpro” | “musicxml” | null да
source_format string да
original_filename string да
title string да
anchor_bar integer да
settings object да
error_code string | null да
error_message string | null да
url string | null да
original_url string да
revision integer да
edited_at string (date-time) | null да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/files/{file_id}/score" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Score

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
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).

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 200 · ScoreOut

Поле Тип Обязательно Описание
id string (uuid) да
file_id string (uuid) да
status “processing” | “ready” | “failed” да
format “guitarpro” | “musicxml” | null да
source_format string да
original_filename string да
title string да
anchor_bar integer да
settings object да
error_code string | null да
error_message string | null да
url string | null да
original_url string да
revision integer да
edited_at string (date-time) | null да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
curl -X PUT "$JAMCLOUD_API/api/v1/files/{file_id}/score/content" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Export File

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · ExportIn

Поле Тип Обязательно Описание
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

Возвращает 202 · ExportJobOut

Поле Тип Обязательно Описание
job_id string да
file_id string | null
status “queued” | “processing” | “ready” | “failed” да
filename string | null
url string | null
expires_in integer | null
code string | null

Пример

Окно терминала
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.

Параметры

Имя Где Тип Обязательно Описание
job_id path string (uuid) да

Возвращает 200 · ExportJobOut

Поле Тип Обязательно Описание
job_id string да
file_id string | null
status “queued” | “processing” | “ready” | “failed” да
filename string | null
url string | null
expires_in integer | null
code string | null

Пример

Окно терминала
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.

Тело · FeedbackIn

Поле Тип Обязательно Описание
category “bug” | “idea” | “question” | “other” да
message string да
group_id string | null The workspace open in the app.
context FeedbackContext

Возвращает 201 · FeedbackOut

Поле Тип Обязательно Описание
id string да
category “bug” | “idea” | “question” | “other” да
status “new” | “done” да
created_at string (date-time) да

Пример

Окно терминала
curl -X POST "$JAMCLOUD_API/api/v1/feedback" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"category":"bug","message":"…"}'

List Directories

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Возвращает 200 · array of DirectoryOut

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/directories" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Directory

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Тело · DirectoryIn

Поле Тип Обязательно Описание
name string да

Возвращает 200 · object

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
directory_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/directories/{directory_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Files

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да
tags query array of string
favorite query boolean | null
search query string
directory_id query string (uuid) | null
limit query integer
offset query integer

Возвращает 200 · Page_FileSummary_

Поле Тип Обязательно Описание
items array of FileSummary да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/files" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Recent Files

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Возвращает 200 · array of FileSummary

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/files/recent" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Group Tags

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Возвращает 200 · TagsOut

Поле Тип Обязательно Описание
tags array of string да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Batch Delete

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Тело · BatchIds

Поле Тип Обязательно Описание
file_ids array of string (uuid) да

Возвращает 200 · BatchDeleteOut

Поле Тип Обязательно Описание
deleted integer да

Пример

Окно терминала
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).

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Тело · BatchMoveIn

Поле Тип Обязательно Описание
file_ids array of string (uuid) да
target_group_id string (uuid) да

Возвращает 200 · BatchMoveOut

Поле Тип Обязательно Описание
moved integer да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
tags query array of string
favorite query boolean | null
search query string
limit query integer
offset query integer

Возвращает 200 · Page_FileSummary_

Поле Тип Обязательно Описание
items array of FileSummary да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Recent All Files

Возвращает 200 · array of FileSummary

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/recent" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

All Tags

Возвращает 200 · TagsOut

Поле Тип Обязательно Описание
tags array of string да

Пример

Окно терминала
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.

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да
play query boolean

Возвращает 200 · FileOut

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
title string да
description string да
favorite boolean да
tags array of string да
file_size integer да
total_stems_usage integer да
uploaded_at string (date-time) да
last_played_at string (date-time) | null да
play_count integer да
directory DirectoryRef | null да
normalized_metadata object да
has_cover_art boolean да
cover_image_url string | null да
stems array of StemOut да
analyze TransformationOut | null да
metadata TransformationOut | null да
separation TransformationOut | null да
ml_analysis TransformationOut | null да
mapping TransformationOut | null
queued_separation TransformationOut | null
parent_id string (uuid) | null
clip ClipOut | null

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch File

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · FilePatch

Поле Тип Обязательно Описание
title string | null
description string | null
favorite boolean | null
tags array of string | null
directory_id string (uuid) | null
parent_id null

Возвращает 200 · FileOut

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
title string да
description string да
favorite boolean да
tags array of string да
file_size integer да
total_stems_usage integer да
uploaded_at string (date-time) да
last_played_at string (date-time) | null да
play_count integer да
directory DirectoryRef | null да
normalized_metadata object да
has_cover_art boolean да
cover_image_url string | null да
stems array of StemOut да
analyze TransformationOut | null да
metadata TransformationOut | null да
separation TransformationOut | null да
ml_analysis TransformationOut | null да
mapping TransformationOut | null
queued_separation TransformationOut | null
parent_id string (uuid) | null
clip ClipOut | null

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/files/{file_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete File

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
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).

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · ExtractIn

Поле Тип Обязательно Описание
start number да
end number да
title string | null

Возвращает 202 · ExtractOut

Поле Тип Обязательно Описание
status string да
job_id string да
audio_id string (uuid) да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · FavoriteIn

Поле Тип Обязательно Описание
favorite boolean да

Возвращает 200 · FileSummary

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
favorite boolean да
title string да
description string да
tags array of string да
size integer да
stems_usage integer да
uploaded_at string (date-time) да
last_played_at string (date-time) | null да
directory DirectoryRef | null да
has_cover_art boolean да
parent_id string (uuid) | null
clip ClipOut | null
processes object
queue object
bpm number | null
key string | null

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 200 · TagsOut

Поле Тип Обязательно Описание
tags array of string да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Add Tags

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · TagsIn

Поле Тип Обязательно Описание
tags array of string да

Возвращает 200 · TagsOut

Поле Тип Обязательно Описание
tags array of string да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да
tag path string да

Возвращает 200 · TagsOut

Поле Тип Обязательно Описание
tags array of string да

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/tags/{tag}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Metadata

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 200 · MetadataOut

Поле Тип Обязательно Описание
normalized object да
has_cover_art boolean да
cover_image_url string | null да
technical object | null да

Пример

Окно терминала
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).

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 200 · StatusOut

Поле Тип Обязательно Описание
id string (uuid) да
transformations object да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/status" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Delete All Stems

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/stems" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Delete Stem

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да
stem_name path string да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/stems/{stem_name}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Families

Параметры

Имя Где Тип Обязательно Описание
search query string | null
ordering query string | null
limit query integer
offset query integer

Возвращает 200 · Page_FamilyOut_

Поле Тип Обязательно Описание
items array of FamilyOut да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/families" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Families

Тело · FamilyIn

Поле Тип Обязательно Описание
name string да
description string

Возвращает 201 · FamilyOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
name string да
description string да

Пример

Окно терминала
curl -X POST "$JAMCLOUD_API/api/v1/harmony/families" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"…"}'

Get Families

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 200 · FamilyOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
name string да
description string да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Families

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Тело · FamilyPatch

Поле Тип Обязательно Описание
name string | null
description string | null

Возвращает 200 · FamilyOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
name string да
description string да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Families

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Qualities

Параметры

Имя Где Тип Обязательно Описание
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Возвращает 200 · Page_QualityOut_

Поле Тип Обязательно Описание
items array of QualityOut да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/qualities" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Quality

Тело · QualityIn

Поле Тип Обязательно Описание
key string да
family_id string (uuid) да
formula array of integer да
description string

Возвращает 201 · QualityOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
key string да
family string да
family_id string (uuid) да
formula array of integer да
aliases array of AliasOut да
description string да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
key path string да

Возвращает 200 · QualityOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
key string да
family string да
family_id string (uuid) да
formula array of integer да
aliases array of AliasOut да
description string да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Quality

Параметры

Имя Где Тип Обязательно Описание
key path string да

Тело · QualityPatch

Поле Тип Обязательно Описание
key string | null
family_id string (uuid) | null
formula array of integer | null
description string | null

Возвращает 200 · QualityOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
key string да
family string да
family_id string (uuid) да
formula array of integer да
aliases array of AliasOut да
description string да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Quality

Параметры

Имя Где Тип Обязательно Описание
key path string да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Aliases

Параметры

Имя Где Тип Обязательно Описание
quality query string (uuid) | null
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Возвращает 200 · Page_AliasOut_

Поле Тип Обязательно Описание
items array of AliasOut да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/aliases" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Aliases

Тело · AliasIn

Поле Тип Обязательно Описание
quality_id string (uuid) да
alias string да
is_preferred boolean

Возвращает 201 · AliasOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
quality_id string (uuid) да
alias string да
is_preferred boolean да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 200 · AliasOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
quality_id string (uuid) да
alias string да
is_preferred boolean да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Aliases

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Тело · AliasPatch

Поле Тип Обязательно Описание
quality_id string (uuid) | null
alias string | null
is_preferred boolean | null

Возвращает 200 · AliasOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
quality_id string (uuid) да
alias string да
is_preferred boolean да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Aliases

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Types

Параметры

Имя Где Тип Обязательно Описание
quality query string (uuid) | null
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Возвращает 200 · Page_ChordTypeOut_

Поле Тип Обязательно Описание
items array of ChordTypeOut да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/types" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Types

Тело · ChordTypeIn

Поле Тип Обязательно Описание
label string да
description string
quality_id string (uuid) | null

Возвращает 201 · ChordTypeOut

Поле Тип Обязательно Описание
id string (uuid) да
label string да
description string да
quality_id string (uuid) | null да
quality_key string | null да
family string | null да

Пример

Окно терминала
curl -X POST "$JAMCLOUD_API/api/v1/harmony/types" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"label":"…"}'

Get Types

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 200 · ChordTypeOut

Поле Тип Обязательно Описание
id string (uuid) да
label string да
description string да
quality_id string (uuid) | null да
quality_key string | null да
family string | null да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Types

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Тело · ChordTypePatch

Поле Тип Обязательно Описание
label string | null
description string | null
quality_id string (uuid) | null

Возвращает 200 · ChordTypeOut

Поле Тип Обязательно Описание
id string (uuid) да
label string да
description string да
quality_id string (uuid) | null да
quality_key string | null да
family string | null да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Types

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Instruments

Параметры

Имя Где Тип Обязательно Описание
search query string | null
ordering query string | null
limit query integer
offset query integer

Возвращает 200 · Page_InstrumentOut_

Поле Тип Обязательно Описание
items array of InstrumentOut да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/instruments" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Instruments

Тело · InstrumentIn

Поле Тип Обязательно Описание
name string да
string_count integer

Возвращает 201 · InstrumentOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
name string да
string_count integer да

Пример

Окно терминала
curl -X POST "$JAMCLOUD_API/api/v1/harmony/instruments" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"…"}'

Get Instruments

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 200 · InstrumentOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
name string да
string_count integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/instruments/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Instruments

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Тело · InstrumentPatch

Поле Тип Обязательно Описание
name string | null
string_count integer | null

Возвращает 200 · InstrumentOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
name string да
string_count integer да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/instruments/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Instruments

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/instruments/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Tunings

Параметры

Имя Где Тип Обязательно Описание
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

Возвращает 200 · Page_TuningOut_

Поле Тип Обязательно Описание
items array of TuningOut да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/tunings" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Tunings

Тело · TuningIn

Поле Тип Обязательно Описание
instrument_id string (uuid) да
name string да
open_strings array of string да
is_default boolean

Возвращает 201 · TuningOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
instrument InstrumentOut да
name string да
open_strings array of string да
is_default boolean да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 200 · TuningOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
instrument InstrumentOut да
name string да
open_strings array of string да
is_default boolean да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Tunings

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Тело · TuningPatch

Поле Тип Обязательно Описание
instrument_id string (uuid) | null
name string | null
open_strings array of string | null
is_default boolean | null

Возвращает 200 · TuningOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
instrument InstrumentOut да
name string да
open_strings array of string да
is_default boolean да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Tunings

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Voicing Tags

Параметры

Имя Где Тип Обязательно Описание
search query string | null
ordering query string | null
limit query integer
offset query integer

Возвращает 200 · Page_VoicingTagOut_

Поле Тип Обязательно Описание
items array of VoicingTagOut да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing-Tags

Тело · VoicingTagIn

Поле Тип Обязательно Описание
name string да

Возвращает 201 · VoicingTagOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
name string да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 200 · VoicingTagOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
name string да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-tags/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Voicing-Tags

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Тело · VoicingTagPatch

Поле Тип Обязательно Описание
name string | null

Возвращает 200 · VoicingTagOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
name string да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/voicing-tags/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Voicings

Параметры

Имя Где Тип Обязательно Описание
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

Возвращает 200 · Page_VoicingOut_

Поле Тип Обязательно Описание
items array of VoicingOut да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicings" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing

Тело · VoicingIn

Поле Тип Обязательно Описание
entry_id string (uuid) да
tuning_id string (uuid) да
name string
source string
caged "" | “C” | “A” | “G” | “E” | “D”
frets array of integer да
fingers array of integer | null
barres array of object
inversion integer
difficulty integer
tag_names array of string

Возвращает 201 · VoicingOut

Поле Тип Обязательно Описание
id string (uuid) да
entry EntryLite да
tuning TuningLite да
name string да
source string да
caged string да
frets array of integer да
fingers array of integer | null да
barres array of object да
inversion integer да
is_open boolean да
fret_low integer да
fret_high integer да
difficulty integer да
tags array of string да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
voicing_id path string (uuid) да

Возвращает 200 · VoicingOut

Поле Тип Обязательно Описание
id string (uuid) да
entry EntryLite да
tuning TuningLite да
name string да
source string да
caged string да
frets array of integer да
fingers array of integer | null да
barres array of object да
inversion integer да
is_open boolean да
fret_low integer да
fret_high integer да
difficulty integer да
tags array of string да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicings/{voicing_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Voicing

Параметры

Имя Где Тип Обязательно Описание
voicing_id path string (uuid) да

Тело · VoicingPatch

Поле Тип Обязательно Описание
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

Возвращает 200 · VoicingOut

Поле Тип Обязательно Описание
id string (uuid) да
entry EntryLite да
tuning TuningLite да
name string да
source string да
caged string да
frets array of integer да
fingers array of integer | null да
barres array of object да
inversion integer да
is_open boolean да
fret_low integer да
fret_high integer да
difficulty integer да
tags array of string да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/voicings/{voicing_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Voicing

Параметры

Имя Где Тип Обязательно Описание
voicing_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/voicings/{voicing_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List References

Параметры

Имя Где Тип Обязательно Описание
search query string | null
ordering query string | null
limit query integer
offset query integer

Возвращает 200 · Page_ReferenceOut_

Поле Тип Обязательно Описание
items array of ReferenceOut да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/references" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create References

Тело · ReferenceIn

Поле Тип Обязательно Описание
title string да
author string
details string

Возвращает 201 · ReferenceOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
title string да
author string да
details string да

Пример

Окно терминала
curl -X POST "$JAMCLOUD_API/api/v1/harmony/references" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"title":"…"}'

Get References

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 200 · ReferenceOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
title string да
author string да
details string да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/references/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch References

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Тело · ReferencePatch

Поле Тип Обязательно Описание
title string | null
author string | null
details string | null

Возвращает 200 · ReferenceOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
title string да
author string да
details string да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/references/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete References

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/references/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Voicing References

Параметры

Имя Где Тип Обязательно Описание
voicing query string (uuid) | null
source query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

Возвращает 200 · Page_VoicingReferenceOut_

Поле Тип Обязательно Описание
items array of VoicingReferenceOut да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-references" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing-References

Тело · VoicingReferenceIn

Поле Тип Обязательно Описание
voicing_id string (uuid) да
source_id string (uuid) да
page string
figure string

Возвращает 201 · VoicingReferenceOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
voicing_id string (uuid) да
source ReferenceOut да
page string да
figure string да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 200 · VoicingReferenceOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
voicing_id string (uuid) да
source ReferenceOut да
page string да
figure string да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-references/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Voicing-References

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Тело · VoicingReferencePatch

Поле Тип Обязательно Описание
voicing_id string (uuid) | null
source_id string (uuid) | null
page string | null
figure string | null

Возвращает 200 · VoicingReferenceOut

Поле Тип Обязательно Описание
created_at string (date-time) да
updated_at string (date-time) да
id string (uuid) да
voicing_id string (uuid) да
source ReferenceOut да
page string да
figure string да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/voicing-references/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Voicing-References

Параметры

Имя Где Тип Обязательно Описание
item_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/voicing-references/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Entries

Параметры

Имя Где Тип Обязательно Описание
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

Возвращает 200 · Page_EntryOut_

Поле Тип Обязательно Описание
items array of EntryOut да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
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.

Параметры

Имя Где Тип Обязательно Описание
symbol query string

Возвращает 200 · EntryOut

Поле Тип Обязательно Описание
id string (uuid) да
symbol string да
root string да
bass string да
quality QualityOut да
family string да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries/by-symbol" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Entry

Параметры

Имя Где Тип Обязательно Описание
entry_id path string (uuid) да

Возвращает 200 · EntryOut

Поле Тип Обязательно Описание
id string (uuid) да
symbol string да
root string да
bass string да
quality QualityOut да
family string да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries/{entry_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Live

Возвращает 200 · object

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/health/live" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Ready

Возвращает 200 · object

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/health/ready" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Presign Upload

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Тело · PresignIn

Поле Тип Обязательно Описание
filename string да
content_type string да
size integer да

Возвращает 200 · PresignOut

Поле Тип Обязательно Описание
upload_url string да
key string да
audio_id string (uuid) да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Тело · app__modules__ingestion__schemas__ConfirmIn

Поле Тип Обязательно Описание
key string да
audio_id string (uuid) да
directory_id string (uuid) | null

Возвращает 201 · ConfirmOut

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
title string да
description string да
favorite boolean да
tags array of string да
file_size integer да
total_stems_usage integer да
uploaded_at string (date-time) да
last_played_at string (date-time) | null да
play_count integer да
directory DirectoryRef | null да
normalized_metadata object да
has_cover_art boolean да
cover_image_url string | null да
stems array of StemOut да
analyze TransformationOut | null да
metadata TransformationOut | null да
separation TransformationOut | null да
ml_analysis TransformationOut | null да
mapping TransformationOut | null
queued_separation TransformationOut | null
parent_id string (uuid) | null
clip ClipOut | null
auto_tasks object да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Тело · IngestUrlIn

Поле Тип Обязательно Описание
video_url string (uri) да
format IngestFormat

Возвращает 202 · IngestUrlOut

Поле Тип Обязательно Описание
status string да
job_id string да
audio_id string (uuid) да

Пример

Окно терминала
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

Возвращает 200 · ConditionsOut

Поле Тип Обязательно Описание
extensions array of string да
max_file_size_mb integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/uploads/conditions" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Lyrics

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 200 · LyricsOut

Поле Тип Обязательно Описание
id string (uuid) да
file_id string (uuid) да
lines array of object да
offset_ms integer да
source string да
source_ref string | null да
synced boolean да
updated_by string (uuid) | null да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Put Lyrics

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · LyricsIn

Поле Тип Обязательно Описание
lines array of LyricsLine да
offset_ms integer
source “manual” | “file” | “lrclib”
source_ref string | null

Возвращает 200 · LyricsOut

Поле Тип Обязательно Описание
id string (uuid) да
file_id string (uuid) да
lines array of object да
offset_ms integer да
source string да
source_ref string | null да
synced boolean да
updated_by string (uuid) | null да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
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.

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да
track query string | null
artist query string | null
q query string | null

Возвращает 200 · array of LyricsCandidate

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics/search" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Sections

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да
section_type query string | null

Возвращает 200 · array of SectionOut

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/sections" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Section

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · SectionIn

Поле Тип Обязательно Описание
start number да
end number | null
section_type string да
observation string | null

Возвращает 201 · SectionOut

Поле Тип Обязательно Описание
id string (uuid) да
file_id string (uuid) да
start number да
end number | null да
label string да
color string | null да
section_type string да
section_number integer да
observation string | null да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
section_id path string (uuid) да

Тело · SectionPatch

Поле Тип Обязательно Описание
start number | null
end number | null
section_type string | null
observation string | null

Возвращает 200 · SectionOut

Поле Тип Обязательно Описание
id string (uuid) да
file_id string (uuid) да
start number да
end number | null да
label string да
color string | null да
section_type string да
section_number integer да
observation string | null да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/sections/{section_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Section

Параметры

Имя Где Тип Обязательно Описание
section_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/sections/{section_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Marks

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 200 · array of MarkOut

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/marks" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Mark

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · MarkIn

Поле Тип Обязательно Описание
start number да
name string | null
observation string | null

Возвращает 201 · MarkOut

Поле Тип Обязательно Описание
id string (uuid) да
file_id string (uuid) да
start number да
name string да
observation string | null да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
mark_id path string (uuid) да

Тело · MarkPatch

Поле Тип Обязательно Описание
start number | null
name string | null
observation string | null

Возвращает 200 · MarkOut

Поле Тип Обязательно Описание
id string (uuid) да
file_id string (uuid) да
start number да
name string да
observation string | null да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/marks/{mark_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Mark

Параметры

Имя Где Тип Обязательно Описание
mark_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/marks/{mark_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Loops

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 200 · array of LoopOut

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/loops" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Loop

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · LoopIn

Поле Тип Обязательно Описание
start number да
end number | null
name string | null
observation string | null

Возвращает 201 · LoopOut

Поле Тип Обязательно Описание
id string (uuid) да
file_id string (uuid) да
start number да
end number | null да
name string да
observation string | null да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
loop_id path string (uuid) да

Тело · LoopPatch

Поле Тип Обязательно Описание
start number | null
end number | null
name string | null
observation string | null

Возвращает 200 · LoopOut

Поле Тип Обязательно Описание
id string (uuid) да
file_id string (uuid) да
start number да
end number | null да
name string да
observation string | null да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/loops/{loop_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Loop

Параметры

Имя Где Тип Обязательно Описание
loop_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
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.

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 200 · BeatsOut

Поле Тип Обязательно Описание
id string (uuid) | null
beats array of object да
meter array of MeterEntry да
source string да
beat_count integer да
created_at string (date-time) | null
updated_at string (date-time) | null

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/beats" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Put Beats

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · BeatsIn

Поле Тип Обязательно Описание
beats array of number да
meter array of MeterEntry

Возвращает 200 · BeatsOut

Поле Тип Обязательно Описание
id string (uuid) | null
beats array of object да
meter array of MeterEntry да
source string да
beat_count integer да
created_at string (date-time) | null
updated_at string (date-time) | null

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
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.

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Возвращает 202 · ImportCreated

Поле Тип Обязательно Описание
import_job_id string (uuid) да
job_id string да
status string да

Пример

Окно терминала
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/imports" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Import Status

Параметры

Имя Где Тип Обязательно Описание
import_id path string (uuid) да

Возвращает 200 · app__modules__music_import__schemas__ImportJobOut

Поле Тип Обязательно Описание
id string (uuid) да
original_filename string да
source_format string да
status string да
notation_id string (uuid) | null да
error_message string да
progress_percent integer да
progress_message string да
parser_logs object да
created_at string (date-time) да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/imports/{import_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Formats

Enabled import formats and their extensions.

Возвращает 200 · array of FormatOut

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/import/formats" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Notations

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да
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

Возвращает 200 · Page_NotationSummary_

Поле Тип Обязательно Описание
items array of NotationSummary да
total integer да
limit integer да
offset integer да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/notations" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Notation

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Тело · NotationIn

Поле Тип Обязательно Описание
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)

Возвращает 201 · NotationOut

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
title string да
author string да
audio_file_id string (uuid) | null да
audio_file_title string да
data object да
format_version integer да
source_format string да
origin string да
tempo integer да
time_signature string да
number_of_measures integer да
start_time number | null да
end_time number | null да
repeat_sync boolean да
sync_map object да
favorite boolean да
tags array of string да
category_ids array of string (uuid) да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/notations" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Notation Tags

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Возвращает 200 · TagsOut

Поле Тип Обязательно Описание
tags array of string да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/notations/tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Recent Notations

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Возвращает 200 · array of NotationSummary

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/notations/recent" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Notation

Параметры

Имя Где Тип Обязательно Описание
notation_id path string (uuid) да

Возвращает 200 · NotationOut

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
title string да
author string да
audio_file_id string (uuid) | null да
audio_file_title string да
data object да
format_version integer да
source_format string да
origin string да
tempo integer да
time_signature string да
number_of_measures integer да
start_time number | null да
end_time number | null да
repeat_sync boolean да
sync_map object да
favorite boolean да
tags array of string да
category_ids array of string (uuid) да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/notations/{notation_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Notation

Параметры

Имя Где Тип Обязательно Описание
notation_id path string (uuid) да

Тело · NotationPatch

Поле Тип Обязательно Описание
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

Возвращает 200 · NotationOut

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
title string да
author string да
audio_file_id string (uuid) | null да
audio_file_title string да
data object да
format_version integer да
source_format string да
origin string да
tempo integer да
time_signature string да
number_of_measures integer да
start_time number | null да
end_time number | null да
repeat_sync boolean да
sync_map object да
favorite boolean да
tags array of string да
category_ids array of string (uuid) да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/notations/{notation_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Notation

Параметры

Имя Где Тип Обязательно Описание
notation_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/notations/{notation_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Set Favorite

Параметры

Имя Где Тип Обязательно Описание
notation_id path string (uuid) да

Тело · FavoriteIn

Поле Тип Обязательно Описание
favorite boolean да

Возвращает 200 · NotationOut

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
title string да
author string да
audio_file_id string (uuid) | null да
audio_file_title string да
data object да
format_version integer да
source_format string да
origin string да
tempo integer да
time_signature string да
number_of_measures integer да
start_time number | null да
end_time number | null да
repeat_sync boolean да
sync_map object да
favorite boolean да
tags array of string да
category_ids array of string (uuid) да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
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

Возвращает 200 · array of CategoryOut

Пример

Окно терминала
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.

Возвращает 200 · PlatformOut

Поле Тип Обязательно Описание
payments_enabled boolean да
site_show_signup boolean да
site_hidden_pages array of string да
site_announcement string да
site_announcement_url string да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/platform" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Playlists

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Возвращает 200 · array of PlaylistOut

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/playlists" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Playlist

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Тело · PlaylistIn

Поле Тип Обязательно Описание
name string да
repeat_mode “off” | “all” | “one”

Возвращает 201 · PlaylistDetail

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
name string да
repeat_mode string да
track_count integer да
created_at string (date-time) да
updated_at string (date-time) да
tracks array of app__modules__playlists__schemas__TrackOut да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
playlist_id path string (uuid) да

Возвращает 200 · PlaylistDetail

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
name string да
repeat_mode string да
track_count integer да
created_at string (date-time) да
updated_at string (date-time) да
tracks array of app__modules__playlists__schemas__TrackOut да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Playlist

Параметры

Имя Где Тип Обязательно Описание
playlist_id path string (uuid) да

Тело · PlaylistPatch

Поле Тип Обязательно Описание
name string | null
repeat_mode “off” | “all” | “one” | null

Возвращает 200 · PlaylistDetail

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
name string да
repeat_mode string да
track_count integer да
created_at string (date-time) да
updated_at string (date-time) да
tracks array of app__modules__playlists__schemas__TrackOut да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Playlist

Параметры

Имя Где Тип Обязательно Описание
playlist_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Tracks

Параметры

Имя Где Тип Обязательно Описание
playlist_id path string (uuid) да

Возвращает 200 · array of app__modules__playlists__schemas__TrackOut

Пример

Окно терминала
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).

Параметры

Имя Где Тип Обязательно Описание
playlist_id path string (uuid) да

Тело · TracksIn

Поле Тип Обязательно Описание
tracks array of TrackIn да

Возвращает 201 · array of app__modules__playlists__schemas__TrackOut

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
playlist_id path string (uuid) да

Тело · ReorderIn

Поле Тип Обязательно Описание
order array of string (uuid) да

Возвращает 200 · array of app__modules__playlists__schemas__TrackOut

Пример

Окно терминала
curl -X PUT "$JAMCLOUD_API/api/v1/playlists/{playlist_id}/tracks" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"order":["<uuid>"]}'

Remove Track

Параметры

Имя Где Тип Обязательно Описание
playlist_id path string (uuid) да
track_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/playlists/{playlist_id}/tracks/{track_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Stream File

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да
quality query “low” | “medium” | “high” | null Profile chosen by the player when the preference is auto.

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/stream" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Stream File Url

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да
quality query “low” | “medium” | “high” | null Profile chosen by the player when the preference is auto.

Возвращает 200 · StreamUrlOut

Поле Тип Обязательно Описание
url string да
expires_in integer да
quality string | null

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/stream-url" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Stream Stem

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да
stem_name path string да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/stems/{stem_name}/stream" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Stream Stem Url

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да
stem_name path string да

Возвращает 200 · StreamUrlOut

Поле Тип Обязательно Описание
url string да
expires_in integer да
quality string | null

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/stems/{stem_name}/stream-url" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Presign Take

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · TakePresignIn

Поле Тип Обязательно Описание
content_type “audio/wav” | “audio/x-wav” | “audio/wave”
size integer да

Возвращает 200 · TakePresignOut

Поле Тип Обязательно Описание
upload_url string да
key string да
take_id string (uuid) да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · TakeConfirmIn

Поле Тип Обязательно Описание
take_id string (uuid) да
key string да
name string | null
duration number да
offset_ms integer
latency_ms integer
sample_rate integer да
speed number
pitch_tones number

Возвращает 201 · TakeOut

Поле Тип Обязательно Описание
id string (uuid) да
audio_file_id string (uuid) да
group_id string (uuid) да
created_by string (uuid) да
author_name string да
mine boolean да
name string да
status string да
duration number да
offset_ms integer да
latency_ms integer да
sample_rate integer да
speed number да
pitch_tones number да
file_size integer да
shared boolean да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
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).

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Возвращает 200 · array of TakeOut

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/takes" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Take

Параметры

Имя Где Тип Обязательно Описание
take_id path string (uuid) да

Возвращает 200 · TakeOut

Поле Тип Обязательно Описание
id string (uuid) да
audio_file_id string (uuid) да
group_id string (uuid) да
created_by string (uuid) да
author_name string да
mine boolean да
name string да
status string да
duration number да
offset_ms integer да
latency_ms integer да
sample_rate integer да
speed number да
pitch_tones number да
file_size integer да
shared boolean да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/takes/{take_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Update Take

Author only.

Параметры

Имя Где Тип Обязательно Описание
take_id path string (uuid) да

Тело · TakePatch

Поле Тип Обязательно Описание
name string | null
shared boolean | null
offset_ms integer | null

Возвращает 200 · TakeOut

Поле Тип Обязательно Описание
id string (uuid) да
audio_file_id string (uuid) да
group_id string (uuid) да
created_by string (uuid) да
author_name string да
mine boolean да
name string да
status string да
duration number да
offset_ms integer да
latency_ms integer да
sample_rate integer да
speed number да
pitch_tones number да
file_size integer да
shared boolean да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
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).

Параметры

Имя Где Тип Обязательно Описание
take_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/takes/{take_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Take Stream Url

Параметры

Имя Где Тип Обязательно Описание
take_id path string (uuid) да

Возвращает 200 · TakeStreamUrlOut

Поле Тип Обязательно Описание
url string да
expires_in integer да

Пример

Окно терминала
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.

Возвращает 200 · object

Пример

Окно терминала
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.

Возвращает 200 · object

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/tools/metronome/catalog" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Presets

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Возвращает 200 · array of MetronomePresetOut

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/metronome-presets" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Preset

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Тело · MetronomePresetIn

Поле Тип Обязательно Описание
name string да
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

Возвращает 201 · MetronomePresetOut

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
name string да
base_preset_id string | null да
bpm number да
numerator integer да
denominator integer да
subdivision string да
bars integer да
pattern string да
swing_ratio number | null да
voice string да
layers array of object да
audio_file_id string (uuid) | null да
analysis object | null да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
preset_id path string (uuid) да

Возвращает 200 · MetronomePresetOut

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
name string да
base_preset_id string | null да
bpm number да
numerator integer да
denominator integer да
subdivision string да
bars integer да
pattern string да
swing_ratio number | null да
voice string да
layers array of object да
audio_file_id string (uuid) | null да
analysis object | null да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Preset

Параметры

Имя Где Тип Обязательно Описание
preset_id path string (uuid) да

Тело · MetronomePresetPatch

Поле Тип Обязательно Описание
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

Возвращает 200 · MetronomePresetOut

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
name string да
base_preset_id string | null да
bpm number да
numerator integer да
denominator integer да
subdivision string да
bars integer да
pattern string да
swing_ratio number | null да
voice string да
layers array of object да
audio_file_id string (uuid) | null да
analysis object | null да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Preset

Параметры

Имя Где Тип Обязательно Описание
preset_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Analyze Audio

BPM + beat pattern proposal from the attached loop (analysis, then a metronome_analysis notification).

Параметры

Имя Где Тип Обязательно Описание
preset_id path string (uuid) да

Возвращает 202 · app__modules__tools__schemas__JobOut

Поле Тип Обязательно Описание
status string да
job_id string да
audio_id string (uuid) | null

Пример

Окно терминала
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).

Параметры

Имя Где Тип Обязательно Описание
preset_id path string (uuid) да

Тело · RenderIn

Поле Тип Обязательно Описание
bars integer

Возвращает 202 · app__modules__tools__schemas__JobOut

Поле Тип Обязательно Описание
status string да
job_id string да
audio_id string (uuid) | null

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Возвращает 200 · array of TunerProfileOut

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/tuner-profiles" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Tuning

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Тело · TunerProfileIn

Поле Тип Обязательно Описание
instrument string да
name string да
strings array of string да
reference_hz number
temperament string
tonic integer

Возвращает 201 · TunerProfileOut

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
instrument string да
name string да
strings array of string да
reference_hz number да
temperament string да
tonic integer да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
tuning_id path string (uuid) да

Тело · TunerProfilePatch

Поле Тип Обязательно Описание
instrument string | null
name string | null
strings array of string | null
reference_hz number | null
temperament string | null
tonic integer | null

Возвращает 200 · TunerProfileOut

Поле Тип Обязательно Описание
id string (uuid) да
group_id string (uuid) да
created_by string (uuid) | null да
instrument string да
name string да
strings array of string да
reference_hz number да
temperament string да
tonic integer да
created_at string (date-time) да
updated_at string (date-time) да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/tuner-profiles/{tuning_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Tuning

Параметры

Имя Где Тип Обязательно Описание
tuning_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
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.

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да

Тело · MetadataIn

Поле Тип Обязательно Описание
tags object да

Возвращает 202 · MetadataJobOut

Поле Тип Обязательно Описание
status string
job_id string да
transformation_id string (uuid) да

Пример

Окно терминала
curl -X PATCH "$JAMCLOUD_API/api/v1/files/{file_id}/metadata" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"tags":{}}'

Trigger

Параметры

Имя Где Тип Обязательно Описание
file_id path string (uuid) да
process path string да

Тело · TriggerIn | null

Возвращает 202 · TriggerOut

Поле Тип Обязательно Описание
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 да
job_id string да
transformation_id string (uuid) да

Пример

Окно терминала
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.

Возвращает 200 · array of SeparationModelOut

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/separation-models" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Batch Metadata

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

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Тело · BatchMetadataIn

Поле Тип Обязательно Описание
file_ids array of string (uuid) да
tags object да

Возвращает 202 · BatchMetadataOut

Поле Тип Обязательно Описание
jobs array of BatchJob да

Пример

Окно терминала
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

Параметры

Имя Где Тип Обязательно Описание
job_id path string да

Возвращает 200 · app__modules__transformer__schemas__JobOut

Поле Тип Обязательно Описание
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 да
state string да
status string да
progress integer да
ready boolean да
successful boolean да
transformation_id string (uuid) да

Пример

Окно терминала
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.

Параметры

Имя Где Тип Обязательно Описание
job_id path string да

Возвращает 204 · нет содержимого

Пример

Окно терминала
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).

Параметры

Имя Где Тип Обязательно Описание
job_id path string да

Возвращает 200 · object

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/jobs/{job_id}/events" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Delete Transformation

Параметры

Имя Где Тип Обязательно Описание
transformation_id path string (uuid) да

Возвращает 204 · нет содержимого

Пример

Окно терминала
curl -X DELETE "$JAMCLOUD_API/api/v1/transformations/{transformation_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

My Workspaces

Возвращает 200 · array of WorkspaceOut

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/groups" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Workspace

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Возвращает 200 · WorkspaceOut

Поле Тип Обязательно Описание
id string (uuid) да
name string да
kind string да
my_role GroupRole да
created_at string (date-time) да
owner_id string (uuid) | null да
member_count integer да Members besides the owner.
members array of WorkspaceMemberOut да
settings WorkspaceSettingsOut

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Settings

Параметры

Имя Где Тип Обязательно Описание
group_id path string (uuid) да

Возвращает 200 · WorkspaceSettingsOut

Поле Тип Обязательно Описание
boards_viewers_can_write boolean

Пример

Окно терминала
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/settings" \
-H "Authorization: Bearer $JAMCLOUD_KEY"