Projects

Projects are the highest level abstraction in the Annotation Lab platform. They contain directories, source files, schemas, and annotation layers. They are also the scope at which work can be shared.

Create Project

POST https://api.annolab.ai/v1/project/create

Create a new project within your group

Headers

Name	Type	Description
Authorization	string	Where you put your api key. Creating a project requires a key with "Write" permissions. {"Authorization": "Api-key XXXXXXX-XXXXXXX-XXXXXXX"}

Request Body

Name	Type	Description
name	string	Name of the project you wish to create. Must be unique for your group {"name": "New NER Project"}

201 Project was successfully created

{
    "name": "New NER Project",
    "id": 22,
    "groupId": 14
}

400 Project creation failed

{
    "message": "Information about why creation failed"
}

Examples of how to make a project create request

Python

import requests

ANNO_LAB_API_KEY = 'XXXXXXX-XXXXXXX-XXXXXXX-XXXXXXX'

project = {
  'name': 'New NER Project'
}

headers = {
  'Authorization': 'Api-Key '+ANNO_LAB_API_KEY,
}

url = 'https://api.annolab.ai/v1/project/create'

response = requests.post(url, headers=headers, json=project)

print(response.json())

Get Project

GET https://api.annolab.ai/v1/project/{identifier}

Return details of a project given an identifier

Path Parameters

Name	Type	Description
identifier	string	Either the name or the id of a project url = "https://api.annolab.ai/v1/project/New%20NER%20Project" url = "https://api.annolab.ai/v1/project/12"

Headers

Name	Type	Description
Authorization	string	Where you put your api key. Getting a project requires an key with "Read" permissions {"Authorization": "Api-Key XXXXXXX-XXXXXXX-XXXXXXX"}

200 Project successfully retrieved

{
    "name": "New NER Project",
    "id": 22,
    "groupId": 14
}

404 Could not find a project matching the information

{}