Computer vision · API / SDK

Label Studio API

HumanSignal

Create labeling projects and exchange annotation data programmatically.

Official documentationDownload development spec

LABEL STUDIO / HUMANSIGNAL / DEVELOPER FIELD GUIDE

Choose an interface. Define a verifiable result.

Company or project context, ten technical entry points and a practical analysis of every reference.

2026-10-08 · Integration not tested

Company / project overview

Original summary of official company or project statements; use the source for the full original page.

Label Studio / HumanSignal · About
CompanyHumanSignal is the company behind the open-source Label Studio project; its About page dates the company to 2019.
PurposeIts stated approach puts people, data and domain expertise into ML/AI workflows.
Product contextThe company offers Label Studio Enterprise alongside the community project, with additional workflow and governance capabilities.
Our fit assessmentA candidate for multimodal labeling and human review; treat edition selection, model serving and annotation acceptance as separate decisions.
Complete official About page ↗
About reference — TA analysis
AudienceBuyers, partners and product owners shortlisting an AI provider.
Our assessmentUse positioning and company history for initial fit. Obtain project-specific deployment, support and commercial terms separately.

Official documentation read on 2026-10-08. No API was called; proposed checks and examples are our analysis.

Top 10 technical entry points

Ten documented interfaces, operations or tools selected by integration task; not an official ranking or ten separate SDKs.

Choose by the work you need to complete
InterfacePurpose and audience
01 · Python SDKSDKUse typed SDK resources to access Label Studio from scripts.Python / data platform
02 · Project creationSDK operationCreate a project with a title and labeling configuration.Annotation platform / project owner
03 · Labeling configurationInterface schemaDefine labeling interfaces with XML tags and connected controls.UX / annotation domain expert
04 · Task importData ingestionImport task data for configured labeling projects.Data engineer / annotation lead
05 · Prediction importPre-annotation interfaceLoad model predictions as pre-annotations tied to the labeling configuration.ML engineer / human-in-the-loop team
06 · Annotation creationREST operationAttach annotation results to a task.Backend / annotation migration
07 · Annotation export and snapshotsDataset deliveryExport annotations or create and download a snapshot.ML training / dataset release
08 · Custom ML backendModel adapterImplement predict and optional fit logic for model-assisted labeling.ML / serving engineer
09 · Source and target storageStorage integrationConnect source media and target annotation storage per project.Infrastructure / data owner
10 · WebhooksEvent integrationSend selected project or annotation events to an HTTP receiver.Pipeline / backend engineer

Reference analysis

Capabilities summarize official documentation. Constraints and proposed tests are our engineering assessment.

01

SDK

Python SDK

Python SDK · TA
Target audiencePython / data platform
Documented capabilityUse typed SDK resources to access Label Studio from scripts.
Input → outputServer URL and access token → resource operations
Execution environmentPython client and selected Label Studio deployment.
Our decision constraintSDK generations and token types differ; some endpoints require paid editions.
Our suggested validationPin SDK/server versions; verify identity and configure timeouts before writes.
Official reference · Python SDK ↗
02

SDK operation

Project creation

Project creation · TA
Target audienceAnnotation platform / project owner
Documented capabilityCreate a project with a title and labeling configuration.
Input → outputProject specification → project ID
Execution environmentLabel Studio server.
Our decision constraintA repeated create request can create another project; retain returned identity.
Our suggested validationRetrieve the intended project and compare its configuration before importing tasks.
Official reference · Project creation ↗
03

Interface schema

Labeling configuration

Labeling configuration · TA
Target audienceUX / annotation domain expert
Documented capabilityDefine labeling interfaces with XML tags and connected controls.
Input → outputObject/control tags → labeling UI
Execution environmentRendered labeling frontend with project configuration.
Our decision constraintRenaming tags can break existing prediction/result mappings.
Our suggested validationTest one fixture per label and validate from_name/to_name bindings.
Official reference · Labeling configuration ↗
04

Data ingestion

Task import

