Create project

Available in VPC

Create a project, a place to manage video assets and analytics results.

Note

You can create up to 1000 projects per workspace.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
POST	/api/v1/workspaces/{workspace_name}/projects

Request headers

For information about the headers common to all Media AI Understanding APIs, see Media AI Understanding request headers.

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`workspace_name`	String	Required	Workspace name

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`name`	String	Required	Project name Enter up to 100 characters using a combination of English letters, numbers, and special characters. Semicolons (`;`), vertical bars (`\\|`), and backticks (`) can't be used. Duplicates can't exist within a workspace.

Request example

The request example is as follows:

curl --location --request POST 'https://maiu.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects' \
--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 '{
    "name": "project_name"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`code`	String	Required	API processing result code
`message`	String	Required	API processing result message
`result`	Object	Required	Project details
`result.projectId`	Integer	Required	Project ID
`result.name`	String	Required	Project name
`result.isBaseProject`	Boolean	Required	Default project or not `true` \| `false`
`result.createdUserName`	String	Required	User name that created the project
`result.createdTime`	String	Required	Project creation date and time ISO 8601 format
`result.updatedUserName`	String	Required	User name who last edited the project
`result.updatedTime`	String	Required	Last project modification date and time ISO 8601 format

Response status codes

For information about the HTTP status codes common to all Media AI Understanding APIs, see Media AI Understanding response status codes.

Response example

The response example is as follows:

{
    "code": "0",
    "message": "success",
    "result": {
        "projectId": 1234,
        "name": "project_name",
        "isBaseProject": false,
        "createdUserName": "username",
        "createdTime": "2025-04-23T14:15:19.563829873",
        "updatedUserName": "username",
        "updatedTime": "2025-04-23T14:15:19.56389036"
    }
}