For the complete documentation index, see llms.txt. This page is also available as Markdown.

Import/Export

Bulk data import and export

Import Attachments

post
/attachments

Imports attachments and associates them with assets

Authorizations
apikeystringRequired

API key for authentication. Format - apikey YOUR_API_KEY

Body
projectstringRequired
Responses
200

Attachments imported successfully

application/json
statusstringOptionalExample: success
post/attachments
curl -X POST "https://imeritapi.ango.ai/v2/attachments" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project": "YOUR_PROJECT_ID",
    "attachments": [
      {
        "externalId": "image-001",
        "attachmentUrl": "https://example.com/attachment1.pdf",
        "attachmentType": "pdf"
      },
      {
        "assetId": "asset123",
        "attachmentUrl": "https://example.com/attachment2.doc",
        "attachmentType": "document"
      }
    ]
  }'
200

Attachments imported successfully

{
  "status": "success",
  "data": {
    "project": {
      "attachmentsImported": 1,
      "assetsUpdated": 1
    }
  }
}

Import Labels

post
/import/labels

Imports pre-labeled data into a project

Authorizations
apikeystringRequired

API key for authentication. Format - apikey YOUR_API_KEY

Body
projectstringRequired
Responses
200

Labels imported successfully

application/json
statusstringOptionalExample: success
post/import/labels
curl -X POST "https://imeritapi.ango.ai/v2/import/labels" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project": "YOUR_PROJECT_ID",
    "labels": [
      {
        "externalId": "image-001",
        "answer": {
          "objects": [
            {
              "schemaId": "box-tool-id",
              "bounding-box": {
                "x": 100,
                "y": 100,
                "width": 200,
                "height": 150
              },
              "title": "Car"
            }
          ]
        },
        "status": "Completed"
      },
      {
        "assetId": "asset456",
        "answer": {
          "objects": []
        }
      }
    ]
  }'
200

Labels imported successfully

{
  "status": "success",
  "data": {
    "project": "50 / 50 tasks are labeled."
  }
}

Export Tasks

get
/export

Exports task data from projects in various formats

Authorizations
apikeystringRequired

API key for authentication. Format - apikey YOUR_API_KEY

Query parameters
projectstringRequired

Project ID

Example: 507f1f77bcf86cd799439011
formatstring · enumOptional

Export format

Default: jsonPossible values:
typestring · enumOptional

Export type (task or issue)

Default: taskPossible values:
stagestringOptional

Filter by stages (JSON array string, e.g., ["Complete"])

Example: ["Complete"]
batchesstringOptional

Filter by batches (JSON array string, e.g., ["Batch1"])

Example: ["Batch1"]
sendEmailstring · enumOptional

Send export download link via email

Default: falsePossible values:
doNotNotifystring · enumOptional

Do not send notifications about export

Default: falsePossible values:
includeMetadatastring · enumOptional

Include asset metadata in export

Default: falsePossible values:
includeHistorystring · enumOptional

Include task history (all state changes)

Default: falsePossible values:
includeOnlyKeyFramesstring · enumOptional

Include only key frames for video annotations

Default: falsePossible values:
includeIdleBlurDurationsstring · enumOptional

Include idle and blur duration statistics

Default: falsePossible values:
updatedAtstringOptional

Filter by update date (JSON object, e.g., {"$gt":"2020-08-19T07:37:15.000000Z","$lt":"2020-08-26T07:37:15.000000Z"})

Example: {"$gt":"2020-08-19T07:37:15.000000Z","$lt":"2020-08-26T07:37:15.000000Z"}
createdAtstringOptional

Filter by creation date (JSON object, e.g., {"$gt":"2020-07-27T07:37:15.000000Z","$lt":"2020-08-26T07:37:15.000000Z"})

Example: {"$gt":"2020-07-27T07:37:15.000000Z","$lt":"2020-08-26T07:37:15.000000Z"}
filtersstringOptional

MongoDB-style filter object for advanced task filtering (JSON string). Supports any MongoDB query operators on task fields. Common use cases:

  • Filter by task IDs: {"_id": {"$in": ["taskId1", "taskId2"]}}
  • Filter by assignee: {"assignee": "user@example.com"}
  • Filter by external ID: {"externalId": {"$regex": "^prefix_"}}
Example: {"_id": {"$in": ["507f1f77bcf86cd799439011", "507f1f77bcf86cd799439012"]}}
Responses
200

Export prepared successfully

application/json
statusstringOptionalExample: success
get/export
curl -X GET "https://imeritapi.ango.ai/v2/export?project=YOUR_PROJECT_ID&format=json" \
  -H "apikey: YOUR_API_KEY"
200

Export prepared successfully

{
  "status": "success",
  "data": {
    "exportPath": "https://bucket.s3.amazonaws.com/exports/export-2025-01-17.json"
  }
}

Last updated