レスポンスリファレンス
各 rimo コマンドが返す値をフィールド単位でまとめたリファレンスです。コマンド 自体(構文・フラグ・例)については コマンド を、出力の取り決めと エラー形式については 出力とエラー を参照してください。
このページの読み方
- 他ページからリンクされる見出しは英語のままにしています(アンカーを GitHub と ドキュメントサイトの両方で安定させるためです)。翻訳しないでください。
- 有無 は 常時(すべてのレスポンスに含まれる)か 任意 のどちらかです。 任意のフィールドは値がないときキーごと省略されます。
nullや""として 返るわけではないので、空の値と比較するのではなくキーの有無を確認してください。 唯一の例外がParticipant.user_idで、常に含まれますが Rimo アカウントを持たない話者では""になります。 - タイムスタンプは呼び出し側のローカルタイムゾーンの RFC 3339 文字列です。例:
"2026-07-05T15:45:20.47178+09:00"。 - キーの順序は取り決めの一部ではありません。順序に依存しないでください。
各コマンドが返すもの
rimo login と rimo logout は rimo auth login / rimo auth logout の エイリアスで、同じ形状を返します。
どのコマンドも失敗する可能性があり、その場合は エラーオブジェクト を出力し、0 以外の 終了コード で終わります。終了コードは失敗の種類によって決まります。
Envelopes
appointment link delete を除くすべての JSON レスポンスは、ペイロード(本体)を コンテナキーで包み、スカラーのメタデータをその隣に並べます。この包みをエンベロープと呼びます。
| エンベロープ | 返すコマンド |
|---|---|
{notes: [...], next_page_token: "..."} | note list |
{notes: [...], total_count: <int>} | note search |
{teams: [...], next_page_token: "..."} | team list |
{appointment_links: [...]} | appointment link list |
{appointment_link: {...}} | appointment link get |
{appointment_link: {...}, warnings: [...], dry_run: <bool>} | appointment link create、update、enable、disable(--fields / --excludes はリンクにだけ適用) |
{appointments: [...]} | appointment list |
{appointment: {...}, dry_run: <bool>} | appointment cancel(--fields / --excludes は appointment にだけ適用) |
{note: {...}} | note get |
{documents: [...]} | note get --list-documents |
{note: {...}, document: {...}} | note create |
{document: {...}} | note append |
{accounts: [...], active_account: "..."} | auth status |
--fields と --excludes はエンベロープの内側のレコードに適用され、スカラーの メタデータ(next_page_token、total_count、active_account)は常に保持されます。 つまり rimo note list --fields id,title は各ノートを絞り込みつつ next_page_token は残します。詳しくは 出力とエラー の「フィールドのフィルタリング」を参照して ください。
appointment link delete の結果はエンベロープで包まれない 1 件のフラットなレコードで、これらのフラグはそのキーに 適用されます(Appointment link delete result を参照)。
next_page_token はカーソルです。--page-token に渡すと次のページを取得でき、 返らなくなったら終わりです。
Note
note get と note create は {note: ...} の中で、note list は {notes: [...]} の中で返します。
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
id | string | 常時 | ノートの ID。note get、note append などのノートコマンドに渡します。 |
title | string | 常時 | ノートのタイトル。 |
state | string | 常時 | 録画・文字起こしパイプライン上の状態。ノートの state を参照。 |
duration | integer | 常時 | メディアの長さ(ミリ秒)。録音のないノートは 0。 |
created_at | string | 常時 | ノートの作成日時。 |
updated_at | string | 常時 | ノートの最終更新日時。note list --updated-since で絞り込めます。 |
user_id | string | 任意 | ノートの所有者のユーザー ID。 |
organization_id | string | 任意 | ノートが属する組織の ID。個人ノートでは省略されます。 |
team_id | string | 任意 | ノートが属するチームの ID。個人ノートでは省略されます。note list --team に渡せます。 |
locale | string | 任意 | 文字起こしの言語設定。例: ja-JP。 |
media_type | string | 任意 | 添付メディアの種別。例: audio、none。 |
source | string | 任意 | ノートの作成経路。例: none、zoom_import。連携の追加に伴い値は増えます。 |
held_at | string | 任意 | 会議の開催日時。note list --since / --until で絞り込めます。 |
memo | string | 任意 | ノートに追加された自由記述のメモ。 |
share_mode | string | 任意 | URL 共有の設定: nothing(共有しない)、view、edit。 |
custom_template_id | string | 任意 | 議事録に使ったカスタムテンプレートの ID。 |
webhook_url | string | 任意 | 処理完了時に呼ばれる Webhook。 |
document_markdown | string | 任意 | メインのドキュメントの Markdown。下の注意を参照。 |
tags | string[] | 任意 | ノートに付与されたタグ名。下の注意を参照。 |
participants | Participant[] | 任意 | 会議の参加者。下の注意を参照。 |
note list と note get はメタデータのみを返します。 document_markdown、 tags、participants は返しません。ノートのコンテンツの読み込みが重い処理であり、 多くの呼び出し側はメタデータだけを必要とするためです。コンテンツを読むには専用の フラグ(note get --document、--transcript、--full、--list-documents)を 使ってください。これらは プレーンテキスト または Document を返します。
Note states
state は録画・音声変換・音声認識を通したノートの状態を表します。値は増えうる オープンな集合として扱い、必要な値だけを判定し、未知の値も安全に扱えるように してください。
| state | 意味 |
|---|---|
NOTE_CREATED | 音源を登録せず、ノートを作成しただけの状態(note create など)。 |
NOT_SCHEDULED | Bot による自動録画が予約されていない状態。 |
RECORDING_SCHEDULED | Bot による自動録画が予約済みの状態。 |
RECORDING_WAITING | Bot が会議に参加し、録画開始(ホストの承認など)を待っている状態。 |
RECORDING_STARTED | Bot による自動録画が進行中の状態。 |
RECORDING_PAUSED | Bot による自動録画が一時停止中の状態。 |
RECORDING_DONE | Bot による自動録画が終了した状態。 |
RECORDING_FAILED | Bot による自動録画が失敗し、基本的にリトライできない状態。 |
MIC_RECORDING_REQUESTED / MIC_RECORDING_STARTED / MIC_RECORDING_DONE | マイク録音が未開始/進行中/終了の状態。 |
HARDWARE_RECORDING_REQUESTED / HARDWARE_RECORDING_STARTED | ハードウェア録音が未開始/進行中の状態。 |
TRANSCRIPTION_DONE | リアルタイム文字起こしは完了したが、メディアがアップロードされていない状態。 |
MEDIA_PREPARING | 動画・音声のアップロード中の状態。 |
VC_WAITING | 音声がアップロードされ、解析許可を待っている状態。 |
VC_REQUESTED | 音声変換の処理中。 |
VC_ERROR | 音声変換処理が失敗した状態。 |
ASR_PROCESSING | 音声認識の処理中。 |
ASR_ERROR | 音声認識処理が失敗した状態。 |
ASR_DONE | 音声認識処理が完了し、文字起こしと議事録が利用できる状態。 |
Participant
Note の participants 配列の中で返る会議の参加者です。
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
user_id | string | 常時 | 参加者の Rimo ユーザー ID。Rimo アカウントを持たない話者では空になります。note search --participant に渡せます。 |
id | string | 任意 | 内部の参加者 ID。 |
name | string | 任意 | 表示名。 |
email | string | 任意 | メールアドレス。 |
calendar_name | string | 任意 | カレンダー予定から作成されたノートでの、予定上の参加者名。 |
speaker_id | string | 任意 | 話者分離の識別子。文字起こしの各行をこの参加者に対応づけるのに使います。 |
Document
ノートに紐づくドキュメント(議事録)です。1 つのノートに複数(翻訳版、別テンプレート など)持つことができ、primary がメインのドキュメントを示します。
note get --list-documents は {documents: [...]} の中で、note create と note append は {document: ...} の中で返します。
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
id | string | 常時 | ドキュメントの ID。note append や note get --document-id に渡します。 |
note_id | string | 常時 | このドキュメントが属するノートの ID。 |
title | string | 常時 | ドキュメントのタイトル。 |
primary | boolean | 常時 | ノートのメインの議事録なら true。 |
created_at | string | 常時 | ドキュメントの作成日時。 |
updated_at | string | 常時 | ドキュメントの最終更新日時。 |
export_markdown | string | 任意 | ドキュメント本文(Markdown)。 |
locale | string | 任意 | ドキュメントの言語。例: ja-JP。 |
category | string | 任意 | ドキュメントの種別。例: agenda、summary、translation。 |
template_mode | string | 任意 | 生成に使われたテンプレート。例: minutes。 |
custom_template_id | string | 任意 | 使われたカスタムテンプレートの ID。 |
--list-documents はすべてのドキュメントの export_markdown を丸ごと含みます。 そのためレスポンスはノートのコンテンツ量に比例して大きくなり、翻訳版がいくつかある ノートでは数十 KB になることもあります。ID とタイトルだけが必要なときは本文を落として ください:
rimo note get <note_id> --list-documents --excludes export_markdownAsset
ノートのドキュメントが参照している添付ファイル(アップロードされたファイルや、 本文に埋め込まれた画像)です。
note asset list が {assets: [...]} の中で返すほか、note asset upload がアップロードした添付ファイル 1 件を {asset: ...} として、note asset get --json が AssetDetail の asset として返します。
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
id | string | 常に | 添付ファイルの ID。 |
name | string | 常に | ファイル名。 |
mime_type | string | 任意 | ファイルの MIME タイプ。不明な場合は省略されます。 |
size_bytes | integer | 任意 | ファイルサイズ(バイト)。不明な場合は省略されます — 本文に埋め込まれた画像は通常サイズを持ちません。 |
uploaded_at | string | 常に | アップロード日時。 |
summary_status | string | 常に | summary があるかどうか: none(現時点で要約が無く、解析がまだ始まっていないこともある — アップロード直後の添付ファイルは pending や processing に変わる前にしばらく none になることがある。解析対象外のファイル形式や、読み取れる内容が無かった場合、ノートの解析済み画像が上限に達していて画像の解析がスキップされた場合も none)、pending(解析待ち)、processing(解析中)、completed(要約がある)、failed(直近の解析が失敗した。自動で再試行される失敗もあるため、後で変わることがあります)。 |
summary | string | 任意 | 添付ファイルの解析で作成された短い要約。summary_status が completed のときに限り含まれます。 |
AssetDetail
添付ファイル1件と、その解析結果・抽出テキストです。note asset get --json が返します (--json を付けない場合は同じ内容を Markdown で出力します — Attachment を参照)。1件のレコードなので、--fields / --excludes は トップレベルのキーに適用されます(--excludes content でメタデータのみになります)。
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
asset | Asset | 常に | 添付ファイルの詳細。解析済みの場合は summary を含みます。 |
analysis | object | 常に | 解析状態(以下のフィールド)。 |
analysis.status | string | 常に | none(未解析)、pending、processing、completed、unsupported(解析対象外の形式)、skipped(ノートの解析済み画像が上限(200件)に達していたため、画像を解析しなかった。error_code は image_limit_reached、添付ファイルの summary_status は none)、failed のいずれか。 |
analysis.error_code | string | 任意 | 解析に失敗した理由。skipped の画像では image_limit_reached。 |
analysis.coverage | string | 任意 | テキストの取得方法: text、ocr、visual_description、partial(一部のみ読み取れた)、none。 |
analysis.page_count | integer | 任意 | ページ数(分かる場合)。 |
analysis.unreadable_page_count | integer | 任意 | 読み取れなかったページ数(分かる場合)。 |
analysis.vision_applied | boolean | 常に | 画像認識で画像を読み取ったかどうか。 |
analysis.unread_visuals | object | 任意 | 読み取られなかった画像やグラフ: count、kinds、pages、pages_truncated(ページの一覧が途中で打ち切られている)。 |
analysis.card | object | 任意 | 解析が完了した場合のみ: summary、document_type(不明な場合は省略)、language。 |
content | string | 任意 | 抽出テキスト(Markdown)。保存されている内容をそのまま、<!-- @loc page_from=… page_to=… --> のページマーカーも含めて返します。まだ無い場合は省略されます。解析に失敗した場合でも含まれることがあります。 |
content_size_bytes | integer | 任意 | 抽出テキスト全体のサイズ(バイト)。 |
content_truncated | boolean | 任意 | content が 1 MiB で(MCP ツール note_get_asset では 200,000 文字で)切り詰められた場合に true。 |
添付ファイルを読み取っても、解析が開始・再実行されることはありません。
Team
team list が {teams: [...]} の中で返します。
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
id | string | 常時 | チームの ID。note list --team、note search --team、note create --team に渡せます。 |
name | string | 常時 | チーム名。Rimo アプリ上で見えるフォルダ名です。 |
category | string | 任意 | チームフォルダなら "team"。"organization" は組織自身のフォルダで、--include-organization を指定したときだけ返ります。id は組織の ID です。 |
is_private_channel | boolean | 常時 | チームのメンバーだけがノートを閲覧できる場合に true。 |
member_ids | string[] | 常時 | チームに所属するユーザーの ID。 |
created_at | string | 常時 | チームの作成日時。 |
updated_at | string | 常時 | チームの最終更新日時。 |
parent_id | string | 任意 | 親チームの ID。 |
description | string | 任意 | チームの説明。 |
Appointment link
appointment link list が {appointment_links: [...]} の中で返します。 appointment link get は同じフィールドにリンクの設定を加えて返します。 Appointment link detail を参照してください。
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
id | string | 常時 | リンクの ID。appointment link get や appointment list に渡せます。create --dry-run のレスポンスでは ""。 |
url | string | 常時 | ゲストに共有する予約ページ。create --dry-run のレスポンスではリンクがまだ無いため ""。 |
edit_url | string | 常時 | Rimo アプリでリンクを編集する画面。カレンダーや会議ツールの連携もここから行います。create --dry-run のレスポンスでは ""。 |
title | string | 常時 | リンクのタイトル。 |
duration_minutes | integer | 常時 | 打合せ時間(分)。 |
disabled | boolean | 常時 | 受付を停止している(appointment link disable)場合に true。新しい予約は入りません。appointment link enable で再開できます。 |
closed | boolean | 常時 | 単発リンクに appointment が入り、受付を終了した場合に true。再度有効化はできません。 |
single_use | boolean | 常時 | 最初の appointment で受付を終了するリンクなら true。 |
calendar_provider | string | 常時 | google または outlook。空き時間の確認と予定の作成に使うカレンダー。 |
meeting_providers | string[] | 常時 | 会議 URL を発行する順番(google_meet、zoom、microsoft_teams)。空の場合は会議 URL を発行しません。 |
participants | object[] | 常時 | すべての appointment に同席する組織内のメンバー。user_id と、取得できた場合は name・email。 |
created_at | string | 常時 | リンクの作成日時。 |
updated_at | string | 常時 | リンクの最終更新日時。 |
Appointment link detail
appointment link get、create、update、enable、disable が {appointment_link: {...}} の中で 返します。Appointment link のすべてのフィールドに、以下のリンクの設定が加わります。 フィールド名は create -f と update -f のファイルと同じです。
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
description | string | 常時 | 予約ページでゲストに表示する説明。 |
availability_rules | object[] | 常時 | 受付時間。weekday(整数。0 が日曜日 … 6 が土曜日)、start_time と end_time(time_zone の HH:MM)。同じ曜日が複数回現れることがあります。 |
time_zone | string | 常時 | 受付時間・closes_on・time_overrides を解釈する IANA タイムゾーン(例: Asia/Tokyo)。 |
days_in_advance | integer | 常時 | 何日先まで予約を受け付けるか。 |
closes_on | string | 常時 | 受付を終了する日(time_zone の YYYY-MM-DD)。空文字は期限なし。 |
min_notice_hours | integer | 常時 | 予約から開始までに最低限あける時間(時間)。 |
buffer_before_minutes | integer | 常時 | 既存の予定の前に確保する時間(分)。0 は確保しません。 |
buffer_after_minutes | integer | 常時 | 既存の予定の後に確保する時間(分)。0 は確保しません。 |
appointment_slot_interval_minutes | integer | 常時 | 候補の開始時刻の刻み幅(分)。0 は打合せ時間と同じ刻み幅。 |
cancellation_deadline_hours | integer | 常時 | ゲストが予約をキャンセルできる期限(開始の何時間前まで)。0 は開始直前まで。 |
auto_reserve_recording | boolean | 常時 | 予約された会議を自動で録画する場合に true。 |
disable_appointment_confirmed_email | boolean | 常時 | 予約確定メールを送らない場合に true。 |
share_note_with_guest | boolean | 常時 | 会議後のノートをゲストに共有する場合に true。 |
include_keywords | string[] | 常時 | タイトルにいずれかを含む予定を空き時間として扱うキーワード(大文字・小文字を区別しません)。 |
include_keywords_only | boolean | 常時 | include_keywords に一致した予定の時間帯だけを候補にする場合に true。 |
exclude_keywords | string[] | 常時 | タイトルにいずれかを含む予定の時間帯を候補から除外するキーワード。include_keywords より優先されます。 |
holiday_countries | string[] | 常時 | 祝日を候補から除外する国(ISO 3166-1 alpha-2。例: JP)。 |
time_overrides | object[] | 常時 | 日付指定の受付調整。type(block はその時間を除外、open はカレンダーに予定があっても候補にする)、start_date / end_date(YYYY-MM-DD。両方空なら毎日)、start_time / end_time(HH:MM)、ホスト向けの note。 |
poll_enabled | boolean | 常時 | 先に複数人の都合を集めてからホストが日程を確定するリンクなら true。 |
Appointment link warning
appointment link create、update、enable、delete が warnings の中で返します。コマンドの実行は止めないものの、知っておくべき点です。 それぞれ stderr にも warning: … の 1 行として出力されます。
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
code | string | 常時 | 機械可読な種別(例: create・update・enable の meeting_provider_unavailable、keywords_ignored_for_plan、delete の link_had_upcoming_appointments)。 |
field | string | 任意 | 対象の設定のパス(例: meeting_providers[0])。 |
message | string | 常時 | 内容と対処方法。 |
Appointment link delete result
appointment link delete が返します。エンベロープではない 1 件のフラットなレコードで、--fields と --excludes は これらのキーに適用されます。
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
deleted | boolean | 常時 | リンクを削除した場合は true。--dry-run では false。 |
appointment_link_id | string | 常時 | リンクの ID。 |
upcoming_appointments | integer | 常時 | リンクにあった今後の予約(確定済みで開始時刻が現在以降)の件数。0 より大きくなるのは --keep-appointments を付けた場合だけです(付けないとそのようなリンクは link_has_upcoming_appointments で拒否されます)。 |
warnings | Appointment link warning[] | 常時 | 今後の予約を残した場合の link_had_upcoming_appointments。予約は残りますが、Rimo から一覧もキャンセルもできなくなります。stderr にも出力されます。 |
dry_run | boolean | 常時 | --dry-run の場合は true(確認だけを行い、何も削除していません)。 |
Appointment
appointment list が {appointments: [...]} の中で、appointment cancel が {appointment: {...}, dry_run} の中で返します。
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
id | string | 常時 | appointment の ID。 |
appointment_link_id | string | 常時 | appointment が入った appointment link の ID。 |
status | string | 常時 | confirmed。appointment cancel の結果では cancelled。appointment list は確定済みの appointment だけを返します。 |
start_at | string | 常時 | 開始日時。 |
end_at | string | 常時 | 終了日時。 |
guest_name | string | 常時 | ゲストの名前。 |
guest_email | string | 常時 | ゲストのメールアドレス。 |
guest_message | string | 常時 | ゲストが予約時に入力したメッセージ。なければ空文字。 |
guest_participants | object[] | 常時 | ゲストが招待した同席者(name、email)。 |
meeting_url | string | 常時 | 会議 URL。発行しなかった場合は空文字。 |
meeting_provider | string | 常時 | 実際に meeting_url を発行したツール。先頭のツールで発行できなかった場合はリンクの設定と異なることがあります。発行しなかった場合は空文字。 |
calendar_provider | string | 常時 | google または outlook。予定を作成したカレンダー。 |
cancelled_at | string | null | 常時 | appointment がキャンセルされた日時。確定済みのあいだは null のため、appointment list と --dry-run のキャンセル結果では null です。 |
created_at | string | 常時 | appointment が作成された日時。 |
Search result
note search が {notes: [...], total_count} の中で返す検索ヒットです。完全な Note ではなく、検索インデックスが返した内容だけを持ちます。
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
id | string | 常時 | ノートの ID。note get に渡せます。 |
title | string | 任意 | ノートのタイトル。 |
held_at | string | 任意 | 会議の開催日時。 |
created_at | string | 任意 | ノートの作成日時。 |
owner_name | string | 任意 | ノート所有者の表示名。--mode=filter のみ。 |
snippet | object | 任意 | ヒット箇所の抜粋。--mode=filter のみ。下記参照。 |
--mode=filter では、total_count は権限フィルター前の生のマッチ数です。現在の ページではなく結果全体を数えており、これが --page / --per によるページ送りを 成り立たせています。--mode=semantic では返却された一意なノート数になります。
snippet はヒット箇所の抜粋を持ち、マッチした語は強調表示のため HTML タグで 囲まれます。各キーは文字列の配列で、4 つのキーはすべて存在します(その箇所が マッチしなかった場合は空配列)。
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
transcripts | string[] | 常時 | 文字起こしからの抜粋。 |
headings | string[] | 常時 | 見出しからの抜粋。 |
annotations | string[] | 常時 | アノテーションからの抜粋。 |
document_markdowns | string[] | 常時 | ドキュメント本文からの抜粋。 |
認証系のレスポンス
Login and switch result
auth login(および rimo login)と auth switch が返します。すべての フィールドが常に含まれます。
| フィールド | 型 | 説明 |
|---|---|---|
status | string | auth login では logged_in、auth switch では switched。 |
alias | string | アカウントのエイリアス。--account で使います。 |
email | string | サインインしたメールアドレス。 |
name | string | 表示名。未設定ならメールアドレス、次にユーザー ID にフォールバック。 |
org | string | 組織名。未設定なら組織 ID、次に Personal にフォールバック。 |
Logout result
auth logout(および rimo logout)が返します。すべてのフィールドが常に 含まれます。
| フィールド | 型 | 説明 |
|---|---|---|
status | string | 常に logged_out。 |
alias | string | ログアウトしたエイリアス。 |
active_account | string | ログアウト後のアクティブなアカウント。自動昇格はしないため、アクティブだったアカウントをログアウトした場合は空になります。 |
Auth status
auth status が返します。
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
active_account | string | 常時 | アクティブなアカウントのエイリアス。 |
accounts | object[] | 常時 | 保存されているすべてのアカウント。下記参照。 |
active_credential | string | 任意 | 環境変数が設定済みアカウントを上書きしている場合のみ含まれます: env:RIMO_API_KEY または env:RIMO_TOKEN。含まれるときは、active_account ではなくその認証情報がリクエストを認証しています。 |
api_key_hint | string | 任意 | キーをマスクした表示。env:RIMO_API_KEY のときのみ含まれます。 |
accounts の各要素:
| フィールド | 型 | 有無 | 説明 |
|---|---|---|---|
alias | string | 常時 | アカウントのエイリアス。--account で使います。 |
name | string | 常時 | 表示名。 |
org | string | 常時 | 組織名。 |
active | boolean | 常時 | アクティブなアカウントなら true。 |
token_status | string | 常時 | valid、expiring_soon、expired、unknown(有効期限を判定できなかった場合)。 |
email | string | 任意 | アカウントのメールアドレス。 |
auth status は報告の前に期限切れ・期限間近のトークンを更新するため、 token_status は認証情報ストアに最後に書かれた値ではなく現在の状態を反映します。
プレーンテキストの出力
以下のコマンドは、JSON で包むとかえって扱いにくくなるため、成功時にプレーンテキスト を出力します。エラーは JSON のままです — 出力とエラー を参照してください。
Note content
note get にコンテンツ系フラグを付けると、ノートの中身をそのまま出力します。
| フラグ | 出力 |
|---|---|
--transcript | 文字起こしのセグメントごとに 1 行、Speaker: content 形式。話者を特定できなかったセグメントは本文のみを出力します。空のセグメントはスキップされます。 |
--document | メインのドキュメントの Markdown。先頭に # <title> が付きます。 |
--full | 文字起こし、空行、メインのドキュメントの順。ドキュメントに配置された添付ファイルは、その位置に [<name>](<asset_id> "<要約>")(画像は 、要約が無い場合はタイトルなし)として表示します。ドキュメントに配置されていない添付ファイルがある場合は、続けて空行と ## Attachments を出力します(添付ファイルごとに - <name> (<id>, <size>[, image]) の行と、要約がある場合は次の行に 2 文字下げた要約)。 |
--document-id <id> | 指定したドキュメントの Markdown。--document と同じ形式です。 |
--meeting-chat | ウェブ会議チャットのメッセージごとに 1 行、[HH:MM] sender: text 形式。[HH:MM] と sender: は取得できない場合に省略され、空のメッセージはスキップされます。 |
--timestamps | --transcript / --full と併用すると、文字起こしの各行に [HH:MM:SS] を付与。録音開始からの経過時間であり、実時刻ではありません。開始時刻のないセグメントには付きません。 |
文字起こしやチャットのないノートでは何も出力せず、終了コード 0 で終わります。
Attachment
note asset get(--json なし)は添付ファイル1件を Markdown で出力します: # <name>、- Key: value 形式のヘッダー(ID、種類、サイズ、アップロード日時、解析状態、 coverage、ページ数、文書の種類、言語)、結果が完全でない場合の引用形式の注記(未解析、 解析待ち、解析中、対象外、解析済み画像の上限によるスキップ、失敗、部分的な読み取り、読み取られていない画像、切り詰め)、 存在する場合は ## Summary、最後に保存されている抽出テキストをそのまま出力する ## Content。内容の後には何も出力されないため、出力の末尾からそのまま切り出せます。この出力と、note get --full が追加する添付ファイルの名前と要約からは、端末の制御文字 (エスケープ文字や復帰文字など)を取り除きます。タブ・改行やその他の文字はそのままです。 加工されていない値は --json で取得できます。
Ask answer
note ask は回答を生成されるそばからストリーミングし、続けて Sources: ブロック (回答本文にインラインの引用は含まれないため、ここが正式な引用元の表示です)、 Fetch a note: ブロックを出力します。例外的にこの 3 つはすべて stdout に 出力されるため、stdout が機械可読でない唯一のコマンドです。実際の例は rimo note ask を参照してください。
Version and upgrade
どちらも stdout に 1 行だけ出力します。正確な文字列は rimo version と rimo upgrade を参照してください。
Dry-run output
appointment link create の --dry-run にはサーバーが応答します。リクエストを ?dry_run=true 付きで送り、 サーバーが実際の作成と同じ補完と検証を行って、作成されるリンク(プレースホルダーではなく、自分の設定)を "dry_run": true 付きで返します。何も保存されません。リンクはまだ存在しないため id、url、edit_url は "" です。共有する url は実際の作成で得られます。
appointment link update の --dry-run も同じです。サーバーが実際の変更と同じ検証を行い、変更後のリンクを "dry_run": true 付きで返します。何も保存されません。リンクはすでに存在するため、id と url は実際の値です。 appointment link enable と disable の --dry-run も同じように受付の切り替えを確認します(enable は再開時の検証も行います)。
appointment link delete の --dry-run もサーバーに問い合わせます。サーバーは実際の削除と同じ確認を行い (今後の予約があるリンクは、--keep-appointments を付けない限り link_has_upcoming_appointments で拒否されます)、 削除せずに "deleted": false, "dry_run": true を返します。
appointment cancel の --dry-run もサーバーに問い合わせます。サーバーは実際のキャンセルと同じ確認を行い (キャンセル済みの appointment は appointment_already_cancelled で拒否されます)、キャンセルせずに現在の appointment(confirmed のまま)を "dry_run": true 付きで返します。ただしカレンダーの予定は確認しないため、 ドライランが通っても実際のキャンセルが calendar_event_delete_failed で失敗することがあります。
それ以外の書き込み系コマンド(note create、note append)に --dry-run を付けると、 リクエストは送信されません。レスポンス形状の代表的な例に "dry_run": true を 加えたものが返ります:
{
"document": { "id": "doc_abc123", "primary": true, "...": "..." },
"dry_run": true
}値は API スキーマ由来のプレースホルダーであり、入力内容のプレビューではありません。 レスポンスの形状の確認とコマンドが正しく解釈されるかの確認に使い、作成されるノートの 中身を見る用途には使えません。
読み取り系コマンドで --dry-run を指定すると dry-run not supported for read operations で拒否されます。
