API Overview

The Media Registry provides a comprehensive API for programmatic access to media, content, creators, and related data. Built on the Helix Platform and Cubi Cube framework, this API enables seamless integration with other Voyager Suite components, third-party platforms, and automated workflows.

Authentication

API endpoints leverage the Cubi Cube's enterprise-grade authentication system with API keys and OAuth support. Access control is enforced based on user roles and permissions, ensuring secure integration across the Voyager Suite ecosystem.

API Endpoints

• GET /api/media – List all media entities
  Returns: Array of media entity records
• GET /api/media/:id – Retrieve a specific media entity by ID or DID
  Returns: Media entity record
• GET /api/content – List all content entities
  Returns: Array of content entity records
• GET /api/content/:id – Retrieve a specific content entity
  Returns: Content entity record
• GET /api/creators – List all creators
  Returns: Array of creator records
• GET /api/creators/:id – Retrieve a specific creator
  Returns: Creator record
• GET /api/splitsheets/:contentId – Get split sheet for a content entity
  Returns: Array of split sheet records
• POST /api/media – (Planned) Add a new media entity
• POST /api/content – (Planned) Add a new content entity
• POST /api/creators – (Planned) Add a new creator
• POST /api/splitsheets – (Planned) Add or update split sheet information

Example: Retrieve Media Entity

GET /api/media/did:webvh:did.ocmeregistry.com:media:unique-id

Response:
{
  "did": "did:webvh:did.ocmeregistry.com:media:unique-id",
  "file_hash": "...",
  "format": "mp4",
  "resolution": "1080p",
  "codec": "H.264",
  "storage_path": "...",
  "created_at": "...",
  "updated_at": "..."
}
  

Implementation Status

The API is currently in active development as part of the Voyager Suite ecosystem. This documentation reflects the intended API design and will be updated as features are released. Future enhancements will include deeper integration with Home Base, Moon Base, and other Voyager Suite components.