API Documentation

Integrate Lumetrix into your applications with our RESTful API

Overview

The Lumetrix API provides programmatic access to all platform features, allowing you to integrate code deployment, documentation generation, and plagiarism detection into your own applications and workflows.

Built on RESTful principles with JSON request and response formats, our API is designed to be simple, predictable, and easy to use. All endpoints use standard HTTP methods and return meaningful status codes.

Authentication is handled through API keys that can be generated from your account dashboard. Rate limits apply based on your subscription tier to ensure fair usage and system stability.

API Capabilities

Code Deployment

Push code to JupyterLab servers, retrieve execution results, and manage deployments programmatically through our deployment API endpoints.

Documentation Generation

Generate PDFs with flowcharts and algorithms automatically. Retrieve formatted documentation for any code submission via API calls.

Plagiarism Detection

Compare code submissions, detect similarity patterns, and access detailed plagiarism analysis reports through dedicated API endpoints.

Classroom Management

Create classrooms, manage assignments, and retrieve student submissions programmatically for custom learning management integrations.

Authentication

All API requests must be authenticated using an API key passed in the Authorization header. Generate your API key from the account settings dashboard after logging in.

Keep your API keys secure and never share them publicly. If you suspect your key has been compromised, you can regenerate it at any time from your dashboard.

Rate Limits

API rate limits vary by subscription tier. Free tier users can make up to 100 requests per hour, while premium and enterprise users enjoy higher limits based on their plan.

Start Building with Lumetrix API

Create powerful integrations and automate your workflow with our comprehensive API