Ango Hub

https://docs.imerit.net
Admin
Ango Hub is a comprehensive data labeling and annotation platform that enables teams to label...
Tokens:402,655
Snippets:4,006
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example Start Date Configuration

Source: https://docs.imerit.net/plugins/first-party-ango-plugins/tpt-export

Examples of how to set the 'start_date' parameter for the TPT Export plugin. It can be a specific date, null, or 'today'.

```json
"start_date": "2020-12-31"
```

```json
"start_date": null
```

```json
"start_date": "today"
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://docs.imerit.net/plugins/first-party-ango-plugins/tpt-export

This example demonstrates how to query documentation dynamically by performing an HTTP GET request with an 'ask' query parameter.

```http
GET https://docs.imerit.net/plugins/first-party-ango-plugins/tpt-export.md?ask=<question>
```

--------------------------------

### Example: Query Documentation via GET Request

Source: https://docs.imerit.net/plugins/first-party-ango-plugins/file-explorer-plugin

To get dynamic information not explicitly on the page, perform an HTTP GET request to the current URL with an `ask` query parameter containing your question.

```http
GET https://docs.imerit.net/plugins/first-party-ango-plugins/file-explorer-plugin.md?ask=<question>
```

--------------------------------

### Example API Request with Authentication

Source: https://docs.imerit.net/api/docs/overview

Demonstrates how to make a GET request to list projects, including the necessary API key and content type headers.

```bash
curl -X GET "https://imeritapi.ango.ai/v2/listProjects" \
  -H "apikey: your_actual_api_key_here" \
  -H "Content-Type: application/json"
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.imerit.net/plugins/first-party-ango-plugins/dall-e

This example demonstrates how to dynamically query the documentation using an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information or clarifications not explicitly present on the page.

```http
GET https://docs.imerit.net/plugins/first-party-ango-plugins/dall-e.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET Request

Source: https://docs.imerit.net/data/data-in-ango-hub/embedding-private-bucket-files-in-markdown-assets

This example demonstrates how to dynamically query the documentation by making an HTTP GET request to the page URL with an `ask` query parameter. This is useful for retrieving specific information not explicitly present on the page.

```http
GET https://docs.imerit.net/data/data-in-ango-hub/embedding-private-bucket-files-in-markdown-assets.md?ask=<question>
```

--------------------------------

### Example Prompt Prefix Configuration

Source: https://docs.imerit.net/plugins/first-party-ango-plugins/chatgpt

Use 'prompt_prefix' to prepend instructions or context to the main input for the model. This is useful for guiding the model's output format or task.

```json
"prompt_prefix": "Extract all company names from the following text:"
```

--------------------------------

### Aggregate Same Columns Configuration Example

Source: https://docs.imerit.net/plugins/first-party-ango-plugins/csv-export-for-classification

Examples demonstrating how to configure 'aggregate_same_columns' to merge columns with identical headers.

```json
"aggregate_same_columns": true
```

```json
"aggregate_same_columns": false
```

--------------------------------

### Disable the "Auto Forward on Upload" option on the Start stage

Source: https://docs.imerit.net/sdk/sdk-documentation/project-level-sdk-functions/update_workflow_stages

This example shows how to modify an existing workflow to disable the 'Auto Forward' setting for the 'Start' stage.

```APIDOC
## update_workflow_stages (Disable Auto Forward)

### Description
Updates the workflow stages to disable the 'Auto Forward' option for the 'Start' stage.

### Method Signature
```python
ango_sdk.update_workflow_stages(project_id: str, stages: list)
```

### Parameters
- **project_id** (str) - Required - The ID of the project to update.
- **stages** (list) - Required - A list of dictionaries, where each dictionary represents a workflow stage with its properties. This list should include the modified 'Start' stage.

### Request Example (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')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

stages = ango_sdk.get_project(project_id=project_id).get("data").get("project").get("stages")

new_stages = []
for stage in stages:
    new_stage = stage.copy()
    if stage["id"] == "Start":
        new_stage["autoForward"] = False
    new_stages.append(new_stage)

sdk_response = ango_sdk.update_workflow_stages(project_id=project_id, stages=new_stages)
```
```

--------------------------------

### End-to-end Project Preparation with SDK

Source: https://docs.imerit.net/sdk/useful-sdk-snippets

Use this comprehensive snippet to programmatically prepare a new project. It covers initialization, configuration, asset management, and workflow integration, enabling efficient project setup from scratch.

