Skip to main content

SciTeX API Documentation

Complete API reference for integrating with SciTeX modules

Authentication

All API endpoints require authentication using JWT tokens.

POST /api/v1/auth/login/

Authenticate and receive access tokens

{ "username": "your_username", "password": "your_password" }
POST /api/v1/auth/refresh/

Refresh access token using refresh token

GET /api/v1/auth/profile/

Get current user profile information

Module Overview

Access all SciTeX modules through a unified API

GET /api/v1/modules/

List all available SciTeX modules with their status

GET /api/v1/modules/{module_id}/

Get detailed information about a specific module

SciTeX-Engine API

AI-powered code assistance for Emacs

POST /api/v1/engine/complete/

Get AI-powered code completions

POST /api/v1/engine/analyze/

Analyze code for improvements and issues

GET /api/v1/engine/templates/

Get research code templates

SciTeX-Doc API

LaTeX manuscript management

GET /api/v1/doc/manuscripts/

List user's manuscripts

POST /api/v1/doc/create_manuscript/

Create a new manuscript

GET /api/v1/doc/templates/

Get available LaTeX templates

SciTeX-Code API (MNGS)

Python utilities for research

GET /api/v1/code/modules/

List available MNGS modules

POST /api/v1/code/execute/

Execute MNGS code in sandboxed environment

GET /api/v1/code/examples/

Get code examples

SciTeX-Viz API

SigmaPlot integration for publication-ready figures

POST /api/v1/viz/convert/

Convert Python plot to SigmaPlot format

GET /api/v1/viz/templates/

Get publication-ready plot templates

GET /api/v1/viz/gallery/

Browse example gallery

SciTeX-Search API

Advanced LaTeX and mathematical formula search

POST /api/v1/search/search/

Search through LaTeX documents and formulas

POST /api/v1/search/similar/

Find similar mathematical formulas

GET /api/v1/search/statistics/

Get search index statistics

Rate Limiting

API rate limits vary by subscription tier:

  • Free: 100 requests/hour
  • Premium: 1,000 requests/hour
  • Enterprise: Unlimited