ワークスペースの作成

Prev Next

VPC環境で利用できます。

ワークスペースを新規作成します。ワークスペースは独立した作業スペースであり、プロジェクトやメディアアセットを管理できます。

参考

ワークスペースは、アカウントで許可されている数だけ作成できます。許可された数を超えるとエラーが返されます。

リクエスト

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

メソッド URI
POST /api/v1/workspaces

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
workspaceName String Required 作成するワークスペースの名前
  • ワークスペース名は重複不可
  • 長さ制限: 3~63文字
  • 英字の小文字、数字、-のみ使用可能
bucketName String Optional 連携する Object Storageバケットの名前

リクエスト例

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

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces' \
--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 '{
    "workspaceName": "my-workspace",
    "bucketName": "my-bucket"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String - API処理結果コード
message String - API処理結果メッセージ
result Object - ワークスペースの詳細情報
result.workspaceName String - 作成されたワークスペースの名前
result.createdUserName String - 作成者名
result.createdTime String - 作成日時
  • ISO 8601形式
result.updatedUserName String - 更新者名
result.updatedTime String - 更新日時
  • ISO 8601形式

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

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

レスポンス例

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

{
    "code": "0",
    "message": "success",
    "result": {
        "workspaceName": "my-workspace",
        "createdUserName": "username",
        "createdTime": "2026-03-18T10:30:00",
        "updatedUserName": "username",
        "updatedTime": "2026-03-18T10:30:00"
    }
}