```python
import os
import json
import random
from dotenv import load_dotenv
from imerit_ango.sdk import SDK
from imerit_ango.models.export_options import ExportOptions
from imerit_ango.models.invite import Invitation, ProjectAssignment
from imerit_ango.models.enums import OrganizationRoles, ProjectRoles
from imerit_ango.models.label_category import LabelOption, ClassificationCategory, Classification

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

# Project Configurations
project_name = "Sample Text Classification Project"
project_description = "Created by end-to-end project preparation script"

labeler_email_list = ["user_1@sample.mail", "user_2@sample.mail"]
reviewer_email_list = ["user_3@sample.mail"]

# Initialize SDK
ango_sdk = SDK(api_key)
print("SDK initialized with API key.")

# Create Project
response = ango_sdk.create_project(name=project_name, description=project_description)
organization_id = response.get("data", {}).get("project", {}).get("organization")
project_id = response.get("data", {}).get("project", {}).get("_id")

print(f"Project '{project_name}' created successfully.")
print(f"Project ID: {project_id}, Organization ID: {organization_id}")

# Add Members to the Project
# Add Labelers
labeler_project_assignments = [ProjectAssignment(project_id=project_id, project_role=ProjectRoles.Labeler)]
labeler_invitation = Invitation(to=labeler_email_list, organization_role=OrganizationRoles.Member, project_assignments=labeler_project_assignments)
labeler_invite_response = ango_sdk.invite_members_to_org(organization_id=organization_id, invite_data=labeler_invitation)

# Add Reviewers
reviewer_project_assignments = [ProjectAssignment(project_id=project_id, project_role=ProjectRoles.Reviewer)]
reviewer_invitation = Invitation(to=reviewer_email_list, organization_role=OrganizationRoles.Member, project_assignments=reviewer_project_assignments)
reviewer_invite_response = ango_sdk.invite_members_to_org(organization_id=organization_id, invite_data=reviewer_invitation)

# The add_members_to_project function can also be used if the members are already part of the organization:
# ango_sdk.add_members_to_project(project_id=project_id, members=labeler_email_list, role=ProjectRoles.Labeler)
# ango_sdk.add_members_to_project(project_id=project_id, members=reviewer_email_list, role=ProjectRoles.Reviewer)

print(f"Added {len(labeler_email_list)} labelers to the project.")
print(f"Added {len(reviewer_email_list)} reviewers to the project.")

# Update Workflow Stages
start_stage = {"id": "Start",
               "type": "Start",
               "name": "Start",
               "next": ["Label"],
               "autoForward": False,
               "position": {"x": 0, "y": 0}}

label_stage = {"id": "Label",
               "type": "Label",
               "name": "Label",
               "next": ["Review"],
               "assignedTo": [],
               "position": {"x": 400, "y": 0}}

review_stage = {"id": "Review",
                "type": "Review",
                "name": "Review",
                "next": ["Complete", "Label"],
                "assignedTo": [],
                "position": {"x": 800, "y": 0}}

complete_stage = {"id": "Complete",
                  "type": "Complete",
                  "name": "Complete",
                  "next": [],
                  "position": {"x": 1200, "y": 0},
                  "preventRequeue": False}

stages = [start_stage, label_stage, review_stage, complete_stage]
response = ango_sdk.update_workflow_stages(project_id, stages)
print("Workflow stages updated successfully.")

# Create Category Schema
schema_id = "123456"
category = ClassificationCategory(classification=Classification.Single_dropdown,
                                  title="Choice",
                                  options=[LabelOption("First"), LabelOption("Second"), LabelOption("Third")],
                                  schemaId=schema_id,
                                  shortcutKey="1")

response = ango_sdk.create_label_set(project_id=project_id, classifications=[category])
print("Label set with classification category created successfully.")

# Create Batches
for index in range(3):
    batch_name = "Batch-" + str(index+1)
    ango_sdk.create_batch(project_id=project_id, batch_name=batch_name)
print("Batches created successfully.")

```

--------------------------------

### Dataset URLs Example (Multi-Image Assets)

Source: https://docs.imerit.net/data/importing-and-exporting-annotations/exporting-annotations/ango-export-format/asset

Contains URLs for all images within a multi-image asset, starting from page 0.