Task import · TA
Target audienceData engineer / annotation lead
Documented capabilityImport task data for configured labeling projects.
Input → outputTask JSON or supported data files → labeling tasks
Execution environmentServer import plus accessible media storage.
Our decision constraintImported metadata is not proof that annotators can load the media.
Our suggested validationReconcile external sample IDs, task counts and browser media access.
Official reference · Task import ↗
05

Pre-annotation interface

Prediction import

Prediction import · TA
Target audienceML engineer / human-in-the-loop team
Documented capabilityLoad model predictions as pre-annotations tied to the labeling configuration.
Input → outputModel results and version → proposed regions/labels
Execution environmentPrediction generation is external; Label Studio displays proposals.
Our decision constraintPredictions are not automatically human-approved ground truth.
Our suggested validationPreserve model version and compare prediction region IDs with reviewed annotations.
Official reference · Prediction import ↗
06

REST operation

Annotation creation

Annotation creation · TA
Target audienceBackend / annotation migration
Documented capabilityAttach annotation results to a task.
Input → outputTask ID and configured results → annotation record
Execution environmentLabel Studio annotation API.
Our decision constraintResult structure depends on controls; cancelled/skipped annotations are not negative examples.
Our suggested validationValidate schema, ownership and cancelled flags before training export.
Official reference · Annotation creation ↗
07

Dataset delivery

Annotation export and snapshots

Annotation export and snapshots · TA
Target audienceML training / dataset release
Documented capabilityExport annotations or create and download a snapshot.
Input → outputProject export selection → dataset file
Execution environmentServer export and chosen downstream format.
Our decision constraintImage JSON boxes use percentages; formats and editions differ in included tasks and background processing.
Our suggested validationConvert a known rectangle and reconcile exported, skipped and unannotated tasks separately.
Official reference · Annotation export and snapshots ↗
08

Model adapter

Custom ML backend

Custom ML backend · TA
Target audienceML / serving engineer
Documented capabilityImplement predict and optional fit logic for model-assisted labeling.
Input → outputTasks and interaction context → predictions
Execution environmentSeparately deployed ML backend connected to Label Studio.
Our decision constraintConnecting the backend does not supply trained weights or guarantee prediction schema compatibility.
Our suggested validationTest health, one task, malformed output and backend unavailability.
Official reference · Custom ML backend ↗
09

Storage integration

Source and target storage

Source and target storage · TA
Target audienceInfrastructure / data owner
Documented capabilityConnect source media and target annotation storage per project.
Input → outputStorage configuration and sync → task references or exported annotations
Execution environmentLabel Studio, object storage and annotator browsers.
Our decision constraintSource sync is not automatic bidirectional consistency; browser access also needs validation.
Our suggested validationTest a newly added file, expired presigned URL and output write permission.
Official reference · Source and target storage ↗
10

Event integration

Webhooks

Webhooks · TA
Target audiencePipeline / backend engineer
Documented capabilitySend selected project or annotation events to an HTTP receiver.
Input → outputLabeling event → event payload
Execution environmentServer-to-server receiver with configured authentication headers.
Our decision constraintThe guide states failed webhook connections are not retried; design reconciliation.
Our suggested validationAcknowledge quickly, queue processing and compare missed events with authoritative task records.
Official reference · Webhooks ↗

Access tokens

Access tokens · Supporting reference analysis
TABackend owner: token type, refresh and deployment policy.
Our validation adviceMatch the authentication scheme to the token type; do not paste tokens into examples or logs.
Official reference · Access tokens ↗

ML pipeline overview

ML pipeline overview · Supporting reference analysis
TATechnical PM: separate labeling, predictions and model execution.
Our validation adviceDefine who supplies the model and where media is processed before enabling automation.
Official reference · ML pipeline overview ↗

Primary developer documentation

Primary developer documentation · Supporting reference analysis
TAEngineers choosing the supported API and installed version.
Our validation adviceMatch the operation and version to the specific references above before implementation. The illustrative output is an internal application contract.
Official reference · Primary developer documentation ↗

04 / INPUT · EXPECTED OUTPUT · ACCEPTANCE

Expected results before implementation

Illustrative reviewed-image annotation contract, with explicit percentage-to-pixel conversion.

Illustrative contract · no API call or model execution · not measured provider output

Reviewed region

Expected behavior — illustrative, not executed
InputKnown rectangle on a 1000×500 image.
Expected resultok; correct percentage and pixel coordinates.
AcceptanceExact task/control mapping and coordinate conversion.

Reviewed empty

Expected behavior — illustrative, not executed
InputExplicitly reviewed no-defect sample.
Expected resultok; regions=[] with review provenance.
AcceptanceNo cancelled or unlabelled task treated as negative.

Skipped task

Expected behavior — illustrative, not executed
InputAnnotation marked cancelled/skipped.
Expected resultpending; excluded from accepted ground truth.
AcceptanceSkipped count remains visible in reconciliation.

Configuration mismatch

Expected behavior — illustrative, not executed
InputPrediction refers to a missing control name.
Expected resulterror; data=null; schema_mismatch.
AcceptanceReject before storing misleading training labels.

Map the expected result to your application

Agree XML control names, label schema and review policy first. The following JSON is an invented internal example, not a native API request/response or a completed annotation.

Expected output JSON — illustrative, not measured · LabelStudioAPI-expected-results.json
{
  "schema_version": "1.0.0",
  "provider": "Label Studio",
  "status": "ok",
  "example": true,
  "contract_origin": "Smart Tools illustrative internal contract; not a provider response",
  "input": {
    "task_ref": "example-panel-7",
    "image_size_pixels": [
      1000,
      500
    ],
    "control": "defects",
    "object": "image"
  },
  "data": {
    "origin": "human_reviewed",
    "cancelled": false,
    "regions": [
      {
        "label": "scratch",
        "region_ref": "example-region-1",
        "box_xywh_percent": [
          10,
          20,
          30,
          10
        ],
        "box_xywh_pixels": [
          100,
          100,
          300,
          50
        ]
      }
    ]
  },
  "error": null
}
Download specification, example and acceptance plan
Engineering handoff — our proposed contract and gates
Input requirementsTask media must be reachable and configuration names must match results; preserve original dimensions and rotation.
Expected successReturn reviewed regions with task and region references; keep model suggestions separate from human annotations.
Expected emptyExplicitly reviewed no-defect samples may have regions=[]; skipped or unlabelled tasks are pending, not negative.
Expected failureAuthentication, unreachable media and label-config mismatch return an error category with data=null.
AcceptanceKnown 1000×500 fixture at 10/20/30/10 percent must become 100/100/300/50 pixels; inspect cancelled flags.
LimitationsThe contract is illustrative; edition-specific review endpoints and native payloads must be checked during implementation.
Data and runtimeSeparate annotation server, media bucket and ML backend access; define deletion and snapshot retention.

Related route to assess: CVAT

Development assessment

Label review workflow

Development concept · integration not tested

Provider capabilities above are based on official documentation or repositories. The proposed product, inputs, deliverable and acceptance criteria below are our development assessment.

Small prototype

Test one documented operation with a small real sample after access is confirmed. This is a development judgment, not a delivery estimate.

Proposed inputs
A small authorized image dataset, task definition and reference annotations.
Proposed deliverable
A reviewable result with image references, labels or annotation state; keep original files.
Acceptance criterion
Compare the supported operation against a labeled sample; report errors and missing results separately.
Dependencies
Dataset access, image rights and a supported model or annotation project.

Development sequence

  1. Confirm access to Label Studio API, license and the exact supported version.
  2. Prepare the sample above and implement one documented operation for “Label review workflow”.
  3. Normalize the result with source, time and explicit error state; keep the provider response for review.
  4. Run the acceptance criterion before estimating rollout effort or committing a customer deliverable.

How to validate demand

Record product views, documentation clicks, specification downloads and contextual hub clicks. These are event counts, not unique people or completed integrations.

This feasibility assessment uses implementation conditions. No traffic-based rank or delivery-time promise is assigned.

Related products