Skip to main content
POST
/
data
/
projects
/
{id}
/
batches
Create project batch
curl --request POST \
  --url https://acusight.io/api/data/projects/{id}/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "data": {
    "created_at": "<string>",
    "device_id": "<string>",
    "id": 123,
    "images": [
      {
        "annotation_status": "<string>",
        "annotations": [
          {
            "class_value": "<string>",
            "confidence": 123,
            "created_at": "<string>",
            "geometry": [
              123
            ],
            "height": 123,
            "id": 123,
            "image_id": 123,
            "model_id": "<string>",
            "model_name": "<string>",
            "model_version": "<string>",
            "source": "<string>",
            "type": "<string>",
            "updated_at": "<string>",
            "width": 123,
            "x_center": 123,
            "y_center": 123,
            "z_order": 123
          }
        ],
        "batch": "<unknown>",
        "batch_id": 123,
        "created_at": "<string>",
        "device_id": "<string>",
        "filename": "<string>",
        "height": 123,
        "id": 123,
        "split": "<string>",
        "split_locked": true,
        "storage_key": "<string>",
        "updated_at": "<string>",
        "width": 123
      }
    ],
    "last_image_received_at": "<string>",
    "name": "<string>",
    "organization_id": "<string>",
    "project": {
      "batches": "<array>",
      "classes": [
        {
          "color": "<string>",
          "created_at": "<string>",
          "id": 123,
          "name": "<string>",
          "project": "<unknown>",
          "project_id": 123,
          "raw_value": "<string>",
          "updated_at": "<string>"
        }
      ],
      "created_at": "<string>",
      "description": "<string>",
      "id": 123,
      "name": "<string>",
      "organization_id": "<string>",
      "project_type": "<string>",
      "updated_at": "<string>",
      "versions": [
        {
          "created_at": "<string>",
          "id": 123,
          "name": "<string>",
          "pipeline_config": [
            123
          ],
          "project": "<unknown>",
          "project_id": 123,
          "updated_at": "<string>",
          "version": 123,
          "version_annotations": [
            {
              "geometry": [
                123
              ],
              "height": 123,
              "id": 123,
              "original_annotation": {
                "class_value": "<string>",
                "confidence": 123,
                "created_at": "<string>",
                "geometry": [
                  123
                ],
                "height": 123,
                "id": 123,
                "image_id": 123,
                "model_id": "<string>",
                "model_name": "<string>",
                "model_version": "<string>",
                "source": "<string>",
                "type": "<string>",
                "updated_at": "<string>",
                "width": 123,
                "x_center": 123,
                "y_center": 123,
                "z_order": 123
              },
              "original_annotation_id": 123,
              "type": "<string>",
              "version": "<unknown>",
              "version_class_value": "<string>",
              "version_id": 123,
              "version_image": {
                "annotations": "<array>",
                "filename": "<string>",
                "height": 123,
                "id": 123,
                "original_image": {
                  "annotation_status": "<string>",
                  "annotations": [
                    {
                      "class_value": "<string>",
                      "confidence": 123,
                      "created_at": "<string>",
                      "geometry": [
                        123
                      ],
                      "height": 123,
                      "id": 123,
                      "image_id": 123,
                      "model_id": "<string>",
                      "model_name": "<string>",
                      "model_version": "<string>",
                      "source": "<string>",
                      "type": "<string>",
                      "updated_at": "<string>",
                      "width": 123,
                      "x_center": 123,
                      "y_center": 123,
                      "z_order": 123
                    }
                  ],
                  "batch": "<unknown>",
                  "batch_id": 123,
                  "created_at": "<string>",
                  "device_id": "<string>",
                  "filename": "<string>",
                  "height": 123,
                  "id": 123,
                  "split": "<string>",
                  "split_locked": true,
                  "storage_key": "<string>",
                  "updated_at": "<string>",
                  "width": 123
                },
                "original_image_id": 123,
                "split": "<string>",
                "storage_key": "<string>",
                "version": "<unknown>",
                "version_batch": {
                  "id": 123,
                  "images": "<array>",
                  "name": "<string>",
                  "original_batch": "<unknown>",
                  "original_batch_id": 123,
                  "project_id": 123,
                  "version": "<unknown>",
                  "version_id": 123
                },
                "version_batch_id": 123,
                "version_id": 123,
                "width": 123
              },
              "version_image_id": 123,
              "width": 123,
              "x_center": 123,
              "y_center": 123
            }
          ],
          "version_batches": [
            {
              "id": 123,
              "images": "<array>",
              "name": "<string>",
              "original_batch": "<unknown>",
              "original_batch_id": 123,
              "project_id": 123,
              "version": "<unknown>",
              "version_id": 123
            }
          ],
          "version_classes": [
            {
              "color": "<string>",
              "id": 123,
              "name": "<string>",
              "original_class": {
                "color": "<string>",
                "created_at": "<string>",
                "id": 123,
                "name": "<string>",
                "project": "<unknown>",
                "project_id": 123,
                "raw_value": "<string>",
                "updated_at": "<string>"
              },
              "original_class_id": 123,
              "raw_value": "<string>",
              "version": "<unknown>",
              "version_id": 123
            }
          ],
          "version_images": [
            {
              "annotations": "<array>",
              "filename": "<string>",
              "height": 123,
              "id": 123,
              "original_image": {
                "annotation_status": "<string>",
                "annotations": [
                  {
                    "class_value": "<string>",
                    "confidence": 123,
                    "created_at": "<string>",
                    "geometry": [
                      123
                    ],
                    "height": 123,
                    "id": 123,
                    "image_id": 123,
                    "model_id": "<string>",
                    "model_name": "<string>",
                    "model_version": "<string>",
                    "source": "<string>",
                    "type": "<string>",
                    "updated_at": "<string>",
                    "width": 123,
                    "x_center": 123,
                    "y_center": 123,
                    "z_order": 123
                  }
                ],
                "batch": "<unknown>",
                "batch_id": 123,
                "created_at": "<string>",
                "device_id": "<string>",
                "filename": "<string>",
                "height": 123,
                "id": 123,
                "split": "<string>",
                "split_locked": true,
                "storage_key": "<string>",
                "updated_at": "<string>",
                "width": 123
              },
              "original_image_id": 123,
              "split": "<string>",
              "storage_key": "<string>",
              "version": "<unknown>",
              "version_batch": {
                "id": 123,
                "images": "<array>",
                "name": "<string>",
                "original_batch": "<unknown>",
                "original_batch_id": 123,
                "project_id": 123,
                "version": "<unknown>",
                "version_id": 123
              },
              "version_batch_id": 123,
              "version_id": 123,
              "width": 123
            }
          ]
        }
      ]
    },
    "project_id": 123,
    "source": "<string>",
    "stage": "<string>",
    "status": "<string>",
    "tags": [
      "<string>"
    ],
    "updated_at": "<string>"
  },
  "error": {
    "code": "<string>",
    "details": "<string>",
    "message": "<string>"
  },
  "meta": {
    "count": 123,
    "limit": 123,
    "offset": 123,
    "total": 123
  },
  "success": true
}

Authorizations

Authorization
string
header
required

JWT access token. Paste the token only; the Bearer prefix is added automatically.

Path Parameters

id
integer
required

Project ID

Body

application/json

Batch creation payload

The body is of type object.

Response

Batch created

data
object
error
object
meta
object
success
boolean