BaxStream Video Conversion API

Authorization: Bearer bax_xxxxxxxxxxxxxxxx
X-Project-Id: clxxxxxxxxxxxxxx

{
  "id": "cm...",
  "projectId": "cl...",
  "status": "PENDING",
  "inputUrl": "https://example.com/my-video.mp4",
  "outputFormats": ["360p", "480p", "720p"],
  "metadata": { "userId": "u_42", "uploadId": "u_42_v17" },
  "createdAt": "2025-04-16T00:00:00.000Z"
}

{
  "id": "cm...",
  "status": "COMPLETED",
  "inputUrl": "https://example.com/video.mp4",
  "outputUrl": "https://cdn.example.com/videos/master.m3u8",
  "thumbnailUrl": "https://cdn.example.com/videos/thumbnail.jpg",
  "outputFormats": ["360p", "480p", "720p"],
  "durationSec": 125,
  "segmentsCount": 63,
  "costCents": 13,
  "metadata": { "userId": "u_42" },
  "createdAt": "2025-04-16T00:00:00.000Z",
  "startedAt": "2025-04-16T00:00:02.000Z",
  "completedAt": "2025-04-16T00:01:30.000Z"
}

"s3Config": {
  "bucket": "my-bucket",
  "region": "us-east-1",
  "accessKey": "AKIA...",
  "secretKey": "...",
  "cdnUrl": "https://cdn.example.com"
}

// Output URL becomes:
// https://cdn.example.com/videos/master.m3u8
// instead of:
// https://my-bucket.s3.us-east-1.amazonaws.com/videos/master.m3u8

{
  "success": true,
  "data": {
    "id": "cm...",
    "status": "COMPLETED",
    "safe": true,
    "violations": [],
    "scores": {
      "nudity_explicit":    0.002,
      "sexual_activity":    0.001,
      "suggestive_nudity":  0.010,
      "lingerie_underwear": 0.008,
      "sexy_suggestive":    0.015,
      "violence":           0.020,
      "gore_graphic":       0.001,
      "hate_symbols":       0.000,
      "drugs_substances":   0.004,
      "weapons":            0.002,
      "child_safety":       0.000,
      "self_harm":          0.000,
      "harassment":         0.003
    },
    "flaggedFrames": [],
    "framesAnalyzed": 8,
    "processingTimeMs": 1250
  }
}

{
  "success": true,
  "data": {
    "id": "cm...",
    "status": "COMPLETED",
    "safe": false,
    "violations": [
      { "category": "nudity_explicit",    "confidence": 0.5210, "severity": "critical" },
      { "category": "suggestive_nudity",  "confidence": 0.3104, "severity": "high" },
      { "category": "lingerie_underwear", "confidence": 0.2850, "severity": "medium" }
    ],
    "scores": {
      "nudity_explicit":    0.4812,
      "sexual_activity":    0.0832,
      "suggestive_nudity":  0.2901,
      "lingerie_underwear": 0.2684,
      "sexy_suggestive":    0.0914,
      "violence":           0.0014,
      "weapons":            0.0008
      // ... all other categories
    },
    "flaggedFrames": [
      {
        "frameIndex": 2,
        "violations": [
          { "category": "nudity_explicit", "confidence": 0.5834, "severity": "critical" }
        ]
      },
      {
        "frameIndex": 5,
        "violations": [
          { "category": "suggestive_nudity", "confidence": 0.3901, "severity": "high" }
        ]
      }
    ],
    "framesAnalyzed": 8,
    "processingTimeMs": 1250
  }
}

{
  "success": true,
  "data": {
    "id": "cm...",
    "status": "COMPLETED",
    "primaryCategory": "Sports",
    "confidence": 0.4523,
    "categories": [
      { "name": "Sports",            "confidence": 0.4523, "primary": true  },
      { "name": "Film & TV",         "confidence": 0.0812, "primary": false },
      { "name": "Travel & Nature",   "confidence": 0.0340, "primary": false },
      { "name": "Lifestyle & Vlog",  "confidence": 0.0185, "primary": false }
    ],
    "tags": ["football", "stadium", "athletes running", "crowd cheering"],
    "scores": {
      "Sports":           0.4523,
      "Film & TV":        0.0812,
      "Travel & Nature":  0.0340,
      "Lifestyle & Vlog": 0.0185,
      "Comedy & Memes":   0.0091
      // ... full long-tail of all 23 categories
    },
    "framesAnalyzed": 8,
    "processingTimeMs": 980
  }
}

{
  "event":     "video.conversion.completed",   // one of the 9 event types
  "eventId":   "cm9a8w1...",                   // unique id, use it to dedupe
  "timestamp": "2026-04-17T10:00:00.000Z",     // ISO-8601 server time of delivery
  "projectId": "cl_proj_abc123",               // your project id
  "metadata":  { "userId": "u_42" },           // user metadata you passed at create-time (or null)
  "data":      { /* event-specific job payload, see examples below */ }
}

