create_issue

imerit_ango.sdk.SDK.

create_issue(task_id, content, content_mentions, error_codes, object_id, position, page, page_end, data_index, plane, pct_details)

Create an issue for the specified task with the provided configuration parameters.

Parameters

• task_id: string

  • ID of the task where the issue will be created. Task IDs can be obtained from the UI and from the get_tasks function.

  • Example: "0000000aa0a00a0000aaaa0a"

• content: string

  • The textual content of the issue describing the detected problem or requested correction.

  • Example: "The bounding box here should reach the edges."

• content_mentions: List[dict]

  • List of users to mention in the issue content.

  • Example: [{"userEmail":"[e-mail]"}]

• error_codes: List[dict]

  • List of predefined error categories associated with the issue.

  • Example: [{"category": "Wrong", "name": "Class", "key": "Wrong+Class"}]

• object_id: string

  • The identifier of the annotation object associated with the issue. If provided, the issue is attached to this object.

• position: int, List[int]

  • The location of the issue within the asset.

  • Supported formats:

    • Image/Video: [x, y]

    • Text: character_index

    • Audio: [start_time, end_time]

  • Example: [25, 15]

• page: int

  • The page index where the issue should be created.

  • Used with multi-page image, PDF and video assets.

• page_end: int

  • The ending page index for issues spanning multiple pages.

  • Used with multi-page image, PDF and video assets.

• data_index: int

  • The index of the DICOM slice where the issue should be created.

• plane: MedicalPlane

  • The medical imaging plane associated with the issue location.

  • Medical plane options:

    • MedicalPlane.Axial

    • MedicalPlane.Sagittal

    • MedicalPlane.Coronal

from imerit_ango.models.enums import MedicalPlane

• pct_details: dict

  • Additional metadata used for specialized PCT workflows.

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.

How to verify in Ango Hub?

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

Navigate to: Projects → [Your Project] → Issues

• Confirm that the created issue appears in the list.

Changes made via the SDK are reflected in Ango Hub in near real-time. If updates are not immediately visible, please refresh the page.

Example

Create an issue on a task

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)

task_id = "<YOUR TASK ID>"
content = "There is an inconsistency in the annotation."

ango_sdk.create_issue(task_id=task_id, content=content)

curl

Create an issue on a specific object

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)

task_id = "<YOUR TASK ID>"
content = "This object seems incorrectly labeled."
object_id = "<YOUR OBJECT ID>"

ango_sdk.create_issue(task_id=task_id, content=content, object_id=object_id)

curl

Create an issue at a specified location

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)

task_id = "<YOUR TASK ID>"
content = "Please review this area."
position = [25, 15]

ango_sdk.create_issue(task_id=task_id, content=content, position=position)

curl

Create an issue at a specified location and frame

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)

task_id = "<YOUR TASK ID>"
content = "Please review this area."
frame = 10
position = [25, 15]

ango_sdk.create_issue(task_id=task_id, content=content, position=position, page=frame)

curl

Mention a user in the issue content

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)

task_id = "<YOUR TASK ID>"
content = "Can you take a look at this @[e-mail]?"
content_mentions = [{"userEmail":"[e-mail]"}]

ango_sdk.create_issue(task_id=task_id, content=content, content_mentions=content_mentions)

curl

Create an issue on an object and attach an error code to it

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)

task_id = "<YOUR TASK ID>"
content = "Wrong class assigned to this object."
object_id = "<YOUR OBJECT ID>"
error_codes = [{"category": "Wrong", "name": "Class", "key": "Wrong+Class"}]

ango_sdk.create_issue(task_id=task_id, content=content, object_id=object_id, error_codes=error_codes)

curl

See also

get_issues, delete_issue