API Reference
This section provides detailed API reference documentation for DiracX modules, automatically generated from the source code using Griffe and Griffe-Pydantic.
Core
Core components including models, settings, configuration, and utilities.
- Models - Core Pydantic models for data validation
- Settings - Configuration settings
- Preferences - User preferences
- Configuration - Configuration schema and sources
- Exceptions - Core exception classes
- Resources - Resource management and dependency injection
- S3 - S3-compatible object storage integration
- Properties - Security properties
- Extensions - Extension system
- Utilities - Core utilities
Routers
FastAPI routers providing the REST API endpoints.
- Jobs - Job management endpoints
- Auth - Authentication and authorization
- Configuration - Configuration management
- Health - Health check and monitoring
- Access Policies - Access control policies
- Dependencies - FastAPI dependency injection utilities
- Factory - Router factory functions
- FastAPI Classes - Custom FastAPI router classes
- OpenTelemetry - Tracing and instrumentation
- Utilities - Router utilities
Logic
Business logic layer providing service implementations and orchestration.
Database
Database models, schemas, and access layers.
- Job DB - Job database
- Job Logging DB - Job logging and history
- Auth DB - Authentication and authorization
- Sandbox Metadata DB - Sandbox file metadata
- Task Queue DB - Task queue management
- Pilot Agents DB - Pilot agent tracking
- Dummy DB - Dummy database for testing
- OpenSearch - OpenSearch-based databases
- SQL Utilities - SQL database utilities
- Exceptions - Database exceptions
CLI
Command-line interface modules and commands.
How to Use
Each module page contains automatically generated documentation including:
- Pydantic Models: Field descriptions, types, defaults, constraints, and validation rules
- Functions & Methods: Parameters, return types, and docstrings
- Type Annotations: Full type information for all public APIs
- Source Links: Direct links to source code on GitHub
Contributing Documentation
See Writing API Docs for guidelines on documenting your code.