OpenreStreamWriteResult openre.stream-write-result@1

Generated at from openvibe-contracts v0.53.0 and openvibe-sdk v0.11.0.

Version
1.0.0
Owner
openre
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/openre/stream-write-result.v1.json

openre.stream-write-result@1: answers of openre.stream.write on OpenRe.Stream. POST /api/v1/streams → 201 { stream, key } where key is the first ingest key, shown once (Cache-Control no-store); PATCH /api/v1/streams/:id → { stream }; DELETE /api/v1/streams/:id → 204 with no body.

Fields

FieldTypeRequiredDescriptionConstraints
streamopenre.streamyes
keyobject
key.idstringyes
key.keystringyesThe plain ingest key: only in this answer.
key.hintstringyes
key.shown_onceconstyes
  • = true

Examples

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

Valid: created
{
  "stream": {
    "id": "def_01JAB2C3D4E5F6G7H8J9K0MNPQ",
    "title": "Main cam",
    "description": "",
    "owner": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "protocols": [
      "rtmp"
    ],
    "recording_mode": "vod",
    "recording_visibility": "public",
    "playback_visibility": "public",
    "mirror_to_live": 1,
    "state": "active",
    "revision": 3,
    "external_refs": [
      {
        "service": "live",
        "type": "managed_stream",
        "id": "12",
        "label": null
      }
    ],
    "ingest": {
      "rtmp": {
        "url": "rtmp://ingest.openre.stream/live",
        "key_hint": "x9Q2",
        "key_id": "key_01JAB2C3D4E5F6G7H8J9K0MNPR"
      }
    },
    "keys": [
      {
        "id": "key_01JAB2C3D4E5F6G7H8J9K0MNPR",
        "hint": "x9Q2",
        "status": "active",
        "grace_until": null,
        "created_at": "2026-09-20T10:00:00.000Z",
        "last_used_at": "2026-09-25T21:00:00.000Z"
      }
    ],
    "session": null,
    "created_at": "2026-09-20T10:00:00.000Z",
    "updated_at": "2026-09-25T18:00:00.000Z"
  },
  "key": {
    "id": "key_01JAB2C3D4E5F6G7H8J9K0MNPR",
    "key": "ovk_live_7fQ2x9Q2",
    "hint": "x9Q2",
    "shown_once": true
  }
}
Rejected: no-stream
{
  "key": {
    "id": "key_1",
    "key": "x",
    "hint": "x",
    "shown_once": true
  }
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('openre.stream-write-result@1', value);   // { valid, errors: [{ path, message }] }