```json
"dataset": [
    "https://angohub-public-assets.s3.eu-central-1.amazonaws.com/3e6e15b9-c32c-4b73-97f9-dbda784926ab.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&#x26;X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&#x26;X-Amz-Credential=AKIATAGM6WLISC5CRH7S%2F20231009%2Feu-central-1%2Fs3%2Faws4_request&#x26;X-Amz-Date=20231009T134740Z&#x26;X-Amz-Expires=120000&#x26;X-Amz-Signature=70790d6813a471f78f51261006f45971af8c0bb73c5266ed90225da2a7e7d5f6&#x26;X-Amz-SignedHeaders=host&#x26;x-id=GetObject",
    "https://angohub-public-assets.s3.eu-central-1.amazonaws.com/8b363eb9-5b7f-414c-89b8-b6907f29447b.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&#x26;X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&#x26;X-Amz-Credential=AKIATAGM6WLISC5CRH7S%2F20231009%2Feu-central-1%2Fs3%2Faws4_request&#x26;X-Amz-Date=20231009T134740Z&#x26;X-Amz-Expires=120000&#x26;X-Amz-Signature=fab97fcb3a6e457e4acf0525651047942e7349973758b0a533ea03e453bad039&#x26;X-Amz-SignedHeaders=host&#x26;x-id=GetObject"
    ]
```

--------------------------------

### Create Project - EU Instance

Source: https://docs.imerit.net/sdk/sdk-documentation

Example of creating a project using the SDK and API for the default EU instance.

```APIDOC
## POST /v2/project

### Description
Creates a new project.

### Method
POST

### Endpoint
/v2/project

### Request Body
- **name** (string) - Required - The name of the project to create.

### Request Example
```json
{
  "name": "Example Project"
}
```

### Response
#### Success Response (200)
- **project_id** (string) - The ID of the created project.
- **name** (string) - The name of the created project.

### Response Example
```json
{
  "project_id": "proj_12345",
  "name": "Example Project"
}
```
```

--------------------------------

### Initialize and Run Markdown Plugin (Python)

Source: https://docs.imerit.net/plugins/plugin-developer-documentation/markdown-generator-plugins

Demonstrates how to initialize a MarkdownPlugin with an ID, secret, and callback, then run it on a specified host. Ensure PLUGIN_ID, PLUGIN_SECRET, and HOST are defined.

```python
if __name__ == "__main__":
    plugin = MarkdownPlugin(id=PLUGIN_ID,
                            secret=PLUGIN_SECRET,
                            callback=sample_callback)

    run(plugin, host=HOST)
```

--------------------------------

### Create a workflow from scratch

Source: https://docs.imerit.net/sdk/sdk-documentation/project-level-sdk-functions/update_workflow_stages

This example demonstrates how to define and update workflow stages for a new project.

```APIDOC
## update_workflow_stages (Python SDK)

### Description
Updates the stages of a workflow for a given project.

### Method Signature
```python
ango_sdk.update_workflow_stages(project_id: str, stages: list)
```

### Parameters
- **project_id** (str) - Required - The ID of the project to update.
- **stages** (list) - Required - A list of dictionaries, where each dictionary represents a workflow stage with its properties.

### Request Example (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')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

start_stage = {"id": "Start",
               "type": "Start",
               "name": "Start",
               "next": ["Label"],
               "autoForward": False,
               "position": {"x": 0, "y": 0}}

label_stage = {"id": "Label",
               "type": "Label",
               "name": "Label",
               "next": ["Review"],
               "assignedTo": [],
               "position": {"x": 400, "y": 0}}

review_stage = {"id": "Review",
                "type": "Review",
                "name": "Review",
                "next": ["Complete", "Label"],
                "assignedTo": [],
                "position": {"x": 800, "y": 0}}

complete_stage = {"id": "Complete",
                  "type": "Complete",
                  "name": "Complete",
                  "next": [],
                  "position": {"x": 1200, "y": 0},
                  "preventRequeue": False}

stages = [start_stage, label_stage, review_stage, complete_stage]

sdk_response = ango_sdk.update_workflow_stages(project_id=project_id, stages=stages)
```

