APIリファレンス
開発者向けのリファレンスです。各ルートが受け取るものと返すものを説明します。キーの取得方法と、キーで届く範囲は、先に API を読んでください。
バージョンはすべてのパスに含まれます:/api/v1。バージョン1の中では、ルートとフィールドは追加されるだけで、名前の変更や削除はありません。知らないフィールドは無視してください。コードを壊すような変更は新しいバージョン(/api/v2)として提供され、v1 も並行して動き続けます。
クイックスタート
Section titled “クイックスタート”APIのアドレスとキーを環境変数に入れ、任意のHTTPクライアントから呼び出します。インストールするSDKはありません。
export JAMCLOUD_API=https://api-jamcloud.australfactory.clexport JAMCLOUD_KEY=jc_…curl -H "Authorization: Bearer $JAMCLOUD_KEY" "$JAMCLOUD_API/api/v1/groups"import os, requests
api = os.environ["JAMCLOUD_API"] + "/api/v1"s = requests.Session()s.headers["Authorization"] = "Bearer " + os.environ["JAMCLOUD_KEY"]
workspaces = s.get(f"{api}/groups").json()tracks = s.get(f"{api}/groups/{workspaces[0]['id']}/files", params={"limit": 20}).json()["items"]const api = `${process.env.JAMCLOUD_API}/api/v1`;const headers = { Authorization: `Bearer ${process.env.JAMCLOUD_KEY}` };
const res = await fetch(`${api}/groups`, { headers });if (!res.ok) throw new Error((await res.json()).code); // stable error codeconst workspaces = await res.json();- 入出力はJSON、フィールドは
snake_case、IDはUUIDです。 - 一覧は
{items, total, limit, offset}を返します。limitとoffsetパラメーターでページ送りします。 - エラーは problem+json
{type, title, status, code, details}です。codeは変わらないので、これで判定してください。 - アップロードは3回の呼び出しです:presign、返されたURLへファイルを
PUT、そして confirm。URLの有効期限は15分で、申告したsizeちょうどのファイルを1回のPUTでのみ受け付けます。 - 503
circuit_open:Retry-Afterの秒数だけ待ってから再試行してください。
以下の各セクションが1つのリソースです。各ルートにパラメーター、フィールド、レスポンス、curl の例があります。
APIバージョン v1 · 以下のルートはすべて /api/v1 で始まります
Boards
Section titled “Boards”GET /api/v1/groups/{group_id}/boards
Section titled “GET /api/v1/groups/{group_id}/boards”List Boards
The workspace’s free boards (track boards are reached through their file).
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/groups/{group_id}/boards
Section titled “POST /api/v1/groups/{group_id}/boards”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 /api/v1/files/{file_id}/board
Section titled “GET /api/v1/files/{file_id}/board”Get Track Board
The file’s board, created empty on first read.
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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 /api/v1/boards/{board_id}
Section titled “GET /api/v1/boards/{board_id}”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"PATCH /api/v1/boards/{board_id}
Section titled “PATCH /api/v1/boards/{board_id}”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 /api/v1/boards/{board_id}
Section titled “DELETE /api/v1/boards/{board_id}”Delete Board
Owner only; a track’s board can’t be deleted on its own.
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
board_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/boards/{board_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/boards/{board_id}/ops
Section titled “POST /api/v1/boards/{board_id}/ops”Apply Ops
Apply a batch of item ops in one transaction, then broadcast them on the board’s
realtime channel ({"kind": "board", "board_id", "version", "client_id", "user_id", "ops"}).
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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":[{}]}'Charts
Section titled “Charts”GET /api/v1/files/{file_id}/chart
Section titled “GET /api/v1/files/{file_id}/chart”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 /api/v1/files/{file_id}/chart
Section titled “PUT /api/v1/files/{file_id}/chart”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 /api/v1/files/{file_id}/chart
Section titled “DELETE /api/v1/files/{file_id}/chart”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 /api/v1/files/{file_id}/score
Section titled “GET /api/v1/files/{file_id}/score”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"POST /api/v1/files/{file_id}/score
Section titled “POST /api/v1/files/{file_id}/score”Upload Score
Upload the file’s score, replacing any existing one. Guitar Pro / MusicXML are ready at
once (201); MuseScore, TablEdit, MIDI, TuxGuitar and Power Tab are converted to MusicXML in
the background (202, status: processing, then a score_import_progress
notification).
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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 /api/v1/files/{file_id}/score
Section titled “PATCH /api/v1/files/{file_id}/score”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 /api/v1/files/{file_id}/score
Section titled “DELETE /api/v1/files/{file_id}/score”Delete Score
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
file_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/score" \ -H "Authorization: Bearer $JAMCLOUD_KEY"PUT /api/v1/files/{file_id}/score/content
Section titled “PUT /api/v1/files/{file_id}/score/content”Save Score Content
Save the score edited in the app (Guitar Pro 7). base_revision = the revision
the edit started from: 409 score_conflict when someone saved in between. The original
upload stays downloadable (original_url).
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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
Section titled “Export”POST /api/v1/files/{file_id}/export
Section titled “POST /api/v1/files/{file_id}/export”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 '{}'GET /api/v1/exports/{job_id}
Section titled “GET /api/v1/exports/{job_id}”Export Status
The requester’s export job; a fresh download link while it is ready.
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"Feedback
Section titled “Feedback”POST /api/v1/feedback
Section titled “POST /api/v1/feedback”Send Feedback
Needs the feedback permission (on for every plan; an admin may turn it off per user).
The user agent is read from the request, the rest of the context is sent by the app.
ボディ · 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":"…"}'GET /api/v1/groups/{group_id}/directories
Section titled “GET /api/v1/groups/{group_id}/directories”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"POST /api/v1/groups/{group_id}/directories
Section titled “POST /api/v1/groups/{group_id}/directories”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 /api/v1/directories/{directory_id}
Section titled “DELETE /api/v1/directories/{directory_id}”Delete Directory
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
directory_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/directories/{directory_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/groups/{group_id}/files
Section titled “GET /api/v1/groups/{group_id}/files”List Files
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"GET /api/v1/groups/{group_id}/files/recent
Section titled “GET /api/v1/groups/{group_id}/files/recent”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"GET /api/v1/groups/{group_id}/tags
Section titled “GET /api/v1/groups/{group_id}/tags”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"POST /api/v1/groups/{group_id}/files/batch-delete
Section titled “POST /api/v1/groups/{group_id}/files/batch-delete”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>"]}'POST /api/v1/groups/{group_id}/files/batch-move
Section titled “POST /api/v1/groups/{group_id}/files/batch-move”Batch Move
Move files to another workspace the caller owns (personal <-> shared, same owner).
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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>"}'GET /api/v1/files
Section titled “GET /api/v1/files”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"GET /api/v1/files/recent
Section titled “GET /api/v1/files/recent”Recent All Files
レスポンス 200 · array of FileSummary
例
curl -X GET "$JAMCLOUD_API/api/v1/files/recent" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/tags
Section titled “GET /api/v1/files/tags”All Tags
レスポンス 200 · TagsOut
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
tags |
array of string | はい |
例
curl -X GET "$JAMCLOUD_API/api/v1/files/tags" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}
Section titled “GET /api/v1/files/{file_id}”Get File
Opening a file counts as a play (Django did it on every detail read); pass
?play=false to read without touching play_count / recents.
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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 /api/v1/files/{file_id}
Section titled “PATCH /api/v1/files/{file_id}”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 /api/v1/files/{file_id}
Section titled “DELETE /api/v1/files/{file_id}”Delete File
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
file_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/files/{file_id}/extract
Section titled “POST /api/v1/files/{file_id}/extract”Extract Clip
Copy [start, end] of the track into a new track of the same workspace (same format,
tags and metadata), grouped under the original. A file_ingested notification follows
(extract_failed with a code on failure).
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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}'POST /api/v1/files/{file_id}/favorite
Section titled “POST /api/v1/files/{file_id}/favorite”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}'GET /api/v1/files/{file_id}/tags
Section titled “GET /api/v1/files/{file_id}/tags”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"POST /api/v1/files/{file_id}/tags
Section titled “POST /api/v1/files/{file_id}/tags”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":["…"]}'DELETE /api/v1/files/{file_id}/tags/{tag}
Section titled “DELETE /api/v1/files/{file_id}/tags/{tag}”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 /api/v1/files/{file_id}/metadata
Section titled “GET /api/v1/files/{file_id}/metadata”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"GET /api/v1/files/{file_id}/status
Section titled “GET /api/v1/files/{file_id}/status”File Status
Latest state of every process run on the file (any status).
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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 /api/v1/files/{file_id}/stems
Section titled “DELETE /api/v1/files/{file_id}/stems”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 /api/v1/files/{file_id}/stems/{stem_name}
Section titled “DELETE /api/v1/files/{file_id}/stems/{stem_name}”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"Harmony
Section titled “Harmony”GET /api/v1/harmony/families
Section titled “GET /api/v1/harmony/families”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"POST /api/v1/harmony/families
Section titled “POST /api/v1/harmony/families”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 /api/v1/harmony/families/{item_id}
Section titled “GET /api/v1/harmony/families/{item_id}”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 /api/v1/harmony/families/{item_id}
Section titled “PATCH /api/v1/harmony/families/{item_id}”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 /api/v1/harmony/families/{item_id}
Section titled “DELETE /api/v1/harmony/families/{item_id}”Delete Families
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
item_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/qualities
Section titled “GET /api/v1/harmony/qualities”List Qualities
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/harmony/qualities
Section titled “POST /api/v1/harmony/qualities”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 /api/v1/harmony/qualities/{key}
Section titled “GET /api/v1/harmony/qualities/{key}”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 /api/v1/harmony/qualities/{key}
Section titled “PATCH /api/v1/harmony/qualities/{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 /api/v1/harmony/qualities/{key}
Section titled “DELETE /api/v1/harmony/qualities/{key}”Delete Quality
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
key |
path | string | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/aliases
Section titled “GET /api/v1/harmony/aliases”List Aliases
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/harmony/aliases
Section titled “POST /api/v1/harmony/aliases”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 /api/v1/harmony/aliases/{item_id}
Section titled “GET /api/v1/harmony/aliases/{item_id}”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 /api/v1/harmony/aliases/{item_id}
Section titled “PATCH /api/v1/harmony/aliases/{item_id}”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 /api/v1/harmony/aliases/{item_id}
Section titled “DELETE /api/v1/harmony/aliases/{item_id}”Delete Aliases
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
item_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/types
Section titled “GET /api/v1/harmony/types”List Types
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/harmony/types
Section titled “POST /api/v1/harmony/types”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 /api/v1/harmony/types/{item_id}
Section titled “GET /api/v1/harmony/types/{item_id}”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 /api/v1/harmony/types/{item_id}
Section titled “PATCH /api/v1/harmony/types/{item_id}”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 /api/v1/harmony/types/{item_id}
Section titled “DELETE /api/v1/harmony/types/{item_id}”Delete Types
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
item_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/instruments
Section titled “GET /api/v1/harmony/instruments”List Instruments
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/harmony/instruments
Section titled “POST /api/v1/harmony/instruments”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 /api/v1/harmony/instruments/{item_id}
Section titled “GET /api/v1/harmony/instruments/{item_id}”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 /api/v1/harmony/instruments/{item_id}
Section titled “PATCH /api/v1/harmony/instruments/{item_id}”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 /api/v1/harmony/instruments/{item_id}
Section titled “DELETE /api/v1/harmony/instruments/{item_id}”Delete Instruments
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
item_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/instruments/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/tunings
Section titled “GET /api/v1/harmony/tunings”List Tunings
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/harmony/tunings
Section titled “POST /api/v1/harmony/tunings”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 /api/v1/harmony/tunings/{item_id}
Section titled “GET /api/v1/harmony/tunings/{item_id}”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 /api/v1/harmony/tunings/{item_id}
Section titled “PATCH /api/v1/harmony/tunings/{item_id}”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 /api/v1/harmony/tunings/{item_id}
Section titled “DELETE /api/v1/harmony/tunings/{item_id}”Delete Tunings
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
item_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/voicing-tags
Section titled “GET /api/v1/harmony/voicing-tags”List Voicing Tags
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/harmony/voicing-tags
Section titled “POST /api/v1/harmony/voicing-tags”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 /api/v1/harmony/voicing-tags/{item_id}
Section titled “GET /api/v1/harmony/voicing-tags/{item_id}”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 /api/v1/harmony/voicing-tags/{item_id}
Section titled “PATCH /api/v1/harmony/voicing-tags/{item_id}”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 /api/v1/harmony/voicing-tags/{item_id}
Section titled “DELETE /api/v1/harmony/voicing-tags/{item_id}”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"GET /api/v1/harmony/voicings
Section titled “GET /api/v1/harmony/voicings”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"POST /api/v1/harmony/voicings
Section titled “POST /api/v1/harmony/voicings”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 /api/v1/harmony/voicings/{voicing_id}
Section titled “GET /api/v1/harmony/voicings/{voicing_id}”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 /api/v1/harmony/voicings/{voicing_id}
Section titled “PATCH /api/v1/harmony/voicings/{voicing_id}”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 /api/v1/harmony/voicings/{voicing_id}
Section titled “DELETE /api/v1/harmony/voicings/{voicing_id}”Delete Voicing
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
voicing_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/voicings/{voicing_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/references
Section titled “GET /api/v1/harmony/references”List References
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/harmony/references
Section titled “POST /api/v1/harmony/references”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 /api/v1/harmony/references/{item_id}
Section titled “GET /api/v1/harmony/references/{item_id}”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 /api/v1/harmony/references/{item_id}
Section titled “PATCH /api/v1/harmony/references/{item_id}”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 /api/v1/harmony/references/{item_id}
Section titled “DELETE /api/v1/harmony/references/{item_id}”Delete References
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
item_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/references/{item_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/harmony/voicing-references
Section titled “GET /api/v1/harmony/voicing-references”List Voicing References
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/harmony/voicing-references
Section titled “POST /api/v1/harmony/voicing-references”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 /api/v1/harmony/voicing-references/{item_id}
Section titled “GET /api/v1/harmony/voicing-references/{item_id}”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 /api/v1/harmony/voicing-references/{item_id}
Section titled “PATCH /api/v1/harmony/voicing-references/{item_id}”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 /api/v1/harmony/voicing-references/{item_id}
Section titled “DELETE /api/v1/harmony/voicing-references/{item_id}”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"GET /api/v1/harmony/entries
Section titled “GET /api/v1/harmony/entries”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"GET /api/v1/harmony/entries/by-symbol
Section titled “GET /api/v1/harmony/entries/by-symbol”Entry By Symbol
Resolve Dbmaj7/Gb-style symbols to the canonical (sharp) entry.
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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 /api/v1/harmony/entries/{entry_id}
Section titled “GET /api/v1/harmony/entries/{entry_id}”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"Health
Section titled “Health”GET /health/live
Section titled “GET /health/live”Live
レスポンス 200 · object
例
curl -X GET "$JAMCLOUD_API/health/live" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /health/ready
Section titled “GET /health/ready”Ready
レスポンス 200 · object
例
curl -X GET "$JAMCLOUD_API/health/ready" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Ingestion
Section titled “Ingestion”POST /api/v1/groups/{group_id}/uploads/presign
Section titled “POST /api/v1/groups/{group_id}/uploads/presign”Presign Upload
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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}'POST /api/v1/groups/{group_id}/uploads/confirm
Section titled “POST /api/v1/groups/{group_id}/uploads/confirm”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>"}'POST /api/v1/groups/{group_id}/ingest/url
Section titled “POST /api/v1/groups/{group_id}/ingest/url”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":"…"}'GET /api/v1/uploads/conditions
Section titled “GET /api/v1/uploads/conditions”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"Lyrics
Section titled “Lyrics”GET /api/v1/files/{file_id}/lyrics
Section titled “GET /api/v1/files/{file_id}/lyrics”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 /api/v1/files/{file_id}/lyrics
Section titled “PUT /api/v1/files/{file_id}/lyrics”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 /api/v1/files/{file_id}/lyrics
Section titled “DELETE /api/v1/files/{file_id}/lyrics”Delete Lyrics
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
file_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/lyrics/search
Section titled “GET /api/v1/files/{file_id}/lyrics/search”Search Lyrics
LRCLIB records (at most 20). No term: the track’s own title and artist.
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"Mapping
Section titled “Mapping”GET /api/v1/files/{file_id}/sections
Section titled “GET /api/v1/files/{file_id}/sections”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"POST /api/v1/files/{file_id}/sections
Section titled “POST /api/v1/files/{file_id}/sections”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 /api/v1/sections/{section_id}
Section titled “PATCH /api/v1/sections/{section_id}”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 /api/v1/sections/{section_id}
Section titled “DELETE /api/v1/sections/{section_id}”Delete Section
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
section_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/sections/{section_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/marks
Section titled “GET /api/v1/files/{file_id}/marks”List Marks
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/files/{file_id}/marks
Section titled “POST /api/v1/files/{file_id}/marks”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 /api/v1/marks/{mark_id}
Section titled “PATCH /api/v1/marks/{mark_id}”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 /api/v1/marks/{mark_id}
Section titled “DELETE /api/v1/marks/{mark_id}”Delete Mark
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
mark_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/marks/{mark_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/loops
Section titled “GET /api/v1/files/{file_id}/loops”List Loops
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/files/{file_id}/loops
Section titled “POST /api/v1/files/{file_id}/loops”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 /api/v1/loops/{loop_id}
Section titled “PATCH /api/v1/loops/{loop_id}”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 /api/v1/loops/{loop_id}
Section titled “DELETE /api/v1/loops/{loop_id}”Delete Loop
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
loop_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/loops/{loop_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/files/{file_id}/beats
Section titled “GET /api/v1/files/{file_id}/beats”Get Beats
The saved beat map, else the analysis beats with a suggested meter.
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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 /api/v1/files/{file_id}/beats
Section titled “PUT /api/v1/files/{file_id}/beats”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 /api/v1/files/{file_id}/beats
Section titled “DELETE /api/v1/files/{file_id}/beats”Delete Beats
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
file_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/beats" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Music import
Section titled “Music import”POST /api/v1/groups/{group_id}/imports
Section titled “POST /api/v1/groups/{group_id}/imports”Create Import
Upload a music file (MIDI, MusicXML, Guitar Pro, …) to import as a notation; poll
GET /imports/{id} or listen for music_import_progress notifications.
Needs the workspace owner’s score_import permission (403 action_not_allowed); the
file’s size is reserved on the owner’s storage (400 storage_limit_exceeded) until the
job ends.
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"GET /api/v1/imports/{import_id}
Section titled “GET /api/v1/imports/{import_id}”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"GET /api/v1/import/formats
Section titled “GET /api/v1/import/formats”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"Notations
Section titled “Notations”GET /api/v1/groups/{group_id}/notations
Section titled “GET /api/v1/groups/{group_id}/notations”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"POST /api/v1/groups/{group_id}/notations
Section titled “POST /api/v1/groups/{group_id}/notations”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 '{}'GET /api/v1/groups/{group_id}/notations/tags
Section titled “GET /api/v1/groups/{group_id}/notations/tags”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"GET /api/v1/groups/{group_id}/notations/recent
Section titled “GET /api/v1/groups/{group_id}/notations/recent”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 /api/v1/notations/{notation_id}
Section titled “GET /api/v1/notations/{notation_id}”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 /api/v1/notations/{notation_id}
Section titled “PATCH /api/v1/notations/{notation_id}”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 /api/v1/notations/{notation_id}
Section titled “DELETE /api/v1/notations/{notation_id}”Delete Notation
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
notation_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/notations/{notation_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/notations/{notation_id}/favorite
Section titled “POST /api/v1/notations/{notation_id}/favorite”Set Favorite
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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}'GET /api/v1/notation-categories
Section titled “GET /api/v1/notation-categories”Categories
レスポンス 200 · array of CategoryOut
例
curl -X GET "$JAMCLOUD_API/api/v1/notation-categories" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Platform
Section titled “Platform”GET /api/v1/platform
Section titled “GET /api/v1/platform”Get Platform
Public, no credentials: read by the app’s public pages and by the static site from its own
origin (hence *: nothing private here). Cached a minute by browsers and Cloudflare.
レスポンス 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"Playlists
Section titled “Playlists”GET /api/v1/groups/{group_id}/playlists
Section titled “GET /api/v1/groups/{group_id}/playlists”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"POST /api/v1/groups/{group_id}/playlists
Section titled “POST /api/v1/groups/{group_id}/playlists”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 /api/v1/playlists/{playlist_id}
Section titled “GET /api/v1/playlists/{playlist_id}”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 /api/v1/playlists/{playlist_id}
Section titled “PATCH /api/v1/playlists/{playlist_id}”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 /api/v1/playlists/{playlist_id}
Section titled “DELETE /api/v1/playlists/{playlist_id}”Delete Playlist
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
playlist_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/playlists/{playlist_id}/tracks
Section titled “GET /api/v1/playlists/{playlist_id}/tracks”List Tracks
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/playlists/{playlist_id}/tracks
Section titled “POST /api/v1/playlists/{playlist_id}/tracks”Add Tracks
Appends at the end (position is accepted but ignored, as in Django).
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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":[{}]}'PUT /api/v1/playlists/{playlist_id}/tracks
Section titled “PUT /api/v1/playlists/{playlist_id}/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>"]}'DELETE /api/v1/playlists/{playlist_id}/tracks/{track_id}
Section titled “DELETE /api/v1/playlists/{playlist_id}/tracks/{track_id}”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
Section titled “Stream”GET /api/v1/files/{file_id}/stream
Section titled “GET /api/v1/files/{file_id}/stream”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"GET /api/v1/files/{file_id}/stream-url
Section titled “GET /api/v1/files/{file_id}/stream-url”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"GET /api/v1/files/{file_id}/stems/{stem_name}/stream
Section titled “GET /api/v1/files/{file_id}/stems/{stem_name}/stream”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"GET /api/v1/files/{file_id}/stems/{stem_name}/stream-url
Section titled “GET /api/v1/files/{file_id}/stems/{stem_name}/stream-url”Stream Stem Url
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/files/{file_id}/takes/presign
Section titled “POST /api/v1/files/{file_id}/takes/presign”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}'POST /api/v1/files/{file_id}/takes/confirm
Section titled “POST /api/v1/files/{file_id}/takes/confirm”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}'GET /api/v1/files/{file_id}/takes
Section titled “GET /api/v1/files/{file_id}/takes”List Takes
Mine and the shared ones, newest first (small, bounded list: a plain array).
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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 /api/v1/takes/{take_id}
Section titled “GET /api/v1/takes/{take_id}”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"PATCH /api/v1/takes/{take_id}
Section titled “PATCH /api/v1/takes/{take_id}”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 /api/v1/takes/{take_id}
Section titled “DELETE /api/v1/takes/{take_id}”Delete Take
The author, or the workspace owner (for a take they can see: a shared one).
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
take_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/takes/{take_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/takes/{take_id}/stream-url
Section titled “GET /api/v1/takes/{take_id}/stream-url”Take Stream Url
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"GET /api/v1/tools/tuner/catalog
Section titled “GET /api/v1/tools/tuner/catalog”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"GET /api/v1/tools/metronome/catalog
Section titled “GET /api/v1/tools/metronome/catalog”Metronome Catalog
World-rhythm presets (clave, bell timelines, tala, aksak…) with their ethnomusicological notes, categories and sources.
レスポンス 200 · object
例
curl -X GET "$JAMCLOUD_API/api/v1/tools/metronome/catalog" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/groups/{group_id}/metronome-presets
Section titled “GET /api/v1/groups/{group_id}/metronome-presets”List Presets
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/groups/{group_id}/metronome-presets
Section titled “POST /api/v1/groups/{group_id}/metronome-presets”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 /api/v1/metronome-presets/{preset_id}
Section titled “GET /api/v1/metronome-presets/{preset_id}”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 /api/v1/metronome-presets/{preset_id}
Section titled “PATCH /api/v1/metronome-presets/{preset_id}”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 /api/v1/metronome-presets/{preset_id}
Section titled “DELETE /api/v1/metronome-presets/{preset_id}”Delete Preset
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
preset_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/metronome-presets/{preset_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"POST /api/v1/metronome-presets/{preset_id}/analyze-audio
Section titled “POST /api/v1/metronome-presets/{preset_id}/analyze-audio”Analyze Audio
BPM + beat pattern proposal from the attached loop (analysis, then a
metronome_analysis notification).
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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"POST /api/v1/metronome-presets/{preset_id}/render
Section titled “POST /api/v1/metronome-presets/{preset_id}/render”Render
Render a click track and import it into the library (same pipeline as an upload).
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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 '{}'GET /api/v1/groups/{group_id}/tuner-profiles
Section titled “GET /api/v1/groups/{group_id}/tuner-profiles”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"POST /api/v1/groups/{group_id}/tuner-profiles
Section titled “POST /api/v1/groups/{group_id}/tuner-profiles”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 /api/v1/tuner-profiles/{tuning_id}
Section titled “PATCH /api/v1/tuner-profiles/{tuning_id}”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 /api/v1/tuner-profiles/{tuning_id}
Section titled “DELETE /api/v1/tuner-profiles/{tuning_id}”Delete Tuning
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
tuning_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/tuner-profiles/{tuning_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Transformer
Section titled “Transformer”PATCH /api/v1/files/{file_id}/metadata
Section titled “PATCH /api/v1/files/{file_id}/metadata”Update Metadata
Write tags into the audio file (async). Not quota-counted: a basic edit.
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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":{}}'POST /api/v1/files/{file_id}/transformations/{process}
Section titled “POST /api/v1/files/{file_id}/transformations/{process}”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 '{}'GET /api/v1/separation-models
Section titled “GET /api/v1/separation-models”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"POST /api/v1/groups/{group_id}/files/batch-metadata
Section titled “POST /api/v1/groups/{group_id}/files/batch-metadata”Batch Metadata
Same tags on many files of the workspace; unknown ids are skipped.
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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":{}}'GET /api/v1/jobs/{job_id}
Section titled “GET /api/v1/jobs/{job_id}”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"DELETE /api/v1/jobs/{job_id}
Section titled “DELETE /api/v1/jobs/{job_id}”Cancel Job
Withdraw a request still waiting in line (editor); its quota use is refunded.
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
job_id |
path | string | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/jobs/{job_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/jobs/{job_id}/events
Section titled “GET /api/v1/jobs/{job_id}/events”Job Events
Server-sent events of one job: the current state first, then every event published on
rt:job:<id> until completed / failed (keepalive comments in between).
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
job_id |
path | string | はい |
レスポンス 200 · object
例
curl -X GET "$JAMCLOUD_API/api/v1/jobs/{job_id}/events" \ -H "Authorization: Bearer $JAMCLOUD_KEY"DELETE /api/v1/transformations/{transformation_id}
Section titled “DELETE /api/v1/transformations/{transformation_id}”Delete Transformation
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
transformation_id |
path | string (uuid) | はい |
レスポンス 204 · 内容なし
例
curl -X DELETE "$JAMCLOUD_API/api/v1/transformations/{transformation_id}" \ -H "Authorization: Bearer $JAMCLOUD_KEY"Workspaces
Section titled “Workspaces”GET /api/v1/groups
Section titled “GET /api/v1/groups”My Workspaces
レスポンス 200 · array of WorkspaceOut
例
curl -X GET "$JAMCLOUD_API/api/v1/groups" \ -H "Authorization: Bearer $JAMCLOUD_KEY"GET /api/v1/groups/{group_id}
Section titled “GET /api/v1/groups/{group_id}”Get Workspace
パラメーター
| 名前 | 場所 | 型 | 必須 | 説明 |
|---|---|---|---|---|
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 /api/v1/groups/{group_id}/settings
Section titled “GET /api/v1/groups/{group_id}/settings”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"