콘텐츠로 이동

API 레퍼런스

개발자를 위한 레퍼런스입니다. 각 경로가 무엇을 받고 무엇을 돌려주는지 설명합니다. 키를 받는 방법과 키가 닿는 범위는 먼저 API를 읽어 보세요.

버전은 모든 경로에 들어 있습니다: /api/v1. 버전 1 안에서는 경로와 필드가 추가되기만 하고 이름이 바뀌거나 삭제되지 않습니다. 모르는 필드는 무시하세요. 코드를 깨뜨릴 변경은 새 버전(/api/v2)으로 나오며, v1은 그 옆에서 계속 동작합니다.

API 주소와 키를 환경 변수에 넣고, 아무 HTTP 클라이언트로나 호출하세요. 설치할 SDK는 없습니다.

터미널 창
export JAMCLOUD_API=https://api-jamcloud.australfactory.cl
export JAMCLOUD_KEY=jc_…
curl -H "Authorization: Bearer $JAMCLOUD_KEY" "$JAMCLOUD_API/api/v1/groups"
import os, requests
api = os.environ["JAMCLOUD_API"] + "/api/v1"
s = requests.Session()
s.headers["Authorization"] = "Bearer " + os.environ["JAMCLOUD_KEY"]
workspaces = s.get(f"{api}/groups").json()
tracks = s.get(f"{api}/groups/{workspaces[0]['id']}/files", params={"limit": 20}).json()["items"]
const api = `${process.env.JAMCLOUD_API}/api/v1`;
const headers = { Authorization: `Bearer ${process.env.JAMCLOUD_KEY}` };
const res = await fetch(`${api}/groups`, { headers });
if (!res.ok) throw new Error((await res.json()).code); // stable error code
const workspaces = await res.json();
  • 입력과 출력은 JSON, 필드는 snake_case, id는 UUID입니다.
  • 목록은 {items, total, limit, offset}을 돌려줍니다. limit과 offset 매개변수로 페이지를 넘기세요.
  • 오류는 problem+json {type, title, status, code, details}입니다. code는 바뀌지 않으니 이것으로 판단하세요.
  • 업로드는 세 번의 호출입니다: presign, 돌려받은 URL로 파일 PUT, 그리고 confirm. URL은 15분 동안 유효하며, 선언한 size와 정확히 같은 크기의 파일을 한 번의 PUT으로만 받습니다.
  • 503 circuit_open: Retry-After의 초만큼 기다린 뒤 다시 시도하세요.

아래의 각 섹션이 하나의 리소스입니다. 각 경로에 매개변수, 필드, 응답, curl 예시가 있습니다.

API 버전 v1 · 아래의 모든 경로는 /api/v1로 시작합니다

List Boards

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

매개변수

이름 위치 유형 필수 설명
group_id path string (uuid) 예
limit query integer
offset query integer

응답 200 · Page_BoardOut_

필드 유형 필수 설명
items array of BoardOut 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/boards" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Board

매개변수

이름 위치 유형 필수 설명
group_id path string (uuid) 예

본문 · BoardIn

필드 유형 필수 설명
title string 예

응답 201 · BoardDetail

필드 유형 필수 설명
id string (uuid) 예
group_id string (uuid) 예
file_id string (uuid) | null 예
created_by string (uuid) | null 예
title string 예
version integer 예
item_count integer 예
can_write boolean 예
created_at string (date-time) 예
updated_at string (date-time) 예
items array of BoardItemOut 예

예시

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

Get Track Board

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

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 200 · BoardDetail

필드 유형 필수 설명
id string (uuid) 예
group_id string (uuid) 예
file_id string (uuid) | null 예
created_by string (uuid) | null 예
title string 예
version integer 예
item_count integer 예
can_write boolean 예
created_at string (date-time) 예
updated_at string (date-time) 예
items array of BoardItemOut 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/board" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Board

매개변수

이름 위치 유형 필수 설명
board_id path string (uuid) 예

응답 200 · BoardDetail

