Directories

Directories are containers for Source Files that can be used to help organize the contents of a project

Create Directory

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

Create a new directory within the project

Headers

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

Request Body

Name	Type	Description
projectIdentifier	string	Identifier of the project that the directory will be created within. Either id or the unique name of the project.
name	string	Name of the directory you wish to create

201 The directory was created

{
    "name": "Wikipedia Subset",
    "id": 12,
    "projectname": "New NER Project",
    "projectId": 22
}

400 The directory could not be created

{
    "message": "explanation for why directory could not be created"
}

Example of how to make the request to create a directory

Python

import requests

ANNO_LAB_API_KEY = 'XXXXXXX-XXXXXXX-XXXXXXX-XXXXXXX'

directory = {
  'projectIdentifier': 'New NER Project',
  'name': 'Wikipedia Subset'
}

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

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

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

print(response.json())