---
title: "Create a project"
method: POST
path: "/projects"
tags: ["Projects"]
---

# Create a project

`POST /projects`

## Request

- Base URL: `https://projects-api.home.mendix.com/v2`
- URL: `https://projects-api.home.mendix.com/v2/projects`
- Auth: API key in header `Authorization`

Schedules a job on the server to create a project. The job will be handled asynchronously; the operation returns a jobId that can be used to monitor the status of the process.</br>Every request must be authenticated by a Personal Access Token containing the scope `mx:app:create`.

## Request body

- object
  - `name` string, required: The name of the project.
  - `summary` string: Description of the project
  - `image` string: Base-64 encoded string of the project icon image. The file size is limited to 5MB, minimum of 200 x 200 px and maximum of 400 x 400 px.
  - `templateId` string, uuid: Identifier of the template that the project will be copied from. If empty, the default template is used.

## Response `202`

Accepted

- object
  - `jobId` string, uuid: Unique identifier of the job that created the project. Use this ID to query the status of the process.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `500`: Internal Server Error

---

[API](https://skmtc.dev/mendix/apis/projects-api.md) - [All operations](https://skmtc.dev/mendix/apis/projects-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mendix/apis/projects-api/revisions/3a958ca32c74?raw)