API

How to use the Token-API of DataGym

Overview
With our REST-API you can easily manage your data within the DataGym application. This documentation will guide you through installation, setup and descriptions of each available endpoint.
Usage
To use the API you need a valid API token for your organisation. 
You have two options to authenticate your application/call against our API.
Authorization header
"Authorization": "Token <your_DataGym_API_token>"
Request parameter
https://app.datagym.ai/api/v1/project?token=<your_DataGym_API_token>
get
https://app.datagym.ai
/api/v1/project
Get All Projects
get
https://app.datagym.ai
/api/v1/dataset/{datasetId}
Get Dataset by Id
get
https://app.datagym.ai
/api/v1/dataset
Get All Datasets
post
https://app.datagym.ai
/api/v1/dataset
Create Dataset
post
https://app.datagym.ai
/api/v1/project/{projectId}/dataset/{datasetId}
Add Dataset to Project
delete
https://app.datagym.ai
/api/v1/project/{projectId}/dataset/{datasetId}/remove
Remove Dataset from Project
post
https://app.datagym.ai
/api/v1/image/{datasetId}/url
Create image (shareable link set)
post
https://app.datagym.ai
/api/v1/image/{datasetId}/file
Create image (local)
get
https://app.datagym.ai
/api/v1/image/{imageId}
Download Image
delete
https://app.datagym.ai
/api/v1/image/{imageId}
Delete Image
get
https://app.datagym.ai
/api/v1/export/{projectId}
Export Labels
post
https://app.datagym.ai
/api/v1/project/{projectID}/prediction
Import label
get
/api/v1/export/bitmap/{taskId}/{exportKey}
Export segmentation bitmaps
delete
https://app.datagym.ai
/api/v1/config/{configId}
Clear Label Configuration
put
https.//app.datagym.ai
/api/v1/config/{configId}
Upload Label Configuration
The Body Parameter entries is a JSON Object with all Entries of the new Label Configuration. There are three required fields for all Entries (geometries and classifications): 
entryKey
entryValue
type
Example: JSON with all geometries:
[
    {
        "entryKey": "linekey",
        "entryValue": "LineValue",
        "type": "line",
        "color": "green",
        "shortcut": "1",
        "children": []
    },
    {
        "entryKey": "pointkey",
        "entryValue": "PointValue",
        "type": "point",
        "color": "red",
        "shortcut": "3",
        "children": []
    },
    {
        "entryKey": "polygonkey",
        "entryValue": "PolyValue",
        "type": "polygon",
        "color": "blue",
        "shortcut": "5",
        "children": []
    },
    {
        "entryKey": "rectanglekey",
        "entryValue": "RectValue",
        "type": "rectangle",
        "color": "black",
        "shortcut": "8",
        "children": []
    }
]
After the upload you will see the following Label Configuration for this Project:
Label Configuration
Example: JSON with all classifications:
[
    {
        "entryKey": "checklistkey",
        "entryValue": "CheckValue",
        "type": "checklist",
        "required": true,
        "options": {
            "firstCheckListOptionKey": "firstCheckListOptionValue",
            "secondCheckListOptionKey": "secondCheckListOptionValue",
            "thirdCheckListOptionKey": "thirdCheckListOptionValue"
        },
        "children": []
    },
    {
        "entryKey": "freetextkey",
        "entryValue": "FreeTextValue",
        "type": "freetext",
        "required": false,
        "maxLength": 15,
        "children": []
    },
    {
        "entryKey": "selectkey",
        "entryValue": "SelectValue",
        "type": "select",
        "required": false,
        "options": {
            "firstSelectOptionKey": "firstSelectOptionValue",
            "secondSelectOptionKey": "secondSelectOptionValue",
            "thirdSelectOptionKey": "thirdSelectOptionValue"
        },
        "children": []
    }
]
After the upload you will see the following Label Configuration for this Project:
Label Configuration
You can combine and nest Geometries and Classifications to create your Label Configuration, for example:
[
    {
        "entryKey": "linekey",
        "entryValue": "LineValue",
        "type": "line",
        "color": "green",
        "shortcut": "1",
        "children": [
            {
                "entryKey": "checklistkey",
                "entryValue": "CheckValue",
                "type": "checklist",
                "required": true,
                "options": {
                    "firstCheckListOptionKey": "firstCheckListOptionValue",
                    "secondCheckListOptionKey": "secondCheckListOptionValue",
                    "thirdCheckListOptionKey": "thirdCheckListOptionValue"
                },
                "children": [
                    {
                        "entryKey": "freetextkey",
                        "entryValue": "TextValue",
                        "type": "freetext",
                        "required": false,
                        "maxLength": 15,
                        "children": []
                    }
                ]
            }
        ]
    },
    {
        "entryKey": "pointkey",
        "entryValue": "PointValue",
        "type": "point",
        "color": "red",
        "shortcut": "3",
        "children": []
    },
    {
        "entryKey": "polygonkey",
        "entryValue": "PolyValue",
        "type": "polygon",
        "color": "blue",
        "shortcut": "5",
        "children": []
    },
    {
        "entryKey": "rectanglekey",
        "entryValue": "RectValue",
        "type": "rectangle",
        "color": "black",
        "shortcut": "8",
        "children": []
    }
]
Label Configuration with nested Entries

AI-Assistant - Previous

Object Classes

Next - API Token

Manage API Token

Last modified 1yr ago