お客様の社内のシステムや AI(自社で作ったチャットボット・社内ポータル・業務システムなど)から、Dive の公開済みの手順書を探して読めるようにする API です。オーナーが発行する鍵(API キー)で呼び出します。返す答えには、その手順を Dive で開くリンクが付きます。
人が使う AI(Claude・ChatGPT など)から、ご本人の Dive のアカウントで手順書を探して読む場合は、AI との接続(MCP) をご利用ください。API は、会社のシステムから会社の鍵で読む機能です。システムを使う方に Dive のアカウントは要りません(動画を開くときは Dive へのログインが必要です)。
Enterpriseプランでご利用いただけます。鍵の発行と設定は、オーナーが PC ブラウザから行います。β版として提供しています。
※ ご利用の前に、この記事の下部にある「遵守事項および免責事項」を必ずお読みください。本機能をご利用いただいた場合は、その内容に同意いただいたものとみなします。
API でできること
API でできるのは、手順書を探すことと読むことの2つだけです。手順書を作る・直す・消すことはできません。
- 探す:語を送ると、当たった公開済みの手順書を、当たりの良い順に返します。手順書の題名・手順の名前・作業の内容・コツ・品質・安全・使用物・文書番号・タグ・ファイル手順書の本文・動画の字幕などから探し、当たった箇所の抜粋と、Dive で開くリンクを付けます
- 読む:手順書の題名・文書番号・概要・使用物・関連ファイルの題名と、手順ごとの作業の内容・コツ・品質・安全・標準時間を返します。ファイル手順書(PDF などの今あるマニュアル)は、各ページの本文を返します。手順ごとに、その手順から Dive で開くリンクが付きます
返すのは、鍵の範囲(下の「鍵が返す手順書の範囲」)の公開済みの手順書だけです。下書きは返しません。動画・画像と、関連ファイルの中身は返しません。設問や、作成者などの人の名前も返しません。
使う前に(オーナーが鍵を発行する)
鍵の発行は、オーナーが PC ブラウザから行います。
- サイドメニュー [オーナー向け機能] を開きます
- 上部タブの [連携] を選び、[API(手順書を探す・読む)] のカードを表示します([AI との接続(MCP)] のカードの下にあります)
- [鍵を発行] をクリックします
- 名前・見せるグループ・接続元の IP アドレス・期限を決めて、[発行] をクリックします(それぞれの意味は、下の「鍵ごとに決めること」をご覧ください)
- 発行した鍵が表示されます。鍵と [API の URL] を社内のシステムの設定に写してから、[写したので閉じる] をクリックします
鍵は、発行したこのときだけ表示します。閉じると二度と表示できません。写し忘れた場合は、その鍵を取り消して、新しい鍵を発行してください。鍵は、画面の写し(スクリーンショット)に写さないでください。
鍵を発行すると、チームのオーナー全員に、鍵が発行されたことをお知らせするメールが届きます。心当たりのない発行のお知らせが届いた場合は、下の「鍵を変える・取り消す」の手順で取り消してください。
Enterprise 以外のプランでも、カードは表示されます。[鍵を発行] をクリックすると、プランのご案内が表示されます。
鍵ごとに決めること
- 名前:どのシステムで使う鍵かが分かる名前です(60文字まで)。例「社内チャットボット(本番)」
- 見せるグループ:鍵が返す手順書の範囲を決めます。下の「鍵が返す手順書の範囲」をご覧ください
-
接続元の IP アドレス:API を呼び出すサーバー(社内のシステムが動いている所)の、インターネットへの出口のアドレスです。登録すると、そこからの呼び出しだけを受けます。IPv4 のアドレスか、/16〜/32 の範囲(例:
203.0.113.0/24)を、1行に1つ、20個まで登録できます。IP アドレス制限を使っているチームでは必須です - 期限:30日・90日・1年から選びます(初期状態は1年)。期限の日の、発行した時刻に切れます。期限は延ばせません
有効な鍵は、1チーム5本までです。5本ある場合は、使っていない鍵を取り消すと、新しい鍵を発行できます。
鍵が返す手順書の範囲(見せるグループ)
鍵が返すのは、[見せるグループ] で選んだグループすべてに所属する閲覧ユーザーが、Dive の画面で探したときに見られる範囲の、公開済みの手順書だけです。グループで絞っていないフォルダの手順書は、いつも返ります。
- グループを選ばなければ、グループで絞っていないフォルダの手順書だけを返します
- 複数のグループを選ぶと、「選んだグループすべてに所属する1人」として範囲を決めます。それぞれのグループの方が見られる範囲を足し合わせたものより、広くなることがあります
- オーナー・チーム管理者が見られる範囲(すべての手順書)にはなりません。どのグループの方も見られないフォルダの手順書は返しません
- チームの [フォルダの閲覧範囲] の設定は、閲覧ユーザーと同じように効きます(配下グループのフォルダも閲覧できるようにする(フォルダの閲覧範囲))
- 選んだグループを削除すると、そのグループは無いものとして扱います
範囲は、鍵の行の虫めがねのアイコン [この鍵で試す] で確かめられます。語を入れて [探す] をクリックすると、その鍵の範囲で探した結果(手順書の題名とフォルダ)が表示されます。[この鍵で試す] は、API の呼び出しには数えません。
API を呼び出す
API は、社内のサーバーから HTTPS で呼び出します。ブラウザの画面(JavaScript)から直接は呼び出せません。鍵がページに載ってしまうためです。
- API の URL:
https://api.divedx.com/v1 - 仕様(OpenAPI 3.0):
https://api.divedx.com/v1/openapi.json(鍵なしで読めます) - 鍵の渡し方:ヘッダーに
Authorization: Bearer 鍵を付けます
応答には、今後項目が増えることがあります。知らない項目は読み飛ばすように作ってください。β版の間は、応答の形が変わることがあります。
手順書を探す
POST /procedures/search に、探す語(query・200文字まで)と、返す件数(limit・1〜20、初期値5)を JSON で送ります。
curl -X POST https://api.divedx.com/v1/procedures/search \
-H "Authorization: Bearer dapi_..." \
-H "Content-Type: application/json" \
-d '{"query":"フライヤー 清掃","limit":5}'
当たりの良い順に、手順書の一覧が返ります。当たらなかった場合は、空の一覧("results": [])が返ります。
{
"results": [
{
"id": "-NaBcD1",
"versionId": "-NxYzW9",
"version": 3,
"title": "フライヤーの清掃",
"documentNumber": "QC-012",
"folder": "清掃",
"kind": "steps",
"language": "ja",
"updatedAt": "2026-10-01T09:30:00+09:00",
"matches": [{ "field": "safety", "step": 3, "text": "…油が冷めてから…" }],
"url": "https://app.divedx.com/view/-NxYzW9?step=3"
}
],
"requestId": "req_…"
}
| 項目 | 内容 |
|---|---|
id |
手順書の ID です。改訂しても変わりません。読むときに使います |
versionId・version
|
いま公開している版の ID と、版の番号です |
title・documentNumber・folder
|
題名・文書番号・手順書が入っているフォルダの名前です |
kind |
steps(手順に分かれた手順書)か file(ファイル手順書)です |
language |
手順書の原文の言語です(ja・en・zh-CN など) |
matches |
当たった箇所です(欄・手順の番号またはページ・抜粋)。1件につき3つまでです |
url |
Dive で開くリンクです(Dive へのログインが必要です)。手順に当たった場合は、その手順から開きます |
手順書を読む
GET /procedures/{id} で、探した結果の id(または versionId)を指定して、手順書を読みます。いつも、いま公開している版を返します。
curl https://api.divedx.com/v1/procedures/-NaBcD1 \ -H "Authorization: Bearer dapi_..."
返す主な項目は次のとおりです。
- 題名・文書番号・概要(
description)・使用物(usedItems:名前・品番・量・単位)・関連ファイル(relatedFiles:閲覧者に見せる設定のものの題名と種類だけ) - 手順(
steps):手順の番号・名前と、作業の内容(work)・コツ(tips)・品質(quality)・安全(safety)・標準時間(standardTimeSec・秒)、その手順から Dive で開くリンク(url) - ファイル手順書(
kindがfile)の場合は、各ページの本文(pages)。スキャンした PDF など、本文を読めないファイルはnoteでお知らせします
長い手順書は途中で切って返します。truncated が true の場合は、next に入っている fromStep(ファイル手順書は fromPage)を付けて、続きを呼び出してください。fromStep・toStep・fromPage・toPage で、読む範囲を指定することもできます。1つの欄が長い場合は、4,000文字(ファイル手順書の1ページは8,000文字)で切り、末尾に「…」を付けます。
手順書が無い場合、鍵の範囲の外の場合、下書きしか無い場合は、いずれも 404 を返します。
回数の上限
- 鍵ごとに1分120回・1日約2万回(日本時間)、チームごとに1分600回までです
- 上限を超えると 429 を返します。
Retry-Afterヘッダーの秒数だけ待ってから、もう一度呼び出してください - 登録されていない鍵で、同じ接続元から続けて呼び出した場合も、しばらく 429 を返します
エラーのとき
エラーは、HTTP の状態コードと、本文の code で分かります(RFC 9457 の形式)。応答の X-Request-Id ヘッダー(本文の requestId と同じ)は、お問い合わせの際にお知らせください。
| 状態 | code | 主な原因と対処 |
|---|---|---|
| 400 | invalid_request |
本文が読めない・知らない項目がある・値が範囲の外です。送る内容を確かめてください |
| 401 | invalid_key |
鍵が無い・違います。ヘッダーの形(Authorization: Bearer 鍵)を確かめてください |
| 401 | key_expired |
鍵の期限が切れています。新しい鍵を発行して入れ替えてください |
| 401 | key_revoked |
鍵が取り消されています。新しい鍵を発行して入れ替えてください |
| 403 | plan |
チームのプランで API を使えません(Enterprise プランでご利用いただけます) |
| 403 | ip_not_allowed |
鍵に登録した接続元の IP アドレスの外から呼び出しています |
| 403 | ip_required |
IP アドレス制限を使っているチームで、鍵に接続元の IP アドレスが登録されていません |
| 403 | forbidden |
ブラウザから呼び出しています。社内のサーバーから呼び出してください |
| 404 | not_found |
手順書が無い・鍵の範囲の外・下書きだけ、または URL の誤りです |
| 405 | method_not_allowed |
メソッドの誤りです(探すは POST、読むは GET) |
| 413 | payload_too_large |
本文が大きすぎます(16KB まで) |
| 429 | rate_limited |
回数の上限を超えました。Retry-After の秒数だけ待ってください |
| 503 | unavailable |
一時的に処理できません。時間をおいて、もう一度呼び出してください |
使われ方を確認する(オーナー)
[API(手順書を探す・読む)] のカードの [利用の状況] を開くと、直近7日・30日・90日に API で探した回数・読んだ回数・誤りの回数を、鍵ごとに確認できます。手順書ごとの読まれた回数も確認できます。探した語を含む明細は、[明細を CSV で出力] から出力できます。
鍵の期限・プラン・接続元の IP アドレス・回数の上限で断った呼び出しも、同じ鍵・同じ理由で1分に1件まで「誤り」に数えます。社内のシステムからの呼び出しが止まったときは、ここで確かめられます。
呼び出しの記録は400日残ります。鍵の発行・変更・取り消しと、明細を CSV で出力した記録は、監査ログにも残ります(監査ログをCSV出力する)。API で探した語は、オーナーが確認できます。社内のシステムを使う方へのお知らせは、お客様の側でお願いします。
鍵を変える・取り消す
- 名前・見せるグループ・接続元の IP アドレスは、鍵の行の鉛筆のアイコン(変更)から変えられます。鍵の値と期限は変えられません
- 取り消すには、鍵の行のごみ箱のアイコン(取り消す)をクリックし、確認の表示で [取り消す] をクリックします。取り消した鍵は元に戻せません
- 変更と取り消しは、30秒ほどで API の呼び出しに反映されます
- 取り消した鍵と期限が切れた鍵は、一覧に30日間表示します
期限と入れ替え
期限の30日前と7日前に、オーナーにメールでお知らせします(期限が30日の鍵は7日前だけ)。期限は延ばせないため、新しい鍵を発行して社内のシステムの設定を入れ替え、古い鍵を取り消してください。入れ替えの間は、新しい鍵と古い鍵の両方を使えます。
プランを変えたとき・IP アドレス制限を使い始めたとき
- Enterprise から別のプランに変えると、API の呼び出しは断られます(
plan)。鍵は残り、Enterprise に戻すとそのまま使えます。鍵の一覧と取り消しは、プランを変えた後も使えます - 後から IP アドレス制限を使い始めた場合、接続元の IP アドレスを登録していない鍵は使えなくなります(
ip_required)。鍵の行の鉛筆のアイコンから IP アドレスを登録すると、使えるようになります - 鍵に登録する IP アドレスは、鍵ごとの登録です。チームの IP アドレス制限の許可リストには足されず、ふだんのログインには効きません
よくある質問
Q. AI との接続(MCP)との違いは何ですか?
A. AI との接続は、Claude・ChatGPT など一覧にある AI から、つないだご本人のアカウントの権限で読む機能です(Lite, Core, Pro, Enterpriseプラン)。API は、自社で作ったシステムから、オーナーが発行した鍵の範囲で読む機能です(Enterpriseプラン)。
Q. API で読んだ手順書は、閲覧記録に残りますか?
A. 残りません。API で読んでも、閲覧記録・ひとり立ちの判定・スキルの自動評価には数えません。API の使われ方は、[利用の状況] で確認できます。
Q. 公開したばかりの改訂の内容が返ってきません。
A. 公開の直後の数分は、前の版の文章を返すことがあります。時間をおいて、もう一度呼び出してください。
Q. 翻訳した文章を受け取れますか?
A. 受け取れません。手順書の原文の言語のまま返します。原文の言語は language で分かります。
Q. 手順書の一覧をまとめて取得できますか?
A. できません。API は、必要なときに探して読む使い方を前提にしています。手順書の写しを社内に作らず、そのつど Dive の公開済みの最新の版を読むことで、古い手順書が社内に残らないようにするためです。
Q. 社内の AI の基盤から使えますか?
A. OpenAPI(3.0)の仕様を読み込み、Authorization ヘッダーに鍵を付けて呼び出せるものであれば、道具として登録できます。登録のしかたは、ご利用の基盤のヘルプでご確認ください。
遵守事項および免責事項
本機能は、お客様のシステムと Dive をつなぐ機能です。ご利用には Dive 利用規約が適用され、本項の遵守事項および免責事項は、同規約に加えて適用されます。以下の事項を必ずご確認のうえ、同意したうえでご利用ください。本機能をご利用いただいた場合は、以下の事項に同意いただいたものとみなします。
お客様のシステムや、お客様が利用する AI の基盤などの第三者のサービスに関すること(設計・開発・設定・運用・動作・不具合・回答の内容)は、当社が取り扱うことのできない範囲であるため、サポートの対象外です。また、本機能は β版のため、Dive の側の動作についてのお問い合わせも、当社の判断により可能な範囲での対応となります。
1. 鍵の管理
(1) 鍵は、チームの手順書の文章を読み出せる会社の鍵です。鍵の値は、お客様の責任において厳重に管理してください。鍵を、ブラウザで動く画面、公開されたソースコード、チャット、メール等に載せないでください。
(2) 鍵が漏えいした場合、またはそのおそれがある場合は、速やかに鍵を取り消し、新しい鍵を発行してください。接続元の IP アドレスの登録をおすすめします。
(3) 使わなくなった鍵は、速やかに取り消してください。
(4) 鍵の管理の不備等によって生じた損害について、当社は一切の責任を負いません。
2. 渡す手順書の範囲と、お客様のシステムを使う方
(1) 鍵が返す手順書の範囲は、オーナーが鍵ごとに選んだグループと、チームのフォルダの閲覧の設定で決まります。範囲は [この鍵で試す] でご確認のうえ、お客様の責任において設定してください。
(2) API が返した手順書の文章は、お客様のシステムを使う方(Dive のアカウントを持たない方を含む)に届きます。お客様のシステムでの表示・保存・利用者の範囲は、お客様の責任において管理してください。
(3) API で探した語と読んだ手順書は記録され、オーナーが確認できます。お客様のシステムを使う方へのお知らせは、お客様の責任において行ってください。
(4) 範囲の設定や、お客様のシステムの管理の不備等によって生じた情報の漏えい、その他の損害について、当社は一切の責任を負いません。
3. お客様のシステム・AI の回答の正確性
(1) お客様のシステムや AI が、API の返した文章をもとに作る回答は、要約、言い換え、省略、誤りを含むことがあります。AI が、手順書に書かれていない内容を補って回答することもあります。
(2) 作業や判断の前には、必ず回答に付く Dive のリンクから手順書の原文をご確認ください。特に、安全・品質に関わる内容は、システムや AI の回答だけで判断しないでください。
(3) お客様のシステムや AI の回答に基づいて行った作業・判断の結果、およびそれによって生じた事故・損害について、当社は一切の責任を負いません。
4. 第三者が提供するサービスの利用に関する免責
お客様が API とつなぐために利用する第三者のサービス(AI の基盤・クラウドサービス等)は、それぞれの提供者が定める規約に従って提供されます。それらのサービスに送られた手順書の文章の保存、利用、AI のモデルの学習への再利用等の取り扱いは、それぞれの提供者が定める規約および設定に従います。学習を無効にする設定(オプトアウト)等がなされていることを、お客様の責任において必ずご確認ください。それらのサービスの通信経路の安全性、情報の秘匿性、可用性および適法性について、当社は保証いたしません。それらのサービスの不具合・停止・仕様の変更、ならびにその利用に伴うセキュリティ上の問題や損害について、当社は一切の責任を負いません。
5. 無保証・変更・停止
(1) 本機能は β版として提供するものであり、完全性、正確性、可用性、有用性、セキュリティ性、第三者の権利の非侵害、および特定の目的への適合性について、何ら保証するものではありません。
(2) 当社は、本機能の内容・仕様(応答の形・回数の上限を含みます)、およびご利用いただけるプランを、予告なく変更し、または本機能の提供を一時停止もしくは終了することがあります。これらによってお客様に生じた損害について、当社は一切の責任を負いません。最新の情報をご確認のうえ、お客様の判断と責任においてご利用ください。
6. 法令・規約等の遵守
お客様は、本機能のご利用にあたり、関係する法令、Dive 利用規約、お客様が利用する第三者のサービスの規約、およびお客様の社内の規程を遵守するものとします。
関連
普段お使いのClaude・ChatGPT などの AI チャットから、Dive の手順書を探して読めるようになりました(MCP)