API Reference
All Data Annotation Engine Api endpoints can be found here.
For reference, this is the openapi JSON:
{
"openapi": "3.1.0",
"info": {
"title": "Data Annotation Service",
"version": "0.1.0"
},
"paths": {
"/annotations/{dataset_id}": {
"get": {
"summary": "Get Annotations",
"operationId": "get_annotations_annotations__dataset_id__get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"title": "Dataset Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/annotations": {
"post": {
"summary": "Execute Annotation",
"operationId": "execute_annotation_annotations_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnnotateItem"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/procedures": {
"get": {
"summary": "Get Procedures",
"operationId": "get_procedures_procedures_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/configuration/{dataset_id}": {
"get": {
"summary": "Get Configuration",
"operationId": "get_configuration_configuration__dataset_id__get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"title": "Dataset Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/configuration": {
"post": {
"summary": "Save Configuration",
"operationId": "save_configuration_configuration_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationItem"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/model": {
"get": {
"summary": "Get All Models",
"operationId": "get_all_models_model_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/model/{model_id}": {
"get": {
"summary": "Get Model",
"operationId": "get_model_model__model_id__get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/dataset": {
"get": {
"summary": "Get All Datasets",
"operationId": "get_all_datasets_dataset_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/dataset/{dataset_name}": {
"get": {
"summary": "Get Dataset",
"operationId": "get_dataset_dataset__dataset_name__get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "dataset_name",
"in": "path",
"required": true,
"schema": {
"title": "Dataset Name"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/data_model_info/{dataset_name}": {
"get": {
"summary": "Get Data Model Info",
"operationId": "get_data_model_info_data_model_info__dataset_name__get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "dataset_name",
"in": "path",
"required": true,
"schema": {
"title": "Dataset Name"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/data_model_info": {
"post": {
"summary": "Set Model Info",
"operationId": "set_model_info_data_model_info_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelInfo"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/schema/{dataset_name}": {
"get": {
"summary": "Get Schema",
"operationId": "get_schema_schema__dataset_name__get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "dataset_name",
"in": "path",
"required": true,
"schema": {
"title": "Dataset Name"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/schema": {
"post": {
"summary": "Set Schema",
"operationId": "set_schema_schema_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Schema"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
}
},
"components": {
"schemas": {
"AnnotateItem": {
"properties": {
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Data"
},
"dataset_id": {
"type": "string",
"title": "Dataset Id"
},
"identifier": {
"type": "string",
"title": "Identifier"
},
"sample_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sample Id"
},
"annotation_function": {
"type": "string",
"title": "Annotation Function"
},
"items": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Items"
},
"params": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Params"
}
},
"type": "object",
"required": [
"dataset_id",
"identifier",
"annotation_function"
],
"title": "AnnotateItem"
},
"ConfigurationItem": {
"properties": {
"dataset_id": {
"type": "string",
"title": "Dataset Id"
},
"methods": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Methods"
}
},
"type": "object",
"required": [
"dataset_id",
"methods"
],
"title": "ConfigurationItem"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"ModelInfo": {
"properties": {
"dataset_id": {
"type": "string",
"title": "Dataset Id"
},
"distribution_id": {
"type": "string",
"title": "Distribution Id"
},
"data_model_id": {
"type": "string",
"title": "Data Model Id"
},
"concept_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Concept Name"
}
},
"type": "object",
"required": [
"dataset_id",
"distribution_id",
"data_model_id",
"concept_name"
],
"title": "ModelInfo"
},
"Schema": {
"properties": {
"dataset_id": {
"type": "string",
"title": "Dataset Id"
},
"distribution_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Distribution Id"
},
"fields": {
"items": {},
"type": "array",
"title": "Fields"
}
},
"type": "object",
"required": [
"dataset_id",
"distribution_id",
"fields"
],
"title": "Schema"
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
}
},
"securitySchemes": {
"HTTPBearer": {
"type": "http",
"scheme": "bearer"
}
}
}
}