# create\_project

`imerit_ango.sdk.SDK.`

## create\_project(name, description, project\_type, pct\_config)

Create a new project in your organization.

### Parameters

* **name:** string
  * The display name of the project to be created. This field is required and cannot be left empty.
  * Example: `'Project One'`
* **description:** string, *optional, default ""*
  * A brief description of the project.
  * Example: `'Vehicle Classification Project'`
* **project\_type:** ProjectType, *optional, default None*

  * Specifies the type of the project.
  * Options:
    * <kbd>ProjectType.Ango</kbd>
    * <kbd>ProjectType.PCT</kbd>&#x20;

  ```python
  from imerit_ango.models.enums import ProjectType
  ```
* **pct\_config:** PctConfig, *optional, default None*

  * Configuration object for PCT projects.
  * **PctConfig**
    * **allow\_overlapping:** bool, *default False*
      * Allows multiple annotations to overlap within the same frame.
    * **tracking\_multiple\_sensors:** bool, *default False*
      * Enables tracking across multiple sensors.
    * **segmentation\_mode:** bool, *default False*
      * Activates segmentation mode.

  ```python
  from imerit_ango.models.pct_config import PctConfig
  ```

Returns:

* **output:** dict
  * A dictionary containing the result of the operation.
  * Including a `status` field indicating whether the request was successful and a `data` field containing the response payload with updated resources produced by the operation.

<details open>

<summary><strong>How to verify in Ango Hub?</strong></summary>

After successfully executing the `create_project` function, you can validate the changes directly in Ango Hub.

Navigate to: **Projects**

* Confirm that the created project appears in the project list.

{% hint style="info" %}
Changes made via the SDK are reflected in Ango Hub in near real-time. If updates are not immediately visible, please refresh the page.
{% endhint %}

</details>

### Example

Create a standard Ango project:

{% tabs %}
{% tab title="python" %}

```python
import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')

ango_sdk = SDK(api_key)

response = ango_sdk.create_project(
    name="New Ango Project",
    description="Created via SDK"
)

project_id = response["data"]["project"]["id"]
```

{% endtab %}

{% tab title="curl" %}

```bash
curl -X POST "https://imeritapi.ango.ai/v2/project" \
  -H "Content-Type: application/json" \
  -H "apikey: $ANGO_API_KEY" \
  -d '{
    "description": "Created via SDK",
    "name": "New Ango Project"
  }'
```

{% endtab %}
{% endtabs %}

<details>

<summary>Returns</summary>

```json
{
    "status": "success",
    "data": {
        "project": {
            "id": "<PROJECT ID>",
            "name": "New Ango Project",
            "type": "ango",
            "pctConfig": {
                "allowOverlapping": false,
                "trackingMultipleSensors": false,
                "segmentationMode": false
            },
            "description": "Created via SDK",
            "createdAt": "<CREATED AT TIME>",
            "categorySchema": {
                "tools": [],
                "classifications": [],
                "relations": []
            },
            "benchmarkEnabled": false,
            "benchmarkRatio": 10,
            "benchmarkCutoff": false,
            "customValidationEnabled": false,
            "submissionPrevent": false,
            "validationFunction": "",
            "externalValidation": {
                "enabled": false,
                "apiUrl": "",
                "singleFrame": false,
                "specificFrame": false
            },
            "organization": "<ORGANIZATION ID>",
            "owner": "<USER EMAIL>",
            "gcSyncEnabled": false,
            "assignedTo": [],
            "deleted": false,
            "ocrLanguage": "eng",
            "idleTimeout": 300,
            "projectPlugins": {},
            "pluginPresets": [],
            "batches": [],
            "errorCodesEnabled": false,
            "errorSchema": {},
            "exportStorageEnabled": false,
            "taskSkipEnabled": true,
            "unassignSkippedTask": false,
            "stages": [
                {
                    "id": "Start",
                    "name": "Start",
                    "type": "Start",
                    "next": [
                        "Label"
                    ],
                    "assignedTo": [],
                    "readOnly": false,
                    "rememberAssignee": true,
                    "position": {
                        "x": 0,
                        "y": 50
                    },
                    "autoForward": true
                },
                {
                    "id": "Complete",
                    "name": "Complete",
                    "type": "Complete",
                    "next": [],
                    "assignedTo": [],
                    "readOnly": false,
                    "rememberAssignee": true,
                    "position": {
                        "x": 600,
                        "y": 78
                    },
                    "autoForward": true
                },
                {
                    "id": "Label",
                    "name": "Label",
                    "type": "Label",
                    "next": [
                        "Complete"
                    ],
                    "assignedTo": [],
                    "readOnly": false,
                    "rememberAssignee": true,
                    "position": {
                        "x": 300,
                        "y": 50
                    },
                    "autoForward": true
                }
            ],
            "assetCount": 0,
            "assetBuilderTemplates": [],
            "_id": "<PROJECT ID>"
        }
    }
}
```

</details>

Create a PCT project:

{% tabs %}
{% tab title="python" %}

```python
import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK
from imerit_ango.models.enums import ProjectType
from imerit_ango.models.pct_config import PctConfig

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')

ango_sdk = SDK(api_key)

pct_configuration = PctConfig(
    allow_overlapping=False,
    tracking_multiple_sensors=False,
    segmentation_mode=False
)

response = ango_sdk.create_project(
    name="New PCT Project",
    description="Created via SDK",
    project_type=ProjectType.PCT,
    pct_config=pct_configuration
)

project_id = response["data"]["project"]["id"]
```

{% endtab %}

{% tab title="curl" %}

```bash
curl -X POST "https://imeritapi.ango.ai/v2/project" \
  -H "Content-Type: application/json" \
  -H "apikey: $ANGO_API_KEY" \
  -d '{
        "description": "Created via SDK",
        "name": "My New PCT Project",
        "pctConfig": {
          "allowOverlapping": false,
          "segmentationMode": false,
          "trackingMultipleSensors": false
        },
        "type": "pct"
      }'
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**See also**

[list\_projects](/sdk/sdk-documentation/project-level-sdk-functions/list_projects.md), [get\_project](/sdk/sdk-documentation/project-level-sdk-functions/get_project.md)
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.imerit.net/sdk/sdk-documentation/project-level-sdk-functions/create_project.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