필드 유형 필수 설명
id string (uuid) 예
group_id string (uuid) 예
file_id string (uuid) | null 예
created_by string (uuid) | null 예
title string 예
version integer 예
item_count integer 예
can_write boolean 예
created_at string (date-time) 예
updated_at string (date-time) 예
items array of BoardItemOut 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/boards/{board_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Rename Board

매개변수

이름 위치 유형 필수 설명
board_id path string (uuid) 예

본문 · BoardPatch

필드 유형 필수 설명
title string 예

응답 200 · BoardOut

필드 유형 필수 설명
id string (uuid) 예
group_id string (uuid) 예
file_id string (uuid) | null 예
created_by string (uuid) | null 예
title string 예
version integer 예
item_count integer 예
can_write boolean 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

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

Delete Board

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

매개변수

이름 위치 유형 필수 설명
board_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/boards/{board_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Apply Ops

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

매개변수

이름 위치 유형 필수 설명
board_id path string (uuid) 예

본문 · OpsIn

필드 유형 필수 설명
client_id string 예
ops array of UpsertOp | DeleteOp | ClearOp 예

응답 200 · OpsOut

필드 유형 필수 설명
version integer 예
items array of ItemRev 예

예시

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

Get Chart

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 200 · ChartOut

필드 유형 필수 설명
id string (uuid) 예
file_id string (uuid) 예
content object 예
anchor_bar integer 예
source string 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/chart" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Put Chart

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

본문 · ChartIn

필드 유형 필수 설명
content ChartContent 예
anchor_bar integer
source “manual” | “import”

응답 200 · ChartOut

필드 유형 필수 설명
id string (uuid) 예
file_id string (uuid) 예
content object 예
anchor_bar integer 예
source string 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

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

Delete Chart

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/chart" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Score

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 200 · ScoreOut

필드 유형 필수 설명
id string (uuid) 예
file_id string (uuid) 예
status “processing” | “ready” | “failed” 예
format “guitarpro” | “musicxml” | null 예
source_format string 예
original_filename string 예
title string 예
anchor_bar integer 예
settings object 예
error_code string | null 예
error_message string | null 예
url string | null 예
original_url string 예
revision integer 예
edited_at string (date-time) | null 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/score" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Upload Score

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

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 201 · ScoreOut

필드 유형 필수 설명
id string (uuid) 예
file_id string (uuid) 예
status “processing” | “ready” | “failed” 예
format “guitarpro” | “musicxml” | null 예
source_format string 예
original_filename string 예
title string 예
anchor_bar integer 예
settings object 예
error_code string | null 예
error_message string | null 예
url string | null 예
original_url string 예
revision integer 예
edited_at string (date-time) | null 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

터미널 창
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/score" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Score

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

본문 · ScorePatch

필드 유형 필수 설명
anchor_bar integer | null
settings object | null

응답 200 · ScoreOut

필드 유형 필수 설명
id string (uuid) 예
file_id string (uuid) 예
status “processing” | “ready” | “failed” 예
format “guitarpro” | “musicxml” | null 예
source_format string 예
original_filename string 예
title string 예
anchor_bar integer 예
settings object 예
error_code string | null 예
error_message string | null 예
url string | null 예
original_url string 예
revision integer 예
edited_at string (date-time) | null 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/files/{file_id}/score" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Score

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/score" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Save Score Content

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

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 200 · ScoreOut

필드 유형 필수 설명
id string (uuid) 예
file_id string (uuid) 예
status “processing” | “ready” | “failed” 예
format “guitarpro” | “musicxml” | null 예
source_format string 예
original_filename string 예
title string 예
anchor_bar integer 예
settings object 예
error_code string | null 예
error_message string | null 예
url string | null 예
original_url string 예
revision integer 예
edited_at string (date-time) | null 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

터미널 창
curl -X PUT "$JAMCLOUD_API/api/v1/files/{file_id}/score/content" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Export File

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

본문 · ExportIn

필드 유형 필수 설명
download_mode “original” | “process”
include_stems boolean
format “wav” | “mp3” | “ogg” | “flac” | “aac”
codec string
sample_rate integer
channels integer
bitrate integer | null
vbr boolean
bit_depth integer
file_name string

응답 202 · ExportJobOut

필드 유형 필수 설명
job_id string 예
file_id string | null
status “queued” | “processing” | “ready” | “failed” 예
filename string | null
url string | null
expires_in integer | null
code string | null

예시

터미널 창
curl -X POST "$JAMCLOUD_API/api/v1/files/{file_id}/export" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Export Status

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

매개변수

이름 위치 유형 필수 설명
job_id path string (uuid) 예

응답 200 · ExportJobOut

필드 유형 필수 설명
job_id string 예
file_id string | null
status “queued” | “processing” | “ready” | “failed” 예
filename string | null
url string | null
expires_in integer | null
code string | null

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/exports/{job_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Send Feedback

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

본문 · FeedbackIn

필드 유형 필수 설명
category “bug” | “idea” | “question” | “other” 예
message string 예
group_id string | null The workspace open in the app.
context FeedbackContext

응답 201 · FeedbackOut

필드 유형 필수 설명
id string 예
category “bug” | “idea” | “question” | “other” 예
status “new” | “done” 예
created_at string (date-time) 예

예시

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

List Directories

매개변수

이름 위치 유형 필수 설명
group_id path string (uuid) 예

응답 200 · array of DirectoryOut

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/directories" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

POST /api/v1/groups/{group_id}/directories

섹션 제목: “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 Directory

매개변수

이름 위치 유형 필수 설명
directory_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/directories/{directory_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Files

매개변수

이름 위치 유형 필수 설명
group_id path string (uuid) 예
tags query array of string
favorite query boolean | null
search query string
directory_id query string (uuid) | null
limit query integer
offset query integer

응답 200 · Page_FileSummary_

필드 유형 필수 설명
items array of FileSummary 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/files" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

GET /api/v1/groups/{group_id}/files/recent

섹션 제목: “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"

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

섹션 제목: “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

섹션 제목: “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>"}'

List All Files

매개변수

이름 위치 유형 필수 설명
tags query array of string
favorite query boolean | null
search query string
limit query integer
offset query integer

응답 200 · Page_FileSummary_

필드 유형 필수 설명
items array of FileSummary 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Recent All Files

응답 200 · array of FileSummary

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/recent" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

All Tags

응답 200 · TagsOut

필드 유형 필수 설명
tags array of string 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get File

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

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예
play query boolean

응답 200 · FileOut

필드 유형 필수 설명
id string (uuid) 예
group_id string (uuid) 예
created_by string (uuid) | null 예
title string 예
description string 예
favorite boolean 예
tags array of string 예
file_size integer 예
total_stems_usage integer 예
uploaded_at string (date-time) 예
last_played_at string (date-time) | null 예
play_count integer 예
directory DirectoryRef | null 예
normalized_metadata object 예
has_cover_art boolean 예
cover_image_url string | null 예
stems array of StemOut 예
analyze TransformationOut | null 예
metadata TransformationOut | null 예
separation TransformationOut | null 예
ml_analysis TransformationOut | null 예
mapping TransformationOut | null
queued_separation TransformationOut | null
parent_id string (uuid) | null
clip ClipOut | null

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch File

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

본문 · FilePatch

필드 유형 필수 설명
title string | null
description string | null
favorite boolean | null
tags array of string | null
directory_id string (uuid) | null
parent_id null

응답 200 · FileOut

필드 유형 필수 설명
id string (uuid) 예
group_id string (uuid) 예
created_by string (uuid) | null 예
title string 예
description string 예
favorite boolean 예
tags array of string 예
file_size integer 예
total_stems_usage integer 예
uploaded_at string (date-time) 예
last_played_at string (date-time) | null 예
play_count integer 예
directory DirectoryRef | null 예
normalized_metadata object 예
has_cover_art boolean 예
cover_image_url string | null 예
stems array of StemOut 예
analyze TransformationOut | null 예
metadata TransformationOut | null 예
separation TransformationOut | null 예
ml_analysis TransformationOut | null 예
mapping TransformationOut | null
queued_separation TransformationOut | null
parent_id string (uuid) | null
clip ClipOut | null

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/files/{file_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete File

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Extract Clip

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

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

본문 · ExtractIn

필드 유형 필수 설명
start number 예
end number 예
title string | null

응답 202 · ExtractOut

필드 유형 필수 설명
status string 예
job_id string 예
audio_id string (uuid) 예

예시

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

Set Favorite

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

본문 · FavoriteIn

필드 유형 필수 설명
favorite boolean 예

응답 200 · FileSummary

필드 유형 필수 설명
id string (uuid) 예
group_id string (uuid) 예
favorite boolean 예
title string 예
description string 예
tags array of string 예
size integer 예
stems_usage integer 예
uploaded_at string (date-time) 예
last_played_at string (date-time) | null 예
directory DirectoryRef | null 예
has_cover_art boolean 예
parent_id string (uuid) | null
clip ClipOut | null
processes object
queue object
bpm number | null
key string | null

예시

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

File Tags

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 200 · TagsOut

필드 유형 필수 설명
tags array of string 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Add Tags

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

본문 · TagsIn

필드 유형 필수 설명
tags array of string 예

응답 200 · TagsOut

필드 유형 필수 설명
tags array of string 예

예시

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

Remove Tag

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예
tag path string 예

응답 200 · TagsOut

필드 유형 필수 설명
tags array of string 예

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/tags/{tag}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Metadata

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 200 · MetadataOut

필드 유형 필수 설명
normalized object 예
has_cover_art boolean 예
cover_image_url string | null 예
technical object | null 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/metadata" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

File Status

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

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 200 · StatusOut

필드 유형 필수 설명
id string (uuid) 예
transformations object 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/status" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Delete All Stems

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/stems" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

DELETE /api/v1/files/{file_id}/stems/{stem_name}

섹션 제목: “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"

List Families

매개변수

이름 위치 유형 필수 설명
search query string | null
ordering query string | null
limit query integer
offset query integer

응답 200 · Page_FamilyOut_

필드 유형 필수 설명
items array of FamilyOut 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/families" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Families

본문 · FamilyIn

필드 유형 필수 설명
name string 예
description string

응답 201 · FamilyOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
name string 예
description string 예

예시

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

Get Families

매개변수

이름 위치 유형 필수 설명
item_id path string (uuid) 예

응답 200 · FamilyOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
name string 예
description string 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Families

매개변수

이름 위치 유형 필수 설명
item_id path string (uuid) 예

본문 · FamilyPatch

필드 유형 필수 설명
name string | null
description string | null

응답 200 · FamilyOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
name string 예
description string 예

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Families

매개변수

이름 위치 유형 필수 설명
item_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/families/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Qualities

매개변수

이름 위치 유형 필수 설명
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

응답 200 · Page_QualityOut_

필드 유형 필수 설명
items array of QualityOut 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/qualities" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Quality

본문 · QualityIn

필드 유형 필수 설명
key string 예
family_id string (uuid) 예
formula array of integer 예
description string

응답 201 · QualityOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
key string 예
family string 예
family_id string (uuid) 예
formula array of integer 예
aliases array of AliasOut 예
description string 예

예시

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

Get Quality

매개변수

이름 위치 유형 필수 설명
key path string 예

응답 200 · QualityOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
key string 예
family string 예
family_id string (uuid) 예
formula array of integer 예
aliases array of AliasOut 예
description string 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Quality

매개변수

이름 위치 유형 필수 설명
key path string 예

본문 · QualityPatch

필드 유형 필수 설명
key string | null
family_id string (uuid) | null
formula array of integer | null
description string | null

응답 200 · QualityOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
key string 예
family string 예
family_id string (uuid) 예
formula array of integer 예
aliases array of AliasOut 예
description string 예

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Quality

매개변수

이름 위치 유형 필수 설명
key path string 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/qualities/{key}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Aliases

매개변수

이름 위치 유형 필수 설명
quality query string (uuid) | null
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

응답 200 · Page_AliasOut_

필드 유형 필수 설명
items array of AliasOut 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/aliases" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Aliases

본문 · AliasIn

필드 유형 필수 설명
quality_id string (uuid) 예
alias string 예
is_preferred boolean

응답 201 · AliasOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
quality_id string (uuid) 예
alias string 예
is_preferred boolean 예

예시

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

Get Aliases

매개변수

이름 위치 유형 필수 설명
item_id path string (uuid) 예

응답 200 · AliasOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
quality_id string (uuid) 예
alias string 예
is_preferred boolean 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Aliases

매개변수

이름 위치 유형 필수 설명
item_id path string (uuid) 예

본문 · AliasPatch

필드 유형 필수 설명
quality_id string (uuid) | null
alias string | null
is_preferred boolean | null

응답 200 · AliasOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
quality_id string (uuid) 예
alias string 예
is_preferred boolean 예

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Aliases

매개변수

이름 위치 유형 필수 설명
item_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/aliases/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Types

매개변수

이름 위치 유형 필수 설명
quality query string (uuid) | null
family query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

응답 200 · Page_ChordTypeOut_

필드 유형 필수 설명
items array of ChordTypeOut 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/types" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Types

본문 · ChordTypeIn

필드 유형 필수 설명
label string 예
description string
quality_id string (uuid) | null

응답 201 · ChordTypeOut

필드 유형 필수 설명
id string (uuid) 예
label string 예
description string 예
quality_id string (uuid) | null 예
quality_key string | null 예
family string | null 예

예시

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

Get Types

매개변수

이름 위치 유형 필수 설명
item_id path string (uuid) 예

응답 200 · ChordTypeOut

필드 유형 필수 설명
id string (uuid) 예
label string 예
description string 예
quality_id string (uuid) | null 예
quality_key string | null 예
family string | null 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Types

매개변수

이름 위치 유형 필수 설명
item_id path string (uuid) 예

본문 · ChordTypePatch

필드 유형 필수 설명
label string | null
description string | null
quality_id string (uuid) | null

응답 200 · ChordTypeOut

필드 유형 필수 설명
id string (uuid) 예
label string 예
description string 예
quality_id string (uuid) | null 예
quality_key string | null 예
family string | null 예

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Types

매개변수

이름 위치 유형 필수 설명
item_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/types/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Instruments

매개변수

이름 위치 유형 필수 설명
search query string | null
ordering query string | null
limit query integer
offset query integer

응답 200 · Page_InstrumentOut_

필드 유형 필수 설명
items array of InstrumentOut 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/instruments" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Instruments

본문 · InstrumentIn

필드 유형 필수 설명
name string 예
string_count integer

응답 201 · InstrumentOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
name string 예
string_count integer 예

예시

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

Get Instruments

매개변수

이름 위치 유형 필수 설명
item_id path string (uuid) 예

응답 200 · InstrumentOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
name string 예
string_count integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/instruments/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

PATCH /api/v1/harmony/instruments/{item_id}

섹션 제목: “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}

섹션 제목: “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"

List Tunings

매개변수

이름 위치 유형 필수 설명
instrument query string (uuid) | null
is_default query boolean | null
name query string | null
search query string | null
ordering query string | null
limit query integer
offset query integer

응답 200 · Page_TuningOut_

필드 유형 필수 설명
items array of TuningOut 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/tunings" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Tunings

본문 · TuningIn

필드 유형 필수 설명
instrument_id string (uuid) 예
name string 예
open_strings array of string 예
is_default boolean

응답 201 · TuningOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
instrument InstrumentOut 예
name string 예
open_strings array of string 예
is_default boolean 예

예시

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

Get Tunings

매개변수

이름 위치 유형 필수 설명
item_id path string (uuid) 예

응답 200 · TuningOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
instrument InstrumentOut 예
name string 예
open_strings array of string 예
is_default boolean 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Tunings

매개변수

이름 위치 유형 필수 설명
item_id path string (uuid) 예

본문 · TuningPatch

필드 유형 필수 설명
instrument_id string (uuid) | null
name string | null
open_strings array of string | null
is_default boolean | null

응답 200 · TuningOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
instrument InstrumentOut 예
name string 예
open_strings array of string 예
is_default boolean 예

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Tunings

매개변수

이름 위치 유형 필수 설명
item_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/harmony/tunings/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Voicing Tags

매개변수

이름 위치 유형 필수 설명
search query string | null
ordering query string | null
limit query integer
offset query integer

응답 200 · Page_VoicingTagOut_

필드 유형 필수 설명
items array of VoicingTagOut 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-tags" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing-Tags

본문 · VoicingTagIn

필드 유형 필수 설명
name string 예

응답 201 · VoicingTagOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
name string 예

예시

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

GET /api/v1/harmony/voicing-tags/{item_id}

섹션 제목: “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}

섹션 제목: “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}

섹션 제목: “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"

List Voicings

매개변수

이름 위치 유형 필수 설명
entry query string (uuid) | null
tuning query string | null ‘default’ or a tuning id
caged query string | null
min_fret query integer | null
max_fret query integer | null
inversion query integer | null
is_open query boolean | null
difficulty query integer | null
difficulty_lte query integer | null
tags query string | null comma-separated tag names (all)
search query string | null
ordering query string | null
limit query integer
offset query integer

응답 200 · Page_VoicingOut_

필드 유형 필수 설명
items array of VoicingOut 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicings" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing

본문 · VoicingIn

필드 유형 필수 설명
entry_id string (uuid) 예
tuning_id string (uuid) 예
name string
source string
caged "" | “C” | “A” | “G” | “E” | “D”
frets array of integer 예
fingers array of integer | null
barres array of object
inversion integer
difficulty integer
tag_names array of string

응답 201 · VoicingOut

필드 유형 필수 설명
id string (uuid) 예
entry EntryLite 예
tuning TuningLite 예
name string 예
source string 예
caged string 예
frets array of integer 예
fingers array of integer | null 예
barres array of object 예
inversion integer 예
is_open boolean 예
fret_low integer 예
fret_high integer 예
difficulty integer 예
tags array of string 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

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

Get Voicing

매개변수

이름 위치 유형 필수 설명
voicing_id path string (uuid) 예

응답 200 · VoicingOut

필드 유형 필수 설명
id string (uuid) 예
entry EntryLite 예
tuning TuningLite 예
name string 예
source string 예
caged string 예
frets array of integer 예
fingers array of integer | null 예
barres array of object 예
inversion integer 예
is_open boolean 예
fret_low integer 예
fret_high integer 예
difficulty integer 예
tags array of string 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicings/{voicing_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

PATCH /api/v1/harmony/voicings/{voicing_id}

섹션 제목: “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}

섹션 제목: “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"

List References

매개변수

이름 위치 유형 필수 설명
search query string | null
ordering query string | null
limit query integer
offset query integer

응답 200 · Page_ReferenceOut_

필드 유형 필수 설명
items array of ReferenceOut 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/references" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create References

본문 · ReferenceIn

필드 유형 필수 설명
title string 예
author string
details string

응답 201 · ReferenceOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
title string 예
author string 예
details string 예

예시

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

Get References

매개변수

이름 위치 유형 필수 설명
item_id path string (uuid) 예

응답 200 · ReferenceOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
title string 예
author string 예
details string 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/references/{item_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

PATCH /api/v1/harmony/references/{item_id}

섹션 제목: “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}

섹션 제목: “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"

List Voicing References

매개변수

이름 위치 유형 필수 설명
voicing query string (uuid) | null
source query string (uuid) | null
search query string | null
ordering query string | null
limit query integer
offset query integer

응답 200 · Page_VoicingReferenceOut_

필드 유형 필수 설명
items array of VoicingReferenceOut 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/voicing-references" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Voicing-References

본문 · VoicingReferenceIn

필드 유형 필수 설명
voicing_id string (uuid) 예
source_id string (uuid) 예
page string
figure string

응답 201 · VoicingReferenceOut

필드 유형 필수 설명
created_at string (date-time) 예
updated_at string (date-time) 예
id string (uuid) 예
voicing_id string (uuid) 예
source ReferenceOut 예
page string 예
figure string 예

예시

터미널 창
curl -X POST "$JAMCLOUD_API/api/v1/harmony/voicing-references" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"voicing_id":"<uuid>","source_id":"<uuid>"}'

GET /api/v1/harmony/voicing-references/{item_id}

섹션 제목: “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}

