βοΈJtheta API documentation
π JTheta.ai REST API Documentation
Welcome to the JTheta.ai API β your gateway to building end-to-end workflows for dataset creation, annotation task management, and AI-assisted labeling.
You need a API key to use REST API.Refer to the following documentation on how to create API key:
π Create JTheta API KeyBase URL:
https://api.jtheta.ai
π Quickstart: Validating Your API Key
β
GET /validate_key/
GET /validate_key/
Use this endpoint to test if your API key is valid.
Curl Example:
curl -X GET https://api.jtheta.ai/validate_key/ \
-H "Authorization: Bearer <your_api_key>"
Responses:
200 OK
: Valid API key401 Unauthorized
: Missing or invalid key
π Projects & Datasets
π POST /create_project/
POST /create_project/
Create a new project to group datasets and tasks.
Required JSON body:
{
"project_title": "Retinal Dataset",
"project_category": "Medical Imaging"
}
Responses:
201 Created
: Project created400 Bad Request
: Missing or invalid fields401 Unauthorized
: Invalid API key
π¦ POST /create_dataset/
POST /create_dataset/
Upload images into a new dataset under an existing project.
Required fields (multipart/form-data):
dataset_name
: name of the datasetproject_name
: project to associatelicense
: optional license infoimages
: multiple image files
Curl Example:
curl -X POST https://api.jtheta.ai/create_dataset/ \
-F dataset_name=TumorSlides \
-F project_name=RetinalResearch \
-F images=@slide1.png \
-F images=@slide2.png
Response:
201 Created
: Dataset and images uploaded
π₯ POST /upload_images_to_dataset/
POST /upload_images_to_dataset/
Add more images to an existing dataset.
Required fields (multipart/form-data):
dataset_id
: numeric IDproject_name
images
: additional image files
π©βπ« Annotation Workflow
βοΈ POST /request_annotation/
POST /request_annotation/
Assign annotators and reviewers to a dataset and define label types.
Required JSON:
{
"dataset_id": 1,
"project_name": "Tumor Study",
"assigned_annotator": "alice@domain.com",
"assigned_reviewer": "bob@domain.com",
"labels": [
{ "label": "Tumor", "type": "polygon" },
{ "label": "Blood Vessel", "type": "bounding_box" }
]
}
Response:
200 OK
: Task assigned
π GET /get_annotation_status/{project_title}/
GET /get_annotation_status/{project_title}/
Check the progress of annotation for a given project.
Path parameter:
project_title
: name of the project
ποΈ POST /delete_project/
POST /delete_project/
Delete a project and all associated datasets, images, and annotations.
JSON Body:
{
"project_title": "Old Medical Study"
}
π€ Export and Download
π₯ GET /api/export/download
GET /api/export/download
Get the datasetβs metadata and download URL.
Query parameter:
key
: your API access key
Example:
curl "https://api.jtheta.ai/api/export/download?key=<your_api_key>"
Response:
302 Found
: Redirects to download URL
Last updated