シーン要約状態の照会

VPC環境で利用できます。

実行中または完了したシーン要約の状態を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/v1/workspaces/{workspace_name}/projects/{project_id}/assets/{asset_id}/indexes/{index_id}/scene-summaries/{scene_summary_id}/status

リクエストヘッダ

Media Intelligence APIで共通して使用されるヘッダの詳細は、Media Intelligenceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`workspace_name`	String	Required	ワークスペース名
`project_id`	String	Required	プロジェクト ID プロジェクトリストの照会を参照
`asset_id`	String	Required	メディアアセット ID メディアアセットリストの照会を参照
`index_id`	String	Required	インデックス ID インデックスリストの照会を参照
`scene_summary_id`	String	Required	シーン要約リクエスト ID シーン要約のリクエストを参照

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects/1234/assets/5678/indexes/1001/scene-summaries/101/status' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`code`	String	-	API処理結果コード
`message`	String	-	API処理結果メッセージ
`result`	Object	-	シーン要約の状態情報
`result.status`	String	-	分析の状態 `BEFORE_SUMMARIZE` \| `WAIT_SUMMARIZE` \| `SUMMARIZING` \| `SUMMARIZE_COMPLETED` \| `SUMMARIZE_FAIL` \| `SUMMARIZE_CANCELED` `BEFORE_SUMMARIZE`: シーン要約を行ったことのない初期状態 `WAIT_SUMMARIZE`: シーン要約リクエスト完了、実行待ちの状態 `SUMMARIZING`: シーン要約が実行中の状態 `SUMMARIZE_COMPLETED`: リクエスト対象のシーンがすべて無事完了した状態 `SUMMARIZE_FAIL`: シーン要約中にエラーが発生して失敗した状態 `SUMMARIZE_CANCELED`: ユーザーがシーン要約をキャンセルした状態
`result.statusMessage`	String	-	シーン要約失敗時の詳細なエラーメッセージ
`result.sceneSummaryId`	Integer	-	シーン要約 ID 完了時、最終的に成功したシーン要約 IDを返す
`result.targetSceneIds`	Array<Integer>	-	分析対象シーン IDリストすべて分析の場合、`null`
`result.analyzedSceneCount`	Integer	-	現在のリクエスト基準で分析が完了したシーン数
`result.totalSceneCount`	Integer	-	現在のリクエストにおける分析対象シーンの総数
`result.requestedTime`	String	-	分析リクエスト日時 ISO 8601形式
`result.completedTime`	String	-	分析完了日時 ISO 8601形式完了時にのみ返す

レスポンスステータスコード

Media Intelligence APIで共通して使用されるレスポンスステータスコードの詳細は、Media Intelligenceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": "0",
    "message": "success",
    "result": {
        "status": "SUMMARIZING",
        "statusMessage": null,
        "sceneSummaryId": 101,
        "targetSceneIds": null,
        "analyzedSceneCount": 3,
        "totalSceneCount": 10,
        "requestedTime": "2026-04-17T10:30:00",
        "completedTime": null
    }
}