Package Exports

@agentmedia/schema

Readme

@agentmedia/schema

Single source of truth for the agent-media platform — enums, Zod validation schemas, TypeScript types, and the generator registry.

Why This Package Exists

Every option in the agent-media API — tones, music genres, subtitle styles, durations, templates, scene types — is defined exactly once in this package. All consumers (REST API, CLI, dashboard, MCP server, SDKs, docs) import from here. Adding a new subtitle style or template is a one-line change that propagates everywhere on the next build.

Install

npm install @agentmedia/schema

What's Inside

Enums (as `const` arrays + TypeScript types)

import {
  TONES,          // ['energetic', 'calm', 'confident', 'dramatic']
  MUSIC_GENRES,   // ['chill', 'energetic', 'corporate', 'dramatic', 'upbeat']
  SUBTITLE_STYLES,// 17 styles: 'hormozi', 'minimal', 'bold', 'neon', 'fire', ...
  DURATIONS,      // [5, 10, 15]
  ASPECT_RATIOS,  // ['9:16', '16:9', '1:1']
  SCENE_TYPES,    // ['talking_head', 'broll']
  TEMPLATES,      // 8 templates
  VOICES,         // ['alloy', 'echo', 'fable', 'onyx', 'nova', 'shimmer']
  REVIEW_ANGLES,  // ['honest', 'enthusiastic', 'roast', 'tutorial', 'comparison']
  // + PIP_POSITIONS, PIP_SIZES, PIP_ANIMATIONS, PIP_FRAME_STYLES, COMPOSITION_MODES
} from '@agentmedia/schema';

// TypeScript literal types are derived automatically:
import type { Tone, SubtitleStyle, Template } from '@agentmedia/schema';

Zod Validation Schemas

import { CreateVideoSchema, SubtitleSchema, ProductReviewSchema, ProductActingSchema } from '@agentmedia/schema';

// Validate API input
const result = CreateVideoSchema.safeParse(requestBody);
if (!result.success) {
  console.error(result.error.issues); // structured errors with field paths
}

Generator Registry

import { GENERATORS, GENERATOR_IDS } from '@agentmedia/schema';

// Each generator is a black box: inputs -> [generator] -> output
console.log(GENERATOR_IDS); // ['ugc_video', 'saas_review', 'subtitle', 'show_your_app', 'product_acting_ugc']

// Access a generator's Zod input schema
const schema = GENERATORS.ugc_video.inputSchema;

Use Cases

This package is useful if you're building:

A custom integration with the agent-media API (validate inputs before sending)
An SDK in another language (read the enums, generate code)
A UI that needs dropdown options from the schema
A testing harness (import valid values for test fixtures)

Build-Time Generation

The schema powers auto-generated artifacts:

generated/openapi.json — full OpenAPI 3.1 spec (via npm run generate:openapi)
supabase/functions/_shared/schema.generated.ts — Deno-compatible copy for edge functions (via npm run generate:edge-schema)

Package	Description
`@agentmedia/sdk`	TypeScript SDK — uses this schema for types
`@agentmedia/mcp-server`	MCP server for Claude Code, Cursor, Windsurf
`agent-media-cli`	CLI tool — generate videos from your terminal
`agent-media`	Python SDK

License

Apache-2.0

JSPM