APIリファレンス:組織
組織管理とユーザー管理のエンドポイントに関するAPIリファレンス。
AIエンドポイントでは、AIプロンプトを非同期で実行し、ポーリングして結果を取得できます。
エンドポイント: POST /v1/tenant/{tenantId}/ai/{promptType}
**認証:**テナント単位のAPIキー · writeスコープ
パラメーター:
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | 形式:uuid |
| promptType | processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit | path | はい | 使用できる値:processAnalysis、processQuestion、aiSummary、processDocumentation、processRaci、processMetaEdit |
リクエスト本文:
{
"prompt": "string",
"summaryVariant": "string"
} | フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| prompt | string | はい | 自然言語によるプロンプト 最大長:10000 |
| summaryVariant | string | いいえ |
レスポンス(200):
AIの結果(ステータス:success | generating | error)
{
"status": "success",
"result": {
"type": "processAnalysis",
"analysis": "string"
},
"error": "string"
} | フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| status | success | error | generating | はい | 使用できる値:success、error、generating |
| result | object | object | object | object | object | object | いいえ | プロンプトごとの結果データ(ステータスがsuccessの場合に提示) |
| error | string | いいえ | ステータスがerrorの場合のエラーメッセージ |
エラー:
POSTを使ってポーリングするのは意図的な仕様です。処理はプロンプト、promptType、summaryVariantの組み合わせで識別されるため、実行IDではなく、同じ本文を再送して状態を確認します。
エンドポイント: POST /v1/tenant/{tenantId}/ai/{promptType}/status
**認証:**テナント単位のAPIキー · writeスコープ
パラメーター:
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | 形式:uuid |
| promptType | processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit | path | はい | 使用できる値:processAnalysis、processQuestion、aiSummary、processDocumentation、processRaci、processMetaEdit |
リクエスト本文:
{
"prompt": "string",
"summaryVariant": "string"
} | フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| prompt | string | はい | 自然言語によるプロンプト 最大長:10000 |
| summaryVariant | string | いいえ |
レスポンス(200):
AIの結果(ステータス:success | generating | error)
{
"status": "success",
"result": {
"type": "processAnalysis",
"analysis": "string"
},
"error": "string"
} | フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| status | success | error | generating | はい | 使用できる値:success、error、generating |
| result | object | object | object | object | object | object | いいえ | プロンプトごとの結果データ(ステータスがsuccessの場合に提示) |
| error | string | いいえ | ステータスがerrorの場合のエラーメッセージ |
エラー:
クレジットカード不要、待ち時間なしですぐにご利用いただけます。組織の業務の進め方を、明確につながるプロセス設計として可視化します。
プロセスアーキテクチャを構築し、オーナーシップと統制を定め、あらゆる階層で役割と責任を明確にします。
無料トライアルを開始して、プロセスのガバナンス、管理、継続的な改善を支える信頼できる基盤を築きましょう。
Cookieを使用して、利便性の向上、コンテンツのパーソナライズ、トラフィックの分析を行っています。Cookieを使わずにページの閲覧状況を匿名で計測しています。「Accept All」をクリックすると、Cookieの使用に同意したことになります。