API Reference

Welcome to the MediaMoth API Reference documentation.

Core APIs

Pipeline API

The Pipeline API allows you to create and manage media processing pipelines.

INFO

Detailed API documentation coming soon.

Job API

The Job API provides methods for managing individual jobs within pipelines.

Monitor API

The Monitor API enables real-time tracking of pipeline and job execution.

Event Schema

MediaMoth uses Protocol Buffers for event definitions. Key events include:

• PipelineNameReserved: Emitted when a pipeline name is reserved
• PipelineCreated: Emitted when a new pipeline is created
• JobStarted: Emitted when a job begins execution
• JobCompleted: Emitted when a job finishes

CQRS Architecture

MediaMoth follows the CQRS (Command Query Responsibility Segregation) pattern with event sourcing:

• Commands: Modify state (e.g., CreatePipeline, ReservePipelineName)
• Events: Record what happened (e.g., PipelineCreated, NameReserved)
• Queries: Read projections of the current state

Examples

More detailed examples and code samples will be added to this section.