Skip to main content

VideoCompanionConfig

One pinned companion artifact used alongside the base video weights.

kindVideoCompanionKind (string)required

What the companion is; selects how an engine applies it.

Possible values: [lora, model_patch, embedding, graph_template, preprocessor]

nameName (string)required

Stable companion identifier callers and engines refer to.

pathPath (string)required

Canonical repository-relative POSIX path of the companion file.

repo object

Repository hosting the companion; None means the card's artifact repository, whose source_revision then also pins this file.

anyOf
string
revision object

Immutable commit of repo; required whenever repo is external.

anyOf
string

Possible values: Value must match regular expression ^[0-9a-f]{40}$

sizeBytes object

Exact upstream byte size at the pinned revision when known.

anyOf
integer
modesVideoMode (string)[]

Generation modes the companion applies to; empty means every mode.

Possible values: [t2va, fl2va, ref2va]

Default value: []
steps object

For distillation adapters, the sampling step count they were trained for.

anyOf
integer

Possible values: > 0

strength object

Default application strength when the engine supports one.

anyOf
number
videoShift object

Video sigma shift the companion expects, when it differs from the card.

anyOf
number
audioShift object

Audio sigma shift the companion expects, when it differs from the card.

anyOf
number
role object

For preprocessor companions, what the weights do; required for them and refused on every other kind.

anyOf
VideoPreprocessorRole (string)

What a preprocessor companion's weights do in deriving a guide video.

Possible values: [pose_estimator, person_detector, depth_estimator]

license object

The license its hosting repository declares, as a lowercase SPDX-style identifier (mit, apache-2.0), shown to the operator beside the card's own license; companions in the card's repository fall under that.

anyOf
string
VideoCompanionConfig
{
  "kind": "lora",
  "name": "string",
  "path": "string",
  "repo": "string",
  "revision": "string",
  "sizeBytes": 0,
  "modes": [
    "t2va"
  ],
  "steps": 0,
  "strength": 0,
  "videoShift": 0,
  "audioShift": 0,
  "role": "pose_estimator",
  "license": "string"
}