開発者はBox Notes APIを使用することで、プログラムでマークダウンコンテンツからBox Noteを作成できます。このページでは、一般的なユースケースを紹介し、使用を開始する際に役立つ実装パターンを提供します。
AIによるメモ作成
AIアシスタントやLLMを活用したアプリケーションでは、多くの場合マークダウン形式で出力が生成されます。Box Notes APIを使えば、中間形式での処理を一切行わずに、その出力をコラボレーション可能なBox Noteとして直接保存できます。
ワークフローの例:
マークダウンコンテンツを生成する
AIアシスタントが、会議の要約、調査概要、またはドキュメントの草案をマークダウン形式で作成します。
Notes APIを呼び出す
生成されたマークダウンを、ターゲットフォルダとわかりやすいファイル名を指定してPOST /2.0/notes/convertに渡します。
結果を共有する
返されたファイルIDをで使用し、メモを関連するチームと共有したり、を使用してリンクを生成したりします。
curl -L 'https://api.box.com/2.0/notes/convert' \
-H 'box-version: 2026.0' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"content": "# Meeting Summary — May 2026\n\n## Key Decisions\n\n- Approved Q3 budget\n- Launch date set for August 15\n\n## Action Items\n\n- **Alice**: Finalize vendor contracts by June 1\n- **Bob**: Prepare onboarding materials\n- **Carol**: Schedule stakeholder review",
"content_format": "markdown",
"parent": {
"id": "555555555"
},
"name": "Meeting Summary — May 2026"
}'
レポートの自動生成
ワークフロー自動化ツールを使用すると、システムが生成したレポートをスケジュールに従ってBox Noteに変換できます。この機能は、チームでの共同確認が必要なダッシュボード、週次ダイジェスト、業務概要などに役立ちます。
パターン: 以下の機能を備えた、スケジュール設定されたジョブ (cron、AWS Lambda、Azure Functionなどの自動化プラットフォーム) を作成します。
- 社内システムからデータを収集する。
- データをマークダウン (表、リスト、見出し) に変換する。
- Box Notes APIを呼び出し、共有チームフォルダ内にメモを作成します。
- 必要に応じて、Slack、メール、またはその他のチャンネルを通じて、Boxのファイルリンクをチームに通知します。
サードパーティ製コンテンツのインポート
wiki、ナレッジベース、プロジェクト管理ツール、CMSプラットフォームなど、コンテンツをマークダウンで保存している外部アプリケーションから、そのコンテンツをBox Notesにインポートし、一元的なコラボレーションとガバナンスを実現できます。
一般的なソース:
- Gitベースのwiki: リポジトリのドキュメントや
README.mdファイルをBox Noteに変換し、開発者以外の関係者に提供します。
- NotionまたはConfluenceからのエクスポート: ページをマークダウンとしてエクスポートし、Boxのフォルダ構造に一括インポートします。
- CMSコンテンツ: 承認済みのコンテンツをBox Noteとして公開し、レビューおよび承認ワークフローに活用します。
複数のファイルをインポートする際は、409 Conflictエラーを回避するために、メモごとに一意のnameを使用します。ファイル名にタイムスタンプや識別子を追加することを検討してください。
開発者向けツールとCLIワークフロー
開発者は、Box Notes APIをスクリプト、CI/CDパイプライン、またはコマンドラインツールに統合することで、開発ワークフローの一環としてメモの作成を自動化できます。
例:
- 導入後のメモ: 導入が正常に完了したら、リリース変更ログを含むBox Noteを自動的に作成します。
- インシデントの振り返り: スクリプトによってインシデントのタイムラインデータを収集し、チームで共同編集できるように構造化されたBox Noteを作成します。
- ドキュメントの同期: ローカルのマークダウンドキュメントをBox Noteに変換し、それに同期するコピーをBoxに保存しておくことで、チーム全体がアクセスできるようにします。
他のBox APIとの組み合わせ
Box Notes APIによってメモを作成します。これを他のBox APIと組み合わせることで、完結したワークフローを構築できます。
| 目標 | Box API | 詳細 |
|---|
| コラボレータとのメモの共有 | | 新しいファイルに編集者、ビューアー、または共同所有者を追加します。 |
| 共有リンクの生成 | | そのメモへの公開リンクまたは社内限定リンクを作成します。 |
| ファイルのメタデータをすべて取得 | | タイムスタンプ、所有者、サイズ、およびその他のメタデータを取得します。 |
| メモへのメタデータの適用 | | 検索や分類の目的で、メモにカスタムメタデータのタグを付けます。 |
| メモの移動またはコピー | | メモを作成して別のフォルダに移動します。 |
| メモの削除 | | 不要になったメモを削除します。 |