### Request Example (cURL)
```bash
curl -X POST "https://imeritapi.ango.ai/v2/project/$PROJECT_ID" \
  -H "Content-Type: application/json" \
  -H "apikey: $ANGO_API_KEY" \
  -d 
  {
    "stages": [
      {
        "autoForward": false,
        "id": "Start",
        "name": "Start",
        "next": ["Label"],
        "position": {"x": 0, "y": 0},
        "type": "Start"
      },
      {
        "assignedTo": [],
        "id": "Label",
        "name": "Label",
        "next": ["Review"],
        "position": {"x": 400, "y": 0},
        "type": "Label"
      },
      {
        "assignedTo": [],
        "id": "Review",
        "name": "Review",
        "next": ["Complete", "Label"],
        "position": {"x": 800, "y": 0},
        "type": "Review"
      },
      {
        "id": "Complete",
        "name": "Complete",
        "next": [],
        "position": {"x": 1200, "y": 0},
        "preventRequeue": false,
        "type": "Complete"
      }
    ]
  }
```
```

--------------------------------

### Retrieve Project Issues using cURL

Source: https://docs.imerit.net/sdk/sdk-documentation/project-level-sdk-functions/get_issues

This command-line example shows how to retrieve issues for a project using a GET request to the imeritapi.ango.ai endpoint. Replace $PROJECT_ID and $ANGO_API_KEY with your actual values.

```bash
curl -X GET "https://imeritapi.ango.ai/v2/issues?project=$PROJECT_ID" \
  -H "Content-Type: application/json" \
  -H "apikey: $ANGO_API_KEY"
```

--------------------------------

### Sample Stage History with Asset Data

Source: https://docs.imerit.net/data/importing-and-exporting-annotations/exporting-annotations/ango-export-format/stage-history

Provides a concrete example of the stageHistory array, showing details of an asset's progression through 'Start' and 'Label' stages, including timestamps, durations, and tool-specific data.

```json
{
  "stageHistory": [
    {
      "stage": "Start",
      "stageId": "Start",
      "duration": 0,
      "completedAt": "2023-09-01T08:03:00.751Z",
      "tools": [],
      "classifications": [],
      "relations": []
    },
    {
      "stage": "Label",
      "stageId": "Label",
      "duration": 8217,
      "completedAt": "2023-09-01T08:05:21.104Z",
      "completedBy": "lorenzo@example.net",
      "tools": [
        {
          "bounding-box": {
            "x": 311.9559633027523,
            "y": 239.8383838383839,
            "height": 220.44444444444446,
            "width": 132.40366972477065
          },
          "objectId": "3d94d5ead7fcc14859ee425",
          "classifications": [],
          "schemaId": "b1c6805d054f0e44ae11500",
          "title": "bb"
        }
      ],
      "classifications": [],
      "relations": [],
      "brushDataUrl": "https://angohub-private-assets.s3.eu-central-1.amazonaws.com/64f19ab4c54a4d0015562a8f-1693555519699.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIATAGM6WLISC5CRH7S%2F20230906%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20230906T103943Z&X-Amz-Expires=120000&X-Amz-Signature=5d45f1475af4c9bdfa420c8c528ec132438b393ebfa81fd3cb20fc1f534a99b7&X-Amz-SignedHeaders=host&x-id=GetObject"
    }
  ]
}
```

--------------------------------

### Create a New Project

Source: https://docs.imerit.net/sdk/sdk-documentation/project-level-sdk-functions/create_project

Use the create_project function to initialize a new project. Provide a name, description, and optionally specify the project type and PCT configuration.

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

# Example: Create a basic project
project_name = "My New Project"
project_description = "This is a sample project."

# Call the SDK function
result = imerit_ango.sdk.SDK.create_project(name=project_name, description=project_description)

# Example: Create a PCT project with specific configuration
pct_config = PctConfig(
    allow_overlapping=True,
    tracking_multiple_sensors=True,
    segmentation_mode=False
)

pct_project_name = "My PCT Project"
pct_project_description = "A project for PCT tasks."

# Call the SDK function for PCT project
pct_result = imerit_ango.sdk.SDK.create_project(
    name=pct_project_name,
    description=pct_project_description,
    project_type=ProjectType.PCT,
    pct_config=pct_config
)
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.imerit.net/data/importing-and-exporting-annotations/importing-annotations/importing-brush-traces

To get additional information not directly on the page, perform an HTTP GET request with the 'ask' query parameter.

```http
GET https://docs.imerit.net/data/importing-and-exporting-annotations/importing-annotations/importing-brush-traces.md?ask=<question>
```

--------------------------------

### Example: Enabling Logging

Source: https://docs.imerit.net/plugins/first-party-ango-plugins/benchmark-and-consensus-export

Shows how to enable progress logging for the plugin by setting 'logging_frequency' to a positive integer, specifying the log display interval.

```json
"logging_frequency": 100
```

--------------------------------

### Relation title Example

Source: https://docs.imerit.net/data/importing-and-exporting-annotations/exporting-annotations/ango-export-format/asset/task/relations

Example of the 'title' property for a relation.

```json
"title": "Image Projection Type"
```

--------------------------------

### Create Project using SDK (EU Instance)

Source: https://docs.imerit.net/sdk/sdk-documentation

Use this Python snippet to create a new project via the SDK when your workspace is hosted in the EU instance. Ensure the API key is set.

```python
from imerit_ango.sdk import SDK

