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 | いいえ | プロンプト固有の結果ペイロード(statusがsuccessの場合に提示) |
| error | string | いいえ | statusがerrorの場合のエラーメッセージ |
エラー:
POSTでポーリングするのは意図的な仕様です。生成処理はprompt + 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 | いいえ | プロンプト固有の結果ペイロード(statusがsuccessの場合に提示) |
| error | string | いいえ | statusがerrorの場合のエラーメッセージ |
エラー:
Cookieを使用して、利用体験の改善、コンテンツのパーソナライズ、トラフィックの分析を行っています。「すべて受け入れる」をクリックすると、Cookieの使用に同意したものとみなされます。