{
  "event": "video.conversion.completed",
  "eventId": "cm9a8w1xyz...",
  "timestamp": "2026-04-17T10:00:00.000Z",
  "projectId": "cl_proj_abc123",
  "metadata": { "userId": "u_42", "uploadId": "u_42_v17" },
  "data": {
    "jobId": "cm_job_xyz789",
    "projectId": "cl_proj_abc123",
    "status": "COMPLETED",
    "inputUrl": "https://source.example.com/video.mp4",
    "outputUrl": "https://cdn.example.com/videos/master.m3u8",
    "thumbnailUrl": "https://cdn.example.com/videos/thumbnail.jpg",
    "outputFormats": ["360p", "480p", "720p"],
    "renditionUrls": {
      "360p": "https://cdn.example.com/videos/360p/playlist.m3u8",
      "480p": "https://cdn.example.com/videos/480p/playlist.m3u8",
      "720p": "https://cdn.example.com/videos/720p/playlist.m3u8"
    },
    "durationSec": 125,
    "segmentsCount": 63,
    "costCents": 13,
    "metadata": { "userId": "u_42", "uploadId": "u_42_v17" },
    "createdAt": "2026-04-17T09:58:12.000Z",
    "startedAt": "2026-04-17T09:58:14.000Z",
    "completedAt": "2026-04-17T10:00:00.000Z",

    // Included when categorize=true (1 primary + up to 5 others ≥ 1%)
    "categorization": {
      "primaryCategory": "Sports",
      "confidence": 0.4523,
      "categories": [
        { "name": "Sports",         "confidence": 0.4523, "primary": true  },
        { "name": "Film & TV",      "confidence": 0.0812, "primary": false },
        { "name": "Travel & Nature","confidence": 0.0340, "primary": false }
      ],
      "tags": ["football", "stadium", "athletes running"],
      "scores": { "Sports": 0.4523, "Film & TV": 0.0812, /* ... full long-tail */ },
      "framesAnalyzed": 8,
      "processingTimeMs": 750
    },

    // Included when moderate=true (granular sexual-content + other categories)
    "moderation": {
      "safe": true,
      "violations": [],
      "scores": {
        "nudity_explicit":    0.002, "sexual_activity":    0.001,
        "suggestive_nudity":  0.010, "lingerie_underwear": 0.008,
        "sexy_suggestive":    0.015, "violence":           0.020,
        "gore_graphic":       0.001, "weapons":            0.002
        // ... all 13 moderation categories
      },
      "flaggedFrames": [],
      "framesAnalyzed": 8,
      "processingTimeMs": 980
    }
  }
}

{
  "event": "moderation.completed",
  "eventId": "cm9a8w2abc...",
  "timestamp": "2026-04-17T10:01:42.000Z",
  "projectId": "cl_proj_abc123",
  "metadata": { "userId": "u_42" },
  "data": {
    "jobId": "cm_mod_def456",
    "projectId": "cl_proj_abc123",
    "status": "COMPLETED",
    "inputUrl": "https://source.example.com/risky.mp4",
    "safe": false,
    "violations": [
      { "category": "nudity_explicit",    "confidence": 0.5210, "severity": "critical" },
      { "category": "suggestive_nudity",  "confidence": 0.3104, "severity": "high" },
      { "category": "lingerie_underwear", "confidence": 0.2850, "severity": "medium" }
    ],
    "scores": { /* full per-category map */ },
    "flaggedFrames": [
      { "frameIndex": 2, "violations": [
        { "category": "nudity_explicit", "confidence": 0.5834, "severity": "critical" }
      ]},
      { "frameIndex": 5, "violations": [
        { "category": "suggestive_nudity", "confidence": 0.3901, "severity": "high" }
      ]}
    ],
    "framesAnalyzed": 8,
    "processingTimeMs": 1180,
    "metadata": { "userId": "u_42" },
    "completedAt": "2026-04-17T10:01:42.000Z"
  }
}

{
  "event": "video.conversion.failed",
  "eventId": "cm9a8w3err...",
  "timestamp": "2026-04-17T10:00:31.000Z",
  "projectId": "cl_proj_abc123",
  "metadata": { "userId": "u_42" },
  "data": {
    "jobId": "cm_job_xyz789",
    "projectId": "cl_proj_abc123",
    "status": "FAILED",
    "inputUrl": "https://source.example.com/broken.mp4",
    "errorCode": "DOWNLOAD_FAILED",
    "errorMessage": "HTTP 403 fetching input URL after 3 retries",
    "metadata": { "userId": "u_42" },
    "createdAt": "2026-04-17T09:58:12.000Z",
    "failedAt":  "2026-04-17T10:00:31.000Z"
  }
}

npm install @baxcloud/server-sdk

import { BaxCloudClient } from '@baxcloud/server-sdk';

// API key + Project ID are required — base URL defaults to https://api.baxcloud.tech
const client = new BaxCloudClient({
  apiKey:    process.env.BAXCLOUD_API_KEY!,    // Dashboard → API Keys
  projectId: process.env.BAXCLOUD_PROJECT_ID!, // Dashboard → Projects → [Project]
});

