API Documentation
List of API Methods
Annotations
Get export from project
GET
https://imeritapi.ango.ai/v2/exportV3
Obtain export from project.
Headers
Name | Type | Description |
---|---|---|
apikey* | String | Your API key. |
Content-Type* | String | Response content type. Must be |
Upload pre-labels
POST
https://imeritapi.ango.ai/v2/import/labels
Obtain export from project.
Body:
{
"project": "<PROJECT_ID>",
"jsonContent": "string"
}
For the contents of jsonContent
, please refer to the documentation of the related SDK function.
Headers
Name | Type | Description |
---|---|---|
apikey* | String | Your API key. |
Content-Type* | String | Response content type. Must be |
Request Body
Name | Type | Description |
---|---|---|
project | String | Project ID where the assets to pre-label are located. |
jsonContent | String | Pre-labels. Please refer to the documentation of the related SDK function. |
Asset Management
Get Project Assets
GET
https://imeritapi.ango.ai/v2/project/{project_id}/assets
Get list of assets in a project.
Path Parameters
Name | Type | Description |
---|---|---|
project_id | String | ID of the project. |
Query Parameters
Name | Type | Description |
---|---|---|
page | String | Assets are paginated. Page number to obtain. Defaults to the first page. |
limit | String | Assets per page. Min/default: 10, max: 1000. |
Headers
Name | Type | Description |
---|---|---|
Content-Type* | String | Response content type. Must be |
apikey* | String | Your API key. |
Upload Assets from Storage
POST
https://imeritapi.ango.ai/v2/project/{project_id}/cloud
Uploads files from cloud storage to a specified Ango Hub project as assets.
Example request:
curl --location --request POST 'https://imeritapi.ango.ai/v2/project/61602b346ee9eb45e8273fbb/cloud'
--header 'Content-Type: application/json'
--header 'apikey: YOUR-API-KEY-HERE'
--data-raw '{ "assets": [ { "data": "https://bucket-name.s3.us-east-2.amazonaws.com/1605167545820-0b395d1ef7df81b7558f87eb47a59dda4dbe19bd.jpg", "externalId": "111" }, { "data": "https://bucket-name.s3.us-east-2.amazonaws.com/1605167545822-0b0b60d298c4afebed824d8ee2f793676c7835bf.jpg", "externalId": "113" } ] }'
Path Parameters
Name | Type | Description |
---|---|---|
project_id | String |
Headers
Name | Type | Description |
---|---|---|
Content-Type* | String | Response content type. Must be |
apikey* | String | Your API key. |
Request Body
Name | Type | Description |
---|---|---|
assets* | Array | Array of objects each containing two key-value pairs: |
Attachments
Create Attachment
POST
https://imeritapi.ango.ai/v2/attachments
Adds an attachment to an existing labeling task.
Example request:
curl --location --request POST 'https://imeritapi.ango.ai/v2/attachments'
--header 'apikey: YOUR-API-KEY-HERE'
--data-raw '{
"project": "61d444045e299635ed689056",
"attachments": [
{
"data": "https://angohub-public-assets.s3.eu-central-1.amazonaws.com/uploaded-data-0a0988b2-d6ca-420e-97e6-577b96417989.png",
"externalId": "uploaded-data-65dfb652-d7c8-4fa5-b6d5-de6bfe2a4365.png",
"attachments": [
{
"type": "IMAGE",
"value": "https://sample-image.jpg"
},
{
"type": "VIDEO",
"value": "http://sample-video.mp4"
},
{
"type": "TEXT",
"value": "Some sample text"
}
]
}
]
}'
Headers
Name | Type | Description |
---|---|---|
apikey* | String | Your API key. |
Request Body
Name | Type | Description |
---|---|---|
project* | String | ID of the project where the attachment is to be created. Found at the end of the project URL. |
attachments* | Array | Array of objects describing task/attachment pairs. See example. |
data* | String | URL to the asset where the attachment is to be added. |
externalId* | String | External ID of the asset. Found in the project under the Assets tab. |
type* | String | Attachment data type. Available types are IMAGE, VIDEO, and TEXT. Supported IMAGE file types are .png and .jpg. The supported video type is .mp4, and the supported text type is .txt. |
value* | String | In case the type is TEXT, the content of the attachment in plain text. In case the type is IMAGE or VIDEO, a URL linking to the image or video. |
Batches
Get batches of project
GET
https://imeritapi.ango.ai/v2/batches/{project_id}
Obtain list of batches existing within a project.
Path Parameters
Name | Type | Description |
---|---|---|
project_id | String | ID of the project. |
Headers
Name | Type | Description |
---|---|---|
apikey* | String | Your API key. |
Content-Type* | String | Response content type. Must be |
Create batch in project
POST
https://imeritapi.ango.ai/v2/batches/{project_id}
Create new batch in project.
Body:
{
"batches": "string"
}
Path Parameters
Name | Type | Description |
---|---|---|
project_id* | String | ID of the project where the batch is to be created. |
Headers
Name | Type | Description |
---|---|---|
apikey* | String | Your API key. |
Content-Type* | String | Response content type. Must be |
Request Body
Name | Type | Description |
---|---|---|
batches* | String | Name of the batch to create. |
Assign assets to batch
POST
https://imeritapi.ango.ai/v2/assignBatches
Create new batch in project.
Body:
{
"assets": ["<ASSET_ID1>", "<ASSET_ID2>"]
"batches": ["<BATCH_ID_1>", "<BATCH_ID_2>"]
}
Headers
Name | Type | Description |
---|---|---|
apikey* | String | Your API key. |
Content-Type* | String | Response content type. Must be |
Request Body
Name | Type | Description |
---|---|---|
batches* | String or [String] | Name(s) of the batch(es) to assign the asset(s) to. |
assets | String or [String] | ID(s) of the asset(s) to assign to the batch(es). |
Issues
Create Issue
POST
https://imeritapi.ango.ai/v2/issues
Creates an issue. If a position
parameter is sent, the issue will be created at the position requested (on single images, multi-page TIFFs, video, and text only.)
Example request:
curl --location --request POST 'https://imeritapi.ango.ai/v2/issues'
--header 'apikey: YOUR-API-KEY-HERE'
--data-raw '{ "content":"Issue Text Here", "labelTask": "6143498454e17400149964d1", "position": "[50,120]" }'
Headers
Name | Type | Description |
---|---|---|
apikey* | String | Your API key. |
Request Body
Name | Type | Description |
---|---|---|
content* | String | Issue text |
labelTask* | String | ID of the label task where the issue is to be created. |
position | String | For images: stringified array with the X and Y position where the issue is to be created on the asset. Example: "[50, 120]" For text: stringified index of the character in the text where the issue will be created. Example: "54". |
page | Int | For multi-page TIFFs and videos, the zero-indexed page/frame number where the issue is to be displayed. |
Organization Management
Get Organization Storages
GET
https://imeritapi.ango.ai/v2/storages
Obtain list of connected storages in the organization.
Headers
Name | Type | Description |
---|---|---|
apikey* | String | Your API key. |
Content-Type* | String | Response content type. Must be |
Project Management
List All Projects
GET
https://imeritapi.ango.ai/v2/listProjects
Returns a list of all projects visible to the user.
Example request:
curl --location --request GET 'https://imeritapi.ango.ai/v2/listProjects' --header 'Content-Type: application/json' --header 'apikey: YOUR-API-KEY-HERE'
Query Parameters
Name | Type | Description |
---|---|---|
page | String | Projects are paginated. This parameter is the page number. Will get the first page by default. |
limit | String | Number of projects per page (default 10, max 1000). |
Headers
Name | Type | Description |
---|---|---|
Content-Type* | String | Response content type. Must be |
apikey* | String | Your API key. |
Get Project Information
GET
https://imeritapi.ango.ai/v2/project/{project_id}
Returns information about a project, including labeling tools, consensus count, assigned users, review configuration, and name and description.
Example request:
curl --location --request GET 'https://imeritapi.ango.ai/v2/project/61602b346ee9eb45e8273fbb' --header 'Content-Type: application/json' --header 'apikey: YOUR-API-KEY-HERE'
Path Parameters
Name | Type | Description |
---|---|---|
project_id | String | ID of the project to get. (e.g. |
Headers
Name | Type | Description |
---|---|---|
Content-Type* | String | Response content type. Must be |
apikey* | String | Your API key. |
Get Project Tasks
GET
https://imeritapi.ango.ai/v2/project/{project_id}/tasks
Returns all tasks in a project, with all of their information, including labeling tools, status, etc.
Example request:
curl --location --request GET 'https://imeritapi.ango.ai/v2/project/615ffd3c455fc7000e6c45eb/tasks' --header 'Content-Type: application/json' --header 'apikey: YOUR-API-KEY-HERE'
Path Parameters
Name | Type | Description |
---|---|---|
project_id* | String | ID of the project to get the tasks of. |
Query Parameters
Name | Type | Description |
---|---|---|
page | String | Tasks are paginated. Page number of the page of the tasks to obtain. Will get first page by default. |
limit | String | Number of tasks per page. Default/minimum: 10, max: 1000. |
status[eq] | String | Filter by status. {'Completed', 'TODO'} |
batches | String | Filter by batch. Batch ID. |
stage | String | Filter by stage. Stage ID. |
Headers
Name | Type | Description |
---|---|---|
Content-Type* | String | Response content type. Must be |
apikey* | String | Your API key. |
Get a metric from a project
GET
https://imeritapi.ango.ai/v2/{project_id}/overview/{metric}
Get a specific metric from a project.
The metric can be one of: "LabelStageGroups", "TimePerTask", "AnnotationStatus", "AnswerDistribution", "ConsensusRanges", "AssetSize".
Path Parameters
Name | Type | Description |
---|---|---|
project_id* | String | ID of the project. |
metric* | String | Metric to obtain. |
Headers
Name | Type | Description |
---|---|---|
apikey* | String | Your API key. |
Content-Type* | String | Response content type. Must be |
Create new project
POST
https://imeritapi.ango.ai/v2/project
Create new project in organization.
Body:
{
"name": "string"
"description": "string"
}
Headers
Name | Type | Description |
---|---|---|
apikey* | String | Your API key. |
Content-Type* | String | Response content type. Must be |
Request Body
Name | Type | Description |
---|---|---|
name* | String | Name of the new project. |
description | String | Description of the new project. |
Create Label Set
POST
https://imeritapi.ango.ai/v2/project/{project_id}
Sets the project ontology. For the format of the categorySchema
object to pass, please create the ontology from the UI, then follow these instructions to copy it to your clipboard.
Example value for the body:
{
"categorySchema": {
"tools": [
{
"title": "Vehicle",
"tool": "bounding-box",
"schemaId": "e94536...",
...
}
],
"classifications": [classifications],
"relations": [relations]
}
}
Headers
Name | Type | Description |
---|---|---|
Content-Type* | String | Response content type. Must be |
apikey | String | Your API key. |
Request Body
Name | Type | Description |
---|---|---|
categorySchema* | Dict | Category schema to pass. See example above. Obtain it from the UI, in the project settings -> Category Schema section. |
Tasks
Get Task
GET
https://imeritapi.ango.ai/v2/task/{task_id}
Returns all information about a task given the task's ID.
Example request:
curl --location --request GET 'https://imeritapi.ango.ai/v2/task/616433306b763c8c0e922b14' --header 'Content-Type: application/json' --header 'apikey: YOUR-API-KEY-HERE'
Path Parameters
Name | Type | Description |
---|---|---|
task_id | String | ID of the task to get information of. |
Headers
Name | Type | Description |
---|---|---|
Content-Type* | String | Response content type. Must be |
apikey* | String | Your API key. |
Get a task's history
GET
https://imeritapi.ango.ai/v2/taskHistory/{id}
Gets the history of a task.
Path Parameters
Name | Type | Description |
---|---|---|
id* | String | ID of the task. |
Headers
Name | Type | Description |
---|---|---|
apikey* | String | Your API key. |
Content-Type* | String | Response content type. Must be |
Assign Task to User
POST
https://imeritapi.ango.ai/v2/task/assign
Assign a task to a specific user.
Sample body:
{
"project": "<project_ID>",
"tasks": [ "<TASK_ID>", "<TASK2_ID>" ],
"stage": "<STAGE_ID>",
"user": "<USER_EMAIL>"
}
Headers
Name | Type | Description |
---|---|---|
apikey* | String | Your API key. |
Content-Type* | String | Response content type. Must be |
Request Body
Name | Type | Description |
---|---|---|
project* | ID of the project where the task to assign is located. | |
tasks* | [ String ] | List of task IDs of the tasks to assign. |
stage* | String | Stage ID where the tasks to assign are located. |
user | String | E-mail of the user to which the tasks will be assigned. |
Last updated