Jtheta API documentation
Last updated
Last updated
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:
GET /validate_key/
Use this endpoint to test if your API key is valid.
Curl Example:
Responses:
200 OK
: Valid API key
401 Unauthorized
: Missing or invalid key
POST /create_project/
Create a new project to group datasets and tasks.
Required JSON body:
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:
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
POST /request_annotation/
Assign annotators and reviewers to a dataset and define label types.
Required JSON:
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:
GET /api/export/download
Get the datasetβs metadata and download URL.
Query parameter:
key
: your API access key
Example:
Response:
302 Found
: Redirects to download URL