api_key = "$ANGO_API_KEY"

ango_sdk = SDK(api_key=api_key)
response = ango_sdk.create_project(name="Example Project")
```

--------------------------------

### Relation schemaId Example

Source: https://docs.imerit.net/data/importing-and-exporting-annotations/exporting-annotations/ango-export-format/asset/task/relations

Example of the 'schemaId' property for a relation.

```json
"schemaId": "4460fa700ef030c4e575604"
```

--------------------------------

### Create Project - Other Instances

Source: https://docs.imerit.net/sdk/sdk-documentation

Example of creating a project using the SDK and API for non-EU instances (e.g., US).

```APIDOC
## POST /v2/project

### Description
Creates a new project in a specified regional instance.

### Method
POST

### Endpoint
/v2/project

### Parameters
#### Host Configuration
When initializing the SDK or making API requests, specify the `host` parameter with the appropriate regional domain (e.g., `https://us-api.ango.ai`).

### Request Body
- **name** (string) - Required - The name of the project to create.

### Request Example
```json
{
  "name": "Example Project"
}
```

### Response
#### Success Response (200)
- **project_id** (string) - The ID of the created project.
- **name** (string) - The name of the created project.

### Response Example
```json
{
  "project_id": "proj_67890",
  "name": "Example Project"
}
```
```

--------------------------------

### Relation objectId Example

Source: https://docs.imerit.net/data/importing-and-exporting-annotations/exporting-annotations/ango-export-format/asset/task/relations

Example of the 'objectId' property for a relation.

```json
"objectId": "6b8a4338d299c63b5ee7825"
```

--------------------------------

### Pagination Examples for List Endpoints

Source: https://docs.imerit.net/api/docs/overview

Shows how to use 'page' and 'limit' query parameters to retrieve data in manageable chunks. The 'limit' parameter can be set up to 100.

```http
GET /listProjects?page=1&limit=10
```

```http
GET /listProjects?page=2&limit=50
```

```http
GET /listProjects?limit=100
```

--------------------------------

### Query Documentation via GET Request

Source: https://docs.imerit.net/data/importing-assets

To get information not explicitly on the page, perform a GET request with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.imerit.net/data/importing-assets.md?ask=<question>
```

--------------------------------

### cURL Example

Source: https://docs.imerit.net/sdk/sdk-documentation/project-level-sdk-functions/get_task_history

Example of how to retrieve task history using cURL.

```APIDOC
## get_task_history (cURL)

### Description
Example cURL command to retrieve the history of a specific task.

### Method
GET

### Endpoint
`https://imeritapi.ango.ai/v2/task/$TASK_ID/history`

### Headers
- **Content-Type**: `application/json`
- **apikey**: `$ANGO_API_KEY`

### Example
```bash
curl -X GET "https://imeritapi.ango.ai/v2/task/$TASK_ID/history" \
  -H "Content-Type: application/json" \
  -H "apikey: $ANGO_API_KEY"
```
```

--------------------------------

### Query Documentation via GET Request

Source: https://docs.imerit.net/data/importing-assets/contextdata-adding-extra-data-to-assets

To get information not explicitly on the page, perform an HTTP GET request with an 'ask' query parameter. The response includes answers and relevant excerpts.

```http
GET https://docs.imerit.net/data/importing-assets/contextdata-adding-extra-data-to-assets.md?ask=<question>
```

--------------------------------

### Create Storage Instance with cURL

Source: https://docs.imerit.net/sdk/sdk-documentation/organization-level-sdk-functions/create_storage

This cURL command demonstrates how to create a storage instance via the API. Replace placeholders with your actual credentials and storage details. Ensure the `apikey` header is correctly set.

```bash
curl -X POST "https://imeritapi.ango.ai/v2/storages/" \
  -H "Content-Type: application/json" \
  -H "apikey: $ANGO_API_KEY" \
  -d '{
    "credentials": "<YOUR CREDENTIALS>",
    "name": "My Storage",
    "privateKey": "<YOUR PRIVATE KEY>",
    "provider": "AWS",
    "publicKey": "<YOUR PUBLIC KEY>",
    "region": "<YOUR REGION>"
  }'
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.imerit.net/data/importing-assets/bundled-assets/importing-multiple-dicom-files-to-be-annotated-and-displayed-at-once

