JavaScript SDK

The JavaScript SDK is the official client for the Nomad Media platform. It wraps the Portal and Admin APIs with idiomatic JavaScript methods for assets, folders, search, live channels, collections, and more.

Get started

1. Install the SDK and add it to your project.
2. Authenticate with a real username and password.
3. Browse the API by area below, then follow a recipe for an end-to-end task.

Quick start

import NomadMediaSDK from "<path-to-sdk>/src/sdk.js";

const config = {
    serviceApiUrl: "https://nomad-admin-api.yourdomain.com/api",
    apiType: "admin",            // "admin" | "portal"
    username: "<from-config>",   // never hard-code
    password: "<from-config>",   // never hard-code
    debugMode: false,
};

const sdk = new NomadMediaSDK(config);
const asset = await sdk.getAsset("<asset-id>"); // login happens here on first call

Browse the API by area

• Search & read: search, get, get_details, get_content, list_children, get_parent_folders, get_metadata_summary, get_manifest, get_screenshot_details, get_segment_details
• Upload & create: upload, upload_related, create_content, create_folder, create_placeholder, register
• Organize & edit metadata: move, copy, duplicate, update_asset, update_content, update_asset_language, add_custom_properties, bulk_update_metadata
• Security & lifecycle: update_asset_security, delete, delete_content, archive, restore, reprocess, index_asset
• Media operations: clip, screenshot, build_media, transcribe_asset, start_workflow
• Annotations: create_annotation, update_annotation, delete_annotation, get_annotations, import_annotations
• Ad breaks: create_ad_break, update_ad_break, delete_ad_break, get_ad_breaks
• Live channels: get_live_channels, get_live_channel, start_live_channel, stop_live_channel, live_channel_refresh, get_live_inputs, get_live_input, get_live_output_profiles, get_live_operators, get_live_operator
• Content definitions: get_content_definition, get_content_definitions
• Events & scheduling: create_and_update_event, add_live_schedule_to_event, get_live_schedule, delete_event
• Collections & content groups: create_content_group, get_content_group, get_content_groups, add_contents_to_content_group, remove_contents_from_content_group, rename_content_group, delete_content_group, share_content_group_with_users, stop_sharing_content_group_with_users, get_portal_groups
• Saved searches: create_saved_search, get_saved_search, list_saved_searches, update_saved_search, delete_saved_search
• Sharing: create_share, get_share, update_share, delete_share, expire_share
• Video tracking: record_tracking_beacon, get_video_tracking

Recipes

Task-oriented walkthroughs that combine several operations:

• Bucket statistics summary
• Bulk-import events from a spreadsheet (idempotent upsert + live schedule)
• Bulk-import performers from a spreadsheet (idempotent upsert)
• Check a folder, then create a sub-folder and upload missing files
• Collections (content groups) - create, fill with confined assets, share, clean up
• Read & update records through the content routes
• External (placeholder-first) upload
• Folder navigation (resolve a path, list folders/files, create+verify)
• Live channels (resolve by name, read status, start/stop safely)
• Real-world search patterns

Reference

• Portal vs Admin API types
• Python ↔ JavaScript naming map
• Return shapes
• Enums and lookups
• Schema reference