API

The API is available at https://api.segments.ai/. 
To authenticate, add an API key in the header of each request:
curl -H "Authorization: APIKey YOUR_API_KEY"
An API key can be created on your user account page.
Datasets
Get a dataset
GET /datasets/:owner_name/:dataset_name
Response
Status: 200 OK
{
    "name": "cats",
    "description": "A dataset of cat images.",
    "data_type": "IMAGE",
    "category": "other",
    "public": false,
    "owner": {
        "username": "bert",
        "email": "bert@segments.ai",
        "created_at": "2020-05-11T14:00:53.763278Z"
    },
    "created_at": "2020-07-20T14:59:36.242218Z",
    "collaborators_count": 0,
    "samples_count": 94,
    "tasks": [
        {
            "name": "segmentation",
            "task_type": "segmentation-bitmap",
            "attributes": {
                "format_version": "0.1",
                "categories": [
                    {
                        "name": "cat",
                        "id": 0
                    },
                    {
                        "name": "dog",
                        "id": 1
                    }
                ]
            },
            "created_at": "2020-07-20T14:59:42.675157Z"
        }
    ]
}
Samples
Get all samples in a dataset
GET /datasets/:owner/:dataset/samples
Response
Status: 200 OK
[
  {
    "uuid": "10130ecd-790e-463d-86ce-747f5c545c77",
    "name": "image.png"
    "data_type": "IMAGE",
    "attributes": {
        "image": {"url": "https://example.com/image.png"}
      }
    "created_at": "2011-04-10T20:09:31Z"
    "created_by": "jane"
  }
]
Get a sample
GET /samples/:sample_uuid
Response
Status: 200 OK
{
  "uuid": "10130ecd-790e-463d-86ce-747f5c545c77",
  "name": "image.png"
  "data_type": "IMAGE",
  "attributes": {
    "image": {"url": "https://example.com/image.png"}
  }
  "created_at": "2011-04-10T20:09:31Z"
  "created_by": "jane"
}
Create a sample
POST /datasets/:owner/:dataset/samples
Input
Name
Type
Description
name
string
Required. The name of the sample.
attributes
object
Sample data.
Example
{
  "name": "flowers.png",
  "attributes": {
    "image": {
      "url": "https://example.com/image.png"
    }
  }
}
Response
Status: 201 Created
{
  "uuid": "10130ecd-790e-463d-86ce-747f5c545c77",
  "name": "image.png"
  "data_type": "IMAGE",
  "attributes": {
    "image": {
      "url": "https://example.com/image.png"
    }
  }
  "created_at": "2011-04-10T20:09:31Z"
  "created_by": "jane"
}
Labels
Get a label
GET /labels/:sample_uuid/:task_name
Response
Status: 200 OK
{
  "label_type": "segmentation-bitmap",
  "label_status": "LABELED",
  "attributes": {
    "annotations": [
      {
        "id": 1, 
        "category_id": 0
      }
    ],
    "segmentation_bitmap": {
      "url": "https://segmentsai-staging.s3.eu-west-2.amazonaws.com/assets/davy/ddf55e99-1a6f-42d2-83e9-8657de3259a1.png"
    }
  },
  "created_at": "2011-04-10T20:09:31Z",
  "created_by": "jane"
}
Introduction
Python SDK
Last updated 2 months ago
Name	Type	Description
`name`	`string`	Required. The name of the sample.
`attributes`	`object`	Sample data.