To get additional information not directly on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.imerit.net/data/importing-assets/bundled-assets/importing-multiple-dicom-files-to-be-annotated-and-displayed-at-once.md?ask=<question>
```

--------------------------------

### Create Project using SDK (Other Instances)

Source: https://docs.imerit.net/sdk/sdk-documentation

Use this Python snippet to create a new project via the SDK when your workspace is hosted in a non-EU instance. Specify the 'host' parameter with the appropriate regional URL.

```python
from imerit_ango.sdk import SDK

api_key = "$ANGO_API_KEY"
host = "https://us.ango.ai"

ango_sdk = SDK(api_key=api_key, host=host)
response = ango_sdk.create_project(name="Example Project")
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.imerit.net/3d-multi-sensor-fusion/labeling/3d-multi-sensor-fusion-labeling-editor/key-features/label-validation

To get additional information not directly present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.imerit.net/3d-multi-sensor-fusion/labeling/3d-multi-sensor-fusion-labeling-editor/key-features/label-validation.md?ask=<question>
```

--------------------------------

### Example: Batch Size Configuration

Source: https://docs.imerit.net/plugins/first-party-ango-plugins/batch-assignment

Set the 'batch_size' to define the number of assets included in each batch.

```json
"batch_size": 100
```

--------------------------------

### Create Project using cURL (Other Instances)

Source: https://docs.imerit.net/sdk/sdk-documentation

This cURL command demonstrates how to create a new project via the API for non-EU instances. Specify the correct host URL in the request.

```bash
curl -X POST "https://us-api.ango.ai/v2/project" \
  -H "Content-Type: application/json" \
  -H "apikey: $ANGO_API_KEY" \
  -d '{
    "name": "Example Project"
  }'
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.imerit.net/sdk/sdk-documentation/project-level-sdk-functions/upload_chat_assets

To get additional information not directly on this page, perform an HTTP GET request to the page URL with the `ask` query parameter. The question should be specific and self-contained.

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

--------------------------------

### Create Project using cURL (EU Instance)

Source: https://docs.imerit.net/sdk/sdk-documentation

This cURL command demonstrates how to create a new project via the API for the EU instance. It requires the API key and specifies the project name in the request body.

```bash
curl -X POST "https://imeritapi.ango.ai/v2/project" \
  -H "Content-Type: application/json" \
  -H "apikey: $ANGO_API_KEY" \
  -d '{
    "name": "Example Project"
  }'
```

--------------------------------

### Querying Documentation via HTTP GET Request

Source: https://docs.imerit.net/data/importing-assets/importing-attachments-during-asset-import

To get additional information not directly on the page, perform an HTTP GET request to the page URL with an 'ask' query parameter containing your question.

```http
GET https://docs.imerit.net/data/importing-assets/importing-attachments-during-asset-import.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.imerit.net/3d-multi-sensor-fusion/labeling/3d-multi-sensor-fusion-labeling-editor/drawing-tools/3d-polygon

To get information not explicitly present on the page, perform an HTTP GET request to the current page URL with an 'ask' query parameter. The question should be specific and in natural language.

```HTTP
GET https://docs.imerit.net/3d-multi-sensor-fusion/labeling/3d-multi-sensor-fusion-labeling-editor/drawing-tools/3d-polygon.md?ask=<question>
```

--------------------------------

### Upload Project Instructions

Source: https://docs.imerit.net/api/docs/projects

Uploads an instruction file (PDF only) for a specified project. You can also provide a custom storage ID and bucket name.

```APIDOC
## POST /project/{projectId}/instructions

### Description
Uploads instruction file for a project (PDF format only)

### Method
POST

### Endpoint
/project/{projectId}/instructions

### Parameters
#### Path Parameters
- **projectId** (string) - Required - The ID of the project

#### Query Parameters
- **storageId** (string) - Optional - Custom storage ID
- **bucket** (string) - Optional - Custom bucket name

#### Request Body
- **file** (binary) - Required - Instruction file to upload (PDF format)

### Response
#### Success Response (200)
- **ProjectResponse** (object) - Details of the project after instructions are uploaded.
```
Tokens:
Raw