Sign in

v1

latestOpenAPI 3.0.02026-07-2480355389.7 KB
Imports

Register locally stored data to Darwin

Register locally stored data with Darwin for upload. The request response will contain an upload ID for each item. After this step, the upload needs to be signed, the upload URL from this response used, and the upload confirmed.

post/api/v2/teams/{team_slug}/items/register_upload

Path parameters

team_slugstring required

Team's sluggified name

Request body

dataset_slugstring required

Dataset's slugified name

Example request

{
  "dataset_slug": "my-dataset",
  "items": [
    {
      "layout": {
        "slots_grid": [
          [
            [
              "1",
              "2"
            ],
            "3"
          ],
          [
            "4"
          ]
        ],
        "version": 3
      },
      "name": "some-item",
      "slots": [
        {
          "file_name": "my_image.jpg",
          "slot_name": "0",
          "tags": [
            "tag_class_name1",
            "tag_class_name2"
          ]
        }
      ],
      "tags": [
        "tag_class_name1",
        "tag_class_name2"
      ]
    }
  ]
}

Response

DatasetsV2.ItemRegistration.RegistrationResponse

Example response

{
  "blocked_items": [
    {
      "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
      "name": "some-item",
      "slots": [
        {
          "file_name": "my_image.jpg",
          "size_bytes": 500,
          "slot_name": "0"
        }
      ]
    }
  ],
  "items": [
    {
      "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
      "name": "some-item",
      "slots": [
        {
          "file_name": "my_image.jpg",
          "size_bytes": 500,
          "slot_name": "0",
          "upload_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ]
    }
  ]
}