섹션 제목: “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}

섹션 제목: “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"

List Entries

매개변수

이름 위치 유형 필수 설명
root query string | null
symbol query string | null
quality query string (uuid) | null
family query string (uuid) | null
bass query string | null
search query string | null
ordering query string | null
limit query integer
offset query integer

응답 200 · Page_EntryOut_

필드 유형 필수 설명
items array of EntryOut 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Entry By Symbol

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

매개변수

이름 위치 유형 필수 설명
symbol query string

응답 200 · EntryOut

필드 유형 필수 설명
id string (uuid) 예
symbol string 예
root string 예
bass string 예
quality QualityOut 예
family string 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries/by-symbol" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Entry

매개변수

이름 위치 유형 필수 설명
entry_id path string (uuid) 예

응답 200 · EntryOut

필드 유형 필수 설명
id string (uuid) 예
symbol string 예
root string 예
bass string 예
quality QualityOut 예
family string 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/harmony/entries/{entry_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Live

응답 200 · object

예시

터미널 창
curl -X GET "$JAMCLOUD_API/health/live" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Ready

응답 200 · object

예시

터미널 창
curl -X GET "$JAMCLOUD_API/health/ready" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

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

섹션 제목: “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

섹션 제목: “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>"}'

Ingest Url

매개변수

이름 위치 유형 필수 설명
group_id path string (uuid) 예

본문 · IngestUrlIn

필드 유형 필수 설명
video_url string (uri) 예
format IngestFormat

응답 202 · IngestUrlOut

필드 유형 필수 설명
status string 예
job_id string 예
audio_id string (uuid) 예

예시

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

Upload Conditions

응답 200 · ConditionsOut

필드 유형 필수 설명
extensions array of string 예
max_file_size_mb integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/uploads/conditions" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Lyrics

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 200 · LyricsOut

필드 유형 필수 설명
id string (uuid) 예
file_id string (uuid) 예
lines array of object 예
offset_ms integer 예
source string 예
source_ref string | null 예
synced boolean 예
updated_by string (uuid) | null 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Put Lyrics

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

본문 · LyricsIn

필드 유형 필수 설명
lines array of LyricsLine 예
offset_ms integer
source “manual” | “file” | “lrclib”
source_ref string | null

응답 200 · LyricsOut

필드 유형 필수 설명
id string (uuid) 예
file_id string (uuid) 예
lines array of object 예
offset_ms integer 예
source string 예
source_ref string | null 예
synced boolean 예
updated_by string (uuid) | null 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

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

Delete Lyrics

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Search Lyrics

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

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예
track query string | null
artist query string | null
q query string | null

응답 200 · array of LyricsCandidate

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/lyrics/search" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Sections

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예
section_type query string | null

응답 200 · array of SectionOut

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/sections" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Section

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

본문 · SectionIn

필드 유형 필수 설명
start number 예
end number | null
section_type string 예
observation string | null

응답 201 · SectionOut

필드 유형 필수 설명
id string (uuid) 예
file_id string (uuid) 예
start number 예
end number | null 예
label string 예
color string | null 예
section_type string 예
section_number integer 예
observation string | null 예

예시

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

Patch Section

매개변수

이름 위치 유형 필수 설명
section_id path string (uuid) 예

본문 · SectionPatch

필드 유형 필수 설명
start number | null
end number | null
section_type string | null
observation string | null

응답 200 · SectionOut

필드 유형 필수 설명
id string (uuid) 예
file_id string (uuid) 예
start number 예
end number | null 예
label string 예
color string | null 예
section_type string 예
section_number integer 예
observation string | null 예

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/sections/{section_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Section

매개변수

이름 위치 유형 필수 설명
section_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/sections/{section_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Marks

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 200 · array of MarkOut

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/marks" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Mark

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

본문 · MarkIn

필드 유형 필수 설명
start number 예
name string | null
observation string | null

응답 201 · MarkOut

필드 유형 필수 설명
id string (uuid) 예
file_id string (uuid) 예
start number 예
name string 예
observation string | null 예

예시

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

Patch Mark

매개변수

이름 위치 유형 필수 설명
mark_id path string (uuid) 예

본문 · MarkPatch

필드 유형 필수 설명
start number | null
name string | null
observation string | null

응답 200 · MarkOut

필드 유형 필수 설명
id string (uuid) 예
file_id string (uuid) 예
start number 예
name string 예
observation string | null 예

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/marks/{mark_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Mark

매개변수

이름 위치 유형 필수 설명
mark_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/marks/{mark_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Loops

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 200 · array of LoopOut

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/loops" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Loop

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

본문 · LoopIn

필드 유형 필수 설명
start number 예
end number | null
name string | null
observation string | null

응답 201 · LoopOut

필드 유형 필수 설명
id string (uuid) 예
file_id string (uuid) 예
start number 예
end number | null 예
name string 예
observation string | null 예

예시

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

Patch Loop

매개변수

이름 위치 유형 필수 설명
loop_id path string (uuid) 예

본문 · LoopPatch

필드 유형 필수 설명
start number | null
end number | null
name string | null
observation string | null

응답 200 · LoopOut

필드 유형 필수 설명
id string (uuid) 예
file_id string (uuid) 예
start number 예
end number | null 예
name string 예
observation string | null 예

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/loops/{loop_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Loop

매개변수

이름 위치 유형 필수 설명
loop_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/loops/{loop_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Beats

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

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 200 · BeatsOut

필드 유형 필수 설명
id string (uuid) | null
beats array of object 예
meter array of MeterEntry 예
source string 예
beat_count integer 예
created_at string (date-time) | null
updated_at string (date-time) | null

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/beats" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Put Beats

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

본문 · BeatsIn

필드 유형 필수 설명
beats array of number 예
meter array of MeterEntry

응답 200 · BeatsOut

필드 유형 필수 설명
id string (uuid) | null
beats array of object 예
meter array of MeterEntry 예
source string 예
beat_count integer 예
created_at string (date-time) | null
updated_at string (date-time) | null

예시

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

Delete Beats

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/files/{file_id}/beats" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Import

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

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

매개변수

이름 위치 유형 필수 설명
group_id path string (uuid) 예

응답 202 · ImportCreated

필드 유형 필수 설명
import_job_id string (uuid) 예
job_id string 예
status string 예

예시

터미널 창
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/imports" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Import Status

매개변수

이름 위치 유형 필수 설명
import_id path string (uuid) 예

응답 200 · app__modules__music_import__schemas__ImportJobOut

필드 유형 필수 설명
id string (uuid) 예
original_filename string 예
source_format string 예
status string 예
notation_id string (uuid) | null 예
error_message string 예
progress_percent integer 예
progress_message string 예
parser_logs object 예
created_at string (date-time) 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/imports/{import_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Formats

Enabled import formats and their extensions.

응답 200 · array of FormatOut

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/import/formats" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Notations

매개변수

이름 위치 유형 필수 설명
group_id path string (uuid) 예
audio_file_id query string (uuid) | null
favorite query boolean | null
tags query array of string
search query string
limit query integer
offset query integer

응답 200 · Page_NotationSummary_

필드 유형 필수 설명
items array of NotationSummary 예
total integer 예
limit integer 예
offset integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/notations" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Notation

매개변수

이름 위치 유형 필수 설명
group_id path string (uuid) 예

본문 · NotationIn

필드 유형 필수 설명
title string
author string
audio_file_id string (uuid) | null
data object
tempo integer
time_signature string
number_of_measures integer
start_time number | string | null
end_time number | string | null
repeat_sync boolean
sync_map object
favorite boolean
tags array of string
category_ids array of string (uuid)

응답 201 · NotationOut

필드 유형 필수 설명
id string (uuid) 예
group_id string (uuid) 예
created_by string (uuid) | null 예
title string 예
author string 예
audio_file_id string (uuid) | null 예
audio_file_title string 예
data object 예
format_version integer 예
source_format string 예
origin string 예
tempo integer 예
time_signature string 예
number_of_measures integer 예
start_time number | null 예
end_time number | null 예
repeat_sync boolean 예
sync_map object 예
favorite boolean 예
tags array of string 예
category_ids array of string (uuid) 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

터미널 창
curl -X POST "$JAMCLOUD_API/api/v1/groups/{group_id}/notations" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

GET /api/v1/groups/{group_id}/notations/tags

섹션 제목: “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

섹션 제목: “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 Notation

매개변수

이름 위치 유형 필수 설명
notation_id path string (uuid) 예

응답 200 · NotationOut

필드 유형 필수 설명
id string (uuid) 예
group_id string (uuid) 예
created_by string (uuid) | null 예
title string 예
author string 예
audio_file_id string (uuid) | null 예
audio_file_title string 예
data object 예
format_version integer 예
source_format string 예
origin string 예
tempo integer 예
time_signature string 예
number_of_measures integer 예
start_time number | null 예
end_time number | null 예
repeat_sync boolean 예
sync_map object 예
favorite boolean 예
tags array of string 예
category_ids array of string (uuid) 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/notations/{notation_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Notation

매개변수

이름 위치 유형 필수 설명
notation_id path string (uuid) 예

본문 · NotationPatch

필드 유형 필수 설명
title string | null
author string | null
audio_file_id string (uuid) | null
data object | null
tempo integer | null
time_signature string | null
number_of_measures integer | null
start_time number | string | null
end_time number | string | null
repeat_sync boolean | null
sync_map object | null
favorite boolean | null
tags array of string | null
category_ids array of string (uuid) | null

응답 200 · NotationOut

필드 유형 필수 설명
id string (uuid) 예
group_id string (uuid) 예
created_by string (uuid) | null 예
title string 예
author string 예
audio_file_id string (uuid) | null 예
audio_file_title string 예
data object 예
format_version integer 예
source_format string 예
origin string 예
tempo integer 예
time_signature string 예
number_of_measures integer 예
start_time number | null 예
end_time number | null 예
repeat_sync boolean 예
sync_map object 예
favorite boolean 예
tags array of string 예
category_ids array of string (uuid) 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/notations/{notation_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Notation

매개변수

이름 위치 유형 필수 설명
notation_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/notations/{notation_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

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

섹션 제목: “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}'

Categories

응답 200 · array of CategoryOut

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/notation-categories" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Platform

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

응답 200 · PlatformOut

필드 유형 필수 설명
payments_enabled boolean 예
site_show_signup boolean 예
site_hidden_pages array of string 예
site_announcement string 예
site_announcement_url string 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/platform" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

List Playlists

매개변수

이름 위치 유형 필수 설명
group_id path string (uuid) 예

응답 200 · array of PlaylistOut

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/playlists" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Create Playlist

매개변수

이름 위치 유형 필수 설명
group_id path string (uuid) 예

본문 · PlaylistIn

필드 유형 필수 설명
name string 예
repeat_mode “off” | “all” | “one”

응답 201 · PlaylistDetail

필드 유형 필수 설명
id string (uuid) 예
group_id string (uuid) 예
created_by string (uuid) | null 예
name string 예
repeat_mode string 예
track_count integer 예
created_at string (date-time) 예
updated_at string (date-time) 예
tracks array of app__modules__playlists__schemas__TrackOut 예

예시

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

Get Playlist

매개변수

이름 위치 유형 필수 설명
playlist_id path string (uuid) 예

응답 200 · PlaylistDetail

필드 유형 필수 설명
id string (uuid) 예
group_id string (uuid) 예
created_by string (uuid) | null 예
name string 예
repeat_mode string 예
track_count integer 예
created_at string (date-time) 예
updated_at string (date-time) 예
tracks array of app__modules__playlists__schemas__TrackOut 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Patch Playlist

매개변수

이름 위치 유형 필수 설명
playlist_id path string (uuid) 예

본문 · PlaylistPatch

필드 유형 필수 설명
name string | null
repeat_mode “off” | “all” | “one” | null

응답 200 · PlaylistDetail

필드 유형 필수 설명
id string (uuid) 예
group_id string (uuid) 예
created_by string (uuid) | null 예
name string 예
repeat_mode string 예
track_count integer 예
created_at string (date-time) 예
updated_at string (date-time) 예
tracks array of app__modules__playlists__schemas__TrackOut 예

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Playlist

매개변수

이름 위치 유형 필수 설명
playlist_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/playlists/{playlist_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

GET /api/v1/playlists/{playlist_id}/tracks

섹션 제목: “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

섹션 제목: “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

섹션 제목: “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}

섹션 제목: “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 File

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예
quality query “low” | “medium” | “high” | null Profile chosen by the player when the preference is auto.

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/stream" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Stream File Url

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예
quality query “low” | “medium” | “high” | null Profile chosen by the player when the preference is auto.

응답 200 · StreamUrlOut

필드 유형 필수 설명
url string 예
expires_in integer 예
quality string | null

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/stream-url" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

GET /api/v1/files/{file_id}/stems/{stem_name}/stream

섹션 제목: “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

섹션 제목: “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

섹션 제목: “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

섹션 제목: “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}'

List Takes

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

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

응답 200 · array of TakeOut

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/files/{file_id}/takes" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Take

매개변수

이름 위치 유형 필수 설명
take_id path string (uuid) 예

응답 200 · TakeOut

필드 유형 필수 설명
id string (uuid) 예
audio_file_id string (uuid) 예
group_id string (uuid) 예
created_by string (uuid) 예
author_name string 예
mine boolean 예
name string 예
status string 예
duration number 예
offset_ms integer 예
latency_ms integer 예
sample_rate integer 예
speed number 예
pitch_tones number 예
file_size integer 예
shared boolean 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/takes/{take_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Update Take

Author only.

매개변수

이름 위치 유형 필수 설명
take_id path string (uuid) 예

본문 · TakePatch

필드 유형 필수 설명
name string | null
shared boolean | null
offset_ms integer | null

응답 200 · TakeOut

필드 유형 필수 설명
id string (uuid) 예
audio_file_id string (uuid) 예
group_id string (uuid) 예
created_by string (uuid) 예
author_name string 예
mine boolean 예
name string 예
status string 예
duration number 예
offset_ms integer 예
latency_ms integer 예
sample_rate integer 예
speed number 예
pitch_tones number 예
file_size integer 예
shared boolean 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/takes/{take_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Take

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

매개변수

이름 위치 유형 필수 설명
take_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/takes/{take_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Take Stream Url

매개변수

이름 위치 유형 필수 설명
take_id path string (uuid) 예

응답 200 · TakeStreamUrlOut

필드 유형 필수 설명
url string 예
expires_in integer 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/takes/{take_id}/stream-url" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Tuner Catalog

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

응답 200 · object

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/tools/tuner/catalog" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Metronome Catalog

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

응답 200 · object

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/tools/metronome/catalog" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

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

섹션 제목: “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

섹션 제목: “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 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}

섹션 제목: “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}

섹션 제목: “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

섹션 제목: “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

섹션 제목: “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

섹션 제목: “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

섹션 제목: “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 Tuning

매개변수

이름 위치 유형 필수 설명
tuning_id path string (uuid) 예

본문 · TunerProfilePatch

필드 유형 필수 설명
instrument string | null
name string | null
strings array of string | null
reference_hz number | null
temperament string | null
tonic integer | null

응답 200 · TunerProfileOut

필드 유형 필수 설명
id string (uuid) 예
group_id string (uuid) 예
created_by string (uuid) | null 예
instrument string 예
name string 예
strings array of string 예
reference_hz number 예
temperament string 예
tonic integer 예
created_at string (date-time) 예
updated_at string (date-time) 예

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/tuner-profiles/{tuning_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Delete Tuning

매개변수

이름 위치 유형 필수 설명
tuning_id path string (uuid) 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/tuner-profiles/{tuning_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Update Metadata

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

매개변수

이름 위치 유형 필수 설명
file_id path string (uuid) 예

본문 · MetadataIn

필드 유형 필수 설명
tags object 예

응답 202 · MetadataJobOut

필드 유형 필수 설명
status string
job_id string 예
transformation_id string (uuid) 예

예시

터미널 창
curl -X PATCH "$JAMCLOUD_API/api/v1/files/{file_id}/metadata" \
-H "Authorization: Bearer $JAMCLOUD_KEY" \
-H "Content-Type: application/json" \
-d '{"tags":{}}'

POST /api/v1/files/{file_id}/transformations/{process}

섹션 제목: “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 '{}'

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

섹션 제목: “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":{}}'

Job Status

매개변수

이름 위치 유형 필수 설명
job_id path string 예

응답 200 · app__modules__transformer__schemas__JobOut

필드 유형 필수 설명
position integer | null 1 = next to start.
ahead integer | null Requests waiting before this one.
eta_seconds integer | null Rough wait before it starts.
job_id string 예
state string 예
status string 예
progress integer 예
ready boolean 예
successful boolean 예
transformation_id string (uuid) 예

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/jobs/{job_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Cancel Job

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

매개변수

이름 위치 유형 필수 설명
job_id path string 예

응답 204 · 내용 없음

예시

터미널 창
curl -X DELETE "$JAMCLOUD_API/api/v1/jobs/{job_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Job Events

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

매개변수

이름 위치 유형 필수 설명
job_id path string 예

응답 200 · object

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/jobs/{job_id}/events" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

DELETE /api/v1/transformations/{transformation_id}

섹션 제목: “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"

My Workspaces

응답 200 · array of WorkspaceOut

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/groups" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Workspace

매개변수

이름 위치 유형 필수 설명
group_id path string (uuid) 예

응답 200 · WorkspaceOut

필드 유형 필수 설명
id string (uuid) 예
name string 예
kind string 예
my_role GroupRole 예
created_at string (date-time) 예
owner_id string (uuid) | null 예
member_count integer 예 Members besides the owner.
members array of WorkspaceMemberOut 예
settings WorkspaceSettingsOut

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}" \
-H "Authorization: Bearer $JAMCLOUD_KEY"

Get Settings

매개변수

이름 위치 유형 필수 설명
group_id path string (uuid) 예

응답 200 · WorkspaceSettingsOut

필드 유형 필수 설명
boards_viewers_can_write boolean

예시

터미널 창
curl -X GET "$JAMCLOUD_API/api/v1/groups/{group_id}/settings" \
-H "Authorization: Bearer $JAMCLOUD_KEY"