Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mocra.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The Mocra JavaScript SDK wraps the Mocra REST API and handles authentication, serialization, and error handling for you. TypeScript typings are included. Package: @mocra/observe — requires Node.js 18+

​
Installation

npm install @mocra/observe

​
Quick start

import { VideoObservabilityApi } from "@mocra/observe";

const api = new VideoObservabilityApi("YOUR_API_KEY");
const result = await api.scoreVideo(
  "https://example.org/video.mp4",
  [
    {
      criterionName: "Blur",
      criterionDescription: "The video should not be blurry",
    },
  ],
  ["UNNATURAL PHYSICS"],
);

console.log("Overall score:", result.severity);
for (const criterion of result.criteria) {
  console.log(`  ${criterion.name}: ${criterion.score}`);
}

​
VideoObservabilityApi

The main client class. Instantiate it once with your API key and reuse it across requests. 
import { VideoObservabilityApi } from "@mocra/observe";

const api = new VideoObservabilityApi("YOUR_API_KEY");

​
Constructor parameters

ParameterTypeDefaultDescription
apiKeystringrequiredYour Mocra API key. See the Quickstart to get one.

​
scoreVideo()

Analyzes a video against Mocra’s built-in criteria and any custom criteria you provide. 
const result = await api.scoreVideo(
  videoUrl,
  extraCriteria,   // optional
  ignoreCriteria,  // optional
);

​
Parameters

ParameterTypeDefaultDescription
videoUrlstringrequiredPublicly accessible URL of the video to analyze.
extraCriteriaExtraCriterion[][]Additional custom criteria to evaluate.
ignoreCriteriastring[][]Built-in criteria to exclude from the analysis. See default criteria for accepted values.

​
Returns: Promise<ScoreMap>

FieldTypeDescription
severitynumberOverall quality score from 1 (worst) to 100 (best).
criteriaCriterionScore[]Per-criterion breakdown. Each item has name: string and score: number (1–100).

​
ExtraCriterion

Defines a custom quality criterion to include in the analysis. 
const criterion: ExtraCriterion = {
  criterionName: "Blur",
  criterionDescription: "The video should not be blurry",
};
FieldTypeDescription
criterionNamestringShort label for the criterion.
criterionDescriptionstringFull description of what the criterion checks.

​
Default criteria

The following built-in criteria are evaluated by default. Pass one or more of these strings to ignoreCriteria to exclude them from the analysis.
Value
"UNNATURAL PHYSICS"
"MORPHING"
"FLICKERING"
"ARTIFACTING"
"TEXT ISSUES"
const result = await api.scoreVideo(
  "https://example.org/video.mp4",
  [],
  ["UNNATURAL PHYSICS", "FLICKERING"],
);

​
Error handling

scoreVideo rejects with an error if the API returns a non-200 response or if a network failure occurs. 
import { VideoObservabilityApi } from "@mocra/observe";

const api = new VideoObservabilityApi("YOUR_API_KEY");

try {
  const result = await api.scoreVideo("https://example.org/video.mp4");
  console.log(result.severity);
} catch (error) {
  console.error("Request failed:", error);
}