---
title: "ai.video_analysis.updated@1 · OpenVibe.Services"
canonical: "https://openvibe.services/docs/contracts/ai.video_analysis.updated"
updated: null
---

# ai.video\_analysis.updated@1 · OpenVibe.Services

HTML: [ai.video\_analysis.updated@1 · OpenVibe.Services](https://openvibe.services/docs/contracts/ai.video_analysis.updated)

# AiVideoAnalysisUpdatedPayload `ai.video_analysis.updated@1`

Generated at 2026-11-17 06:52:56 UTC from [`openvibe-contracts v0.443.0`](https://github.com/OpenVibers/OpenVibe.Contracts/tree/v0.443.0) and [`openvibe-sdk v0.177.0`](https://github.com/OpenVibers/OpenVibe.SDK/tree/v0.177.0).

- Version: 1.0.0
- Owner: ai
- Visibility: first-party
- Status: active
- Compatibility: backward
- Schema: [`https://openvibe.network/contracts/events/payloads/ai.video_analysis.updated.v1.json`](/docs/contracts/ai.video_analysis.updated.json)

ai.video\_analysis.updated v1 (OpenVibe.AI server/video-analysis/): a video analysis' step changed or it ended. One event per step transition and one at the end, so a page (OpenVibe.Video's, or OpenVibe.Exchange's) can follow a run without polling. The payload carries the run and analysis ids, the step, the progress and the status; never the transcript, a frame or a prompt. Envelope: subject { type: run, id: <run\_id> }, visibility internal, priority low (important on failed), actor service:ai.

## Fields

| Field | Type | Required | Description | Constraints |
| --- | --- | --- | --- | --- |
| `video_analysis_id` | string | yes |  | - `pattern ^run_[0-9A-HJKMNP-TV-Z]{26}$` |
| `run_id` | string | yes |  | - `pattern ^run_[0-9A-HJKMNP-TV-Z]{26}$` |
| `status` | enum | yes |  | - `one of "queued", "running", "succeeded", "failed", "cancelled"` |
| `step` | enum | yes |  | - `one of "probe", "keyframes", "transcript", "describe", "analyse", "explicit", "report", "done", null` |
| `progress` | number | yes |  | - `minimum 0`<br>- `maximum 1` |
| `steps` | array of object | yes |  | - `items: no other fields` |
| `steps[].key` | enum | yes |  | - `one of "probe", "keyframes", "transcript", "describe", "analyse", "explicit", "report"` |
| `steps[].status` | enum | yes |  | - `one of "pending", "running", "done", "skipped", "failed"` |
| `depth` | enum | yes |  | - `one of "quick", "standard", "deep"` |
| `requester` | [identity.subject-ref](/docs/contracts/identity.subject-ref) | yes |  |  |
| `on_behalf_of` | one of | yes |  |  |
| `url` | string | yes |  | - `pattern ^https://`<br>- `format uri` |
| `error` | one of | yes |  |  |
| `occurred_at` | string | yes |  | - `format date-time` |

## Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

 Valid: reading

~~~~
{
  "video_analysis_id": "run_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "run_id": "run_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "status": "running",
  "step": "describe",
  "progress": 0.58,
  "steps": [
    {
      "key": "probe",
      "status": "done"
    },
    {
      "key": "keyframes",
      "status": "done"
    },
    {
      "key": "transcript",
      "status": "done"
    },
    {
      "key": "describe",
      "status": "running"
    },
    {
      "key": "analyse",
      "status": "pending"
    },
    {
      "key": "explicit",
      "status": "pending"
    },
    {
      "key": "report",
      "status": "pending"
    }
  ],
  "depth": "standard",
  "requester": {
    "type": "service",
    "id": "exchange"
  },
  "on_behalf_of": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "url": "https://openvibe.exchange/video-analysis/run_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "error": null,
  "occurred_at": "2026-11-13T21:00:00.000Z"
}
~~~~

Rejected: progress-over-one

~~~~
{
  "video_analysis_id": "run_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "run_id": "run_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "status": "running",
  "step": "describe",
  "progress": 1.5,
  "steps": [],
  "depth": "standard",
  "requester": {
    "type": "service",
    "id": "exchange"
  },
  "on_behalf_of": null,
  "url": "https://openvibe.exchange/video-analysis/run_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "error": null,
  "occurred_at": "2026-11-13T21:00:00.000Z"
}
~~~~

## Validate

~~~~
const contracts = require('openvibe-contracts');
contracts.validate('ai.video_analysis.updated@1', value);   // { valid, errors: [{ path, message }] }
~~~~
