.boxnote形式) に変換し、1回のAPIコールでBoxファイルシステムに直接アップロードすることができます。このAPIはマークダウンからProseMirrorへの変換、事前検証、ファイルのアップロードをバックグラウンドで処理するため、ユーザーが自分で.boxnoteファイルを作成する必要がなくなります。
現在、Box Notes APIではマークダウンコンテンツからのBox Noteの作成のみがサポートされています。メモの読み取り、更新、リスト表示、削除については、既存のを介して管理できます。今後、他の入力形式や操作が追加される可能性があります。
仕組み
POST /2.0/notes/convertにリクエストを送信すると、APIは以下の手順を実行します。
Box Notes APIのバージョン
Box Notes APIは、Box APIバージョン2026.0以降で利用できます。Box Notes APIのエンドポイントに対するすべてのAPIリクエストに、2026.0に設定されたbox-versionヘッダーを含める必要があります。
詳細については、を参照してください。
サポートされる操作
| 操作 | サポートされるかどうか | 詳細 |
|---|---|---|
| 作成 (変換) | はい | POST /2.0/notes/convert |
| 読み取り | いいえ | 作成後にGET /2.0/files/{file_id}を使用 |
| 更新 | いいえ | このAPIではサポート外 |
| 削除 | いいえ | DELETE /2.0/files/{file_id}を使用 |
| リストの取得 | いいえ | を使用してください |
権限
Box Notes APIは、Boxの既存のファイルアップロード権限を利用します。新しいOAuthスコープは必要ありません。認証済みのユーザーがターゲットフォルダへのファイルアップロード権限を持っている場合、このAPIを使用してメモを作成できます。制限
| 制約 | 上限値 |
|---|---|
| コンテンツの最大サイズ | 1 MB |
| サポートされている入力形式 | マークダウンのみ |
| 変換に要する最大時間 | リクエストごとに最大30秒 |
| レスポンスのペイロード | 最小限 - typeおよびidのみ |
次の手順
入門ガイド
認証を設定し、マークダウンから最初のBox Noteを作成します。
マークダウンをBox Noteに変換
リクエストパラメータ、エラー処理、コード例が網羅された詳細なガイド。
ユースケース
AIによるメモ作成、自動レポート生成、およびサードパーティ製コンテンツのインポートに関する一般的シナリオ。