const job = await client.createVideoConversionJob({
  inputUrl: 'https://example.com/video.mp4',
  outputFormats: ['360p', '720p'],
  ffmpegPreset: 'fast',       // optional
  hlsTime: 2,                 // optional, seconds per segment
  categorize: true,           // run AI categorization inline
  moderate:  true,            // run AI moderation inline
  metadata: { userId: 'u_42' },
  s3Config: {                  // optional if project defaults are set
    bucket: 'my-bucket',
    region: 'us-east-1',
    accessKey: 'AKIA...',
    secretKey: '...',
    cdnUrl: 'https://cdn.example.com',
  },
});

console.log(job.id, job.status); // "cm..." "PENDING"

import fs from 'node:fs';

const job = await client.uploadVideoForConversion(
  fs.createReadStream('./my-video.mp4'),
  'my-video.mp4',
  { outputFormats: ['360p', '720p'], ffmpegPreset: 'fast' },
);

console.log(job.id, job.status);

let result = await client.getVideoConversionJob(job.id);

while (result.status === 'PENDING' || result.status === 'PROCESSING') {
  await new Promise((r) => setTimeout(r, 5000)); // 5s poll
  result = await client.getVideoConversionJob(job.id);
}

if (result.status === 'COMPLETED') {
  console.log('Master playlist:', result.outputUrl);
  console.log('Thumbnail:',       result.thumbnailUrl);
  // result.categorization + result.moderation are present when those features were enabled.
} else {
  console.error('Failed:', result.errorMessage);
}

// List jobs (filter + paginate)
const { items, total } = await client.listVideoConversionJobs({
  status: 'PROCESSING',
  page: 1,
  pageSize: 20,
});

// Cancel a pending job
await client.cancelVideoConversionJob('cm...');

// Standalone — no HLS conversion, no S3 required
const cat = await client.createCategorizationJob({
  inputUrl: 'https://example.com/clip.mp4',
  inputType: 'video',   // or 'image'
  topK: 6,              // 1 primary + up to 5 others ≥ 1%
  maxFrames: 8,
});

console.log('Primary:', cat.primaryCategory, '(' + (cat.confidence * 100).toFixed(1) + '%)');
for (const c of cat.categories) {
  const marker = c.primary ? '★' : ' ';
  console.log(`${marker} ${c.name.padEnd(20)} ${(c.confidence * 100).toFixed(1)}%`);
}
// cat.scores is the FULL 20-category probability map for analytics/filtering.
// cat.tags is a short-tag gloss derived from the top frames.

// Standalone moderation
const mod = await client.createModerationJob({
  inputUrl: 'https://example.com/clip.mp4',
  inputType: 'video',
  threshold: 0.25,     // default
});

if (!mod.safe) {
  // Each violation has { category, confidence, severity: 'low'|'medium'|'high'|'critical' }
  for (const v of mod.violations) {
    console.log(v.category, (v.confidence * 100).toFixed(1) + '%', `(${v.severity})`);
  }
  // mod.flaggedFrames pinpoints which frames triggered which categories.
}

// Inline with conversion — fires both 'video.conversion.completed' AND 'moderation.completed'
const job = await client.createVideoConversionJob({
  inputUrl: 'https://example.com/video.mp4',
  outputFormats: ['360p', '720p'],
  moderate: true,
});

// List & retrieve stored moderation jobs
const list = await client.listModerationJobs({ status: 'COMPLETED' });
const one  = await client.getModerationJob('cm...');

import express from 'express';
import { webhookMiddleware } from '@baxcloud/server-sdk';

const app = express();

app.post(
  '/webhooks/baxstream',
  express.raw({ type: 'application/json' }),
  webhookMiddleware(process.env.BAXCLOUD_WEBHOOK_SECRET!),
  async (req, res) => {
    const ev = req.baxcloudEvent; // { event, eventId, timestamp, projectId, metadata, data }

    // eventId is globally unique — use it to dedupe at-least-once deliveries.
    if (await alreadyProcessed(ev.eventId)) return res.status(200).end();

    switch (ev.event) {
      case 'video.conversion.completed':
        await onVideoReady({
          jobId:        ev.data.jobId,
          outputUrl:    ev.data.outputUrl,
          thumbnailUrl: ev.data.thumbnailUrl,
          userId:       ev.metadata?.userId,
          categorization: ev.data.categorization, // undefined unless categorize=true
          moderation:     ev.data.moderation,     // undefined unless moderate=true
        });
        break;

      case 'moderation.completed':
        if (!ev.data.safe) await flagForReview(ev.data);
        break;

      case 'video.conversion.failed':
        await onVideoFailed(ev.data.jobId, ev.data.errorMessage);
        break;
    }

    // ACK within 10s; push heavy work to a queue if needed.
    res.status(200).json({ ok: true });
  },
);

app.listen(3000);

{prefix}/
├── master.m3u8            # Master playlist (adaptive bitrate switching)
├── thumbnail.jpg          # Auto-generated thumbnail
├── 360p/
│   ├── playlist.m3u8      # 360p variant playlist
│   ├── segment_000.ts     # HLS segments
│   ├── segment_001.ts
│   └── ...
├── 480p/
│   ├── playlist.m3u8
│   └── ...
└── 720p/
    ├── playlist.m3u8
    └── ...