API Reference
Explore our robust REST API documentation and official developer SDKs to programmatically manage datasets, submit annotations, and automate model training pipelines.
API Overview
The Loopernode API is built on RESTful principles, returning standard JSON payloads for all requests and using predictable HTTP response codes.
Base URL
All API requests should be directed to the global HTTPS base endpoint: https://api.loopernode.in/v1
JSON Format
Requests and responses use Content-Type: application/json. Timestamp fields follow ISO-8601 UTC standard.
RESTful Design
Utilizes standard HTTP methods (GET, POST, PUT, DELETE) with deterministic status codes and structured errors.
API Key Authentication
Authenticate your requests by passing your API secret key in the Authorization header as a Bearer token.
Bearer Token Authentication
Keep your API key secure. Do not share key credentials in public web repositories.
Include your secret key in the Authorization HTTP header for every API call.
Core API Endpoints
Explore the primary endpoints for managing dataset collections, submitting annotation jobs, and tracking project statuses.
Create Dataset
Initialize a new dataset container with specific modal configurations, metadata schema, and retention rules.
List Datasets
Retrieve a paginated collection of active datasets within your organization with status filtering.
Submit Annotations
Upload bounding boxes, polygon masks, sentiment tags, or custom task labels to a dataset target.
Get Annotation
Fetch detailed geometric vectors, confidence scores, worker metrics, and audit history for an annotation.
Create Project
Spin up an enterprise labeling campaign defining consensus requirements, workforce routing, and QA thresholds.
Project Status
Monitor real-time execution progress, completion velocity, consensus percentage, and active worker counts.
API Rate Limits
Rate limits safeguard API stability and availability across all enterprise teams and developer accounts.
X-RateLimit-Limit | X-RateLimit-Remaining | X-RateLimit-ResetHTTP Error Codes
Our API returns conventional HTTP response status codes to indicate the success or failure of requests.
Bad Request
Malformed JSON payload, missing mandatory fields, or invalid enum parameters sent in request body.
Unauthorized
Missing, expired, or invalid API key provided in the Authorization Bearer header.
Not Found
The requested resource ID (dataset, project, or annotation) does not exist or has been deleted.
Too Many Requests
Rate limit threshold exceeded for your current tier plan. Check X-RateLimit-Reset header for retry delay.
Official SDKs
Get started quickly in your favorite programming language with native type safety and automated error handling.
Python SDK
pip install loopernode-pythonimport loopernode
client = loopernode.Client(api_key="lnr_live_...")
dataset = client.datasets.create(
name="Autonomous Vision v2",
modality="image_segmentation"
)Node.js SDK
npm install @loopernode/sdkimport { Loopernode } from '@loopernode/sdk';
const client = new Loopernode({ apiKey: process.env.LOOPERNODE_API_KEY });
const project = await client.projects.get('prj_884920');
console.log(project.status);Go SDK
go get github.com/loopernode/loopernode-gopackage main
import "github.com/loopernode/loopernode-go"
client := loopernode.NewClient("lnr_live_...")
res, err := client.Annotations.Submit(ctx, payload)Ready to integrate?
Obtain your API credentials today and start building high-performance dataset pipelines with Loopernode.
