Setup

Learn how to get your API key and how to send requests to the platform.

Obtaining an API key

All accounts can request an API key by visiting the "API Settings" section of your account

How to get to settings page from dashboard

On the api-key page you can generate a new key with READ, WRITE, or both privileges.

If you generate a new key, please remember to copy the key to a safe location. This will be your only opportunity to copy the key and if you lose it you will need to generate a new one.

Sending an API Request

Anno Lab accepts generic http requests that can be made from any programming language. Throughout this documentation site we have provided code samples to see concrete usage in action. Authorization for the request must be included in the header, specifically in the Authorization section with the pattern shown below.

For particular routes and depending on how you send the request, you also may need to manually set the Content-Type header to have the value application/json. Many packages will automatically set this header (such as python requests used throughout this tutorial when you pass data using the json argument).

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())