VPC環境で利用できます。
アセットの最新のシーン要約(scene summary)結果に基づいて、目的別の変換テキストまたはシーンメタデータを作成する変換タスクをリクエストします。変換対象には、アセットの最新のシーン要約結果が自動的に選択されます。変換は非同期で処理され、リクエスト時に返される変換タスク IDを用いてシーン要約活用結果の照会より進行状況および結果を確認できます。
参考
- 変換はシーン要約が完了したアセットでリクエストできます。シーン要約が存在しない、または進行中である場合はエラーが返されます。
- 1つのアセットに対しては、プリセットにかかわらず同時に1つの変換のみ処理可能です。進行中の変換がある状態で新しい変換をリクエストするとエラーが返されます。前の変換が完了した後に再度リクエストしてください。
- 変換結果の言語(
locale)はシーン要約の言語を継承し、変換リクエストで個別に指定することはできません。 - ワークスペースごとの変換リクエストは1分間に60回に制限されており、上限を超えるとエラーが返されます。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /api/v1/workspaces/{workspace_name}/projects/{project_id}/assets/{asset_id}/scene-summary/transformations |
リクエストヘッダ
Media Intelligence APIで共通して使用されるヘッダの詳細は、Media Intelligenceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
workspace_name |
String | Required | ワークスペース名 |
project_id |
String | Required | プロジェクト ID
|
asset_id |
String | Required | メディアアセット ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
preset |
String | Required | 変換プリセット
|
outputFields |
Array<String> | Optional | 返す出力フィールドを選択(SCENE_DIGEST専用)
|
keywordCount |
Integer | Optional | シーンごとのキーワード数(SCENE_DIGEST専用)
|
paragraphCount |
Integer | Optional | シーンごとの要約段落数(SCENE_DIGEST専用)
|
リクエスト例
リクエストのサンプルコードは次の通りです。
SCENE_DIGESTプリセットのリクエスト例です。
curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects/1234/assets/5678/scene-summary/transformations' \
--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' \
--data '{
"preset": "SCENE_DIGEST",
"outputFields": ["title", "keywords"],
"keywordCount": 20
}'
SCENE_METADATAプリセットのリクエスト例です。
curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects/1234/assets/5678/scene-summary/transformations' \
--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' \
--data '{
"preset": "SCENE_METADATA"
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
code |
String | - | API処理結果コード |
message |
String | - | API処理結果メッセージ |
result |
Object | - | 変換リクエスト受付情報 |
result.id |
Integer | - | 変換タスク ID
|
result.preset |
String | - | リクエストした変換プリセット |
result.locale |
String | - | 変換結果の言語
|
result.createdTime |
String | - | 変換リクエストの作成日時
|
レスポンスステータスコード
Media Intelligence APIで共通して使用されるレスポンスステータスコードの詳細は、Media Intelligenceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"code": "0",
"message": "success",
"result": {
"id": 2001,
"preset": "SCENE_DIGEST",
"locale": "en-US",
"createdTime": "2026-05-22T14:30:00"
}
}