SDK Documentation

How to install and use Ango Hub's Python SDK

We provide a Python SDK to interface programmatically with Ango Hub.

SDK Installation

How to Install the Ango SDK

To start using the Ango SDK, you will need to install the latest version of the imerit-ango python package, available on PyPI.

To download and add the package to your current Python environment, use the following command:

pip install imerit-ango

How to upgrade the Ango SDK

To upgrade the imerit-ango package to its latest version in your current Python environment, use the following command:

pip install -U imerit-ango

It is strongly recommended to use the latest version of the imerit-ango package to ensure compatibility with current features, avoid potential issues, and benefit from the latest fixes and improvements.

Obtaining your API Key

In order to interact with Ango Hub programmatically, you'll need an API key which can be directly obtained from the account page.

API keys in Ango Hub are generated per user within each organization. When authenticating requests, ensure you are using the API key that associates with the correct organization, as keys are not valid across different organizations.

To retrieve your API Key from the UI:

1. Navigate to your Account page in Ango Hub.

2. Go to the API tab.

3. Create a new API key or copy your existing key.

For more information, please visit the How to get your API key page.

Creating a new API key will revoke the existing one.

Obtaining Organization, Project, Asset, and Task IDs

Ango Hub assigns unique identifiers to organizations, projects, assets, and tasks. These IDs are commonly required when interacting with the SDK.

Organization IDs

To retrieve your Organization ID from the UI:

1. Navigate to the Account page.

2. Locate the Organization ID field under the Profile tab.

3. Click the Copy icon next to the field to copy the ID to your clipboard.

Project IDs

To retrieve a Project ID from the UI:

1. Navigate to Projects page.

2. Search for your project and click to open it.

3. On the project page, click the copy icon next to the project title to copy the ID to your clipboard.

Alternatively, you can obtain the Project ID from the URL. Project URLs follow this format:

https://imerit.ango.ai/projects/<project_id>

Simply copy the <project_id> portion from the URL.

Task and Asset IDs

To retrieve a Task or Asset ID from the UI:

1. Navigate to the Tasks or Assets tab within your project.

2. Click on the task or asset you want to inspect.

3. Open the Task Info section from the rightmost panel.

4. Find the Task or Asset ID and use the Copy icon to easily copy it to your clipboard.

Host and Base URL

This section explains how to configure the API and SDK when working with different Ango Hub instances.

• EU Instance (Default): Use the default host configuration when your workspace is hosted in the EU region.

• Other Instances: If your workspace is hosted in a different region (e.g., US), specify the appropriate host parameter when initializing the SDK and update the base URL accordingly in your API requests.

Using the correct host and base URL ensures that your requests are routed to the appropriate regional environment.

Deployment	Domain	Host
iMerit (Default)	https://imerit.ango.ai	https://imeritapi.ango.ai
EU instance (Default)	https://imerit.ango.ai	https://eu-api.ango.ai
US instance	https://us.ango.ai	https://us-api.ango.ai
India Instance	https://in.ango.ai	https://in-api.ango.ai
Test Environment	https://test.ango.ai	https://testapi.ango.ai

SDK & API usage example in EU instance:

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")

curl

SDK & API usage example in other instances:

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")

curl

Environmental Variables

Snippets on this page make the assumption that you have your API key and other variables set as environmental variables.

To set environmental variables, install the python-dotenv package from pip by running

pip install python-dotenv

in your Python environment.

Then, create a file called .env in your environment's root folder. The contents of this .env file will look like this:

API_KEY=00af1132-0558-4ec7-93e3-46826a455ac0
ORGANIZATION_ID=12a12345678b1234567aa12a
PROJECT_ID=1233453123dsfdf012

115B

variables.env

Open

Sample .env file

In your Python scripts, import the package and load the environmental variables by running load_dotenv() before using the variables in your script.

import os
from dotenv import load_dotenv

load_dotenv('variables.env')

You will then be able to access your environmental variables by using os.getenv("VAR_NAME"), like so:

API_KEY = os.getenv('API_KEY')

SDK Functions

Project

create_projectget_projectdelete_projectlist_projectscreate_label_setrequeue_tasksrerun_webhookreview_taskupdate_label_validationupdate_workflow_stagesupdate_tasks_priorityupload_instructions

Storage

create_storageget_storagesdelete_storage

Upload Data

upload_filesupload_files_cloudupload_files_with_asset_buildercreate_asset_builder_templateget_asset_builder_templatesupload_chat_assetsimport_labelscreate_attachmentdelete_assets

Batch

assign_batchescreate_batchget_batches

Members

invite_members_to_orgadd_members_to_projectget_organization_invitesget_organization_membersupdate_organization_members_roledelete_organization_invitesdelete_organization_membersassign_task

Issue

create_issueget_issuesdelete_issue

Export Data

exportget_assetsget_taskget_tasksget_task_historyget_metricsget_project_performance

Utility Functions

list_storage_files