Jtheta.ai Docs
Launch Jtheta.ai
  • Getting Started
    • 🎯Introduction
  • πŸ§‘β€πŸ’»Login/Signup
  • WORKSPACE MANAGEMENT
    • 🏑Create Workspace
    • πŸ—οΈUser Access
    • πŸ‘¨β€πŸ’ΌUser Management
  • PROJECT MANAGEMENT
    • πŸ“Create Project
    • πŸ–ŠοΈAnnotation
      • ✈️AI Assist
      • βͺReview
      • πŸŒ€Types of Annotation
  • πŸ“–Project Analytics
  • DATASET MANAGEMENT
    • ◀️Release Version
    • πŸ“Manage Dataset
    • πŸ“°Clone Dataset
  • Jtheta REST API
    • βš™οΈJtheta API documentation
    • πŸ”Get started with REST API
      • Authentication
      • Create Project
      • Create Dataset
      • Upload images to a Dataset
      • Get Annotation Status
      • Request Annotations
      • Delete Project
      • Download Dataset
  • AUTHENTICATION
    • πŸ”‘ Create JTheta API Key
  • PYTHON SDK
    • JTheta Python SDK
Powered by GitBook
On this page
  • πŸ“˜ JTheta.ai REST API Documentation
  • πŸš€ Quickstart: Validating Your API Key
  • πŸ“ Projects & Datasets
  • πŸ‘©β€πŸ« Annotation Workflow
  • πŸ“€ Export and Download
  1. Jtheta REST API

Jtheta API documentation

PreviousClone DatasetNextGet started with REST API

Last updated 14 days ago

πŸ“˜ 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:

Base URL:

https://api.jtheta.ai

πŸš€ Quickstart: Validating Your API 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 key

  • 401 Unauthorized: Missing or invalid key


πŸ“ Projects & Datasets

πŸ†• 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 created

  • 400 Bad Request: Missing or invalid fields

  • 401 Unauthorized: Invalid API key


πŸ“¦ POST /create_dataset/

Upload images into a new dataset under an existing project.

Required fields (multipart/form-data):

  • dataset_name: name of the dataset

  • project_name: project to associate

  • license: optional license info

  • images: 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/

Add more images to an existing dataset.

Required fields (multipart/form-data):

  • dataset_id: numeric ID

  • project_name

  • images: additional image files


πŸ‘©β€πŸ« Annotation Workflow

✍️ 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}/

Check the progress of annotation for a given project.

Path parameter:

  • project_title: name of the 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 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

βš™οΈ
πŸ”‘ Create JTheta API Key