Skip to content

ModelDescriptor

HTTP API schema

← HTTP API reference

One model offered for one capability interface, with the configuration it supports and how to prompt it. Exactly the section that matches the capability interface is present (`speech`, `speechToSpeech`, `image` or `music`).

ModelDescriptor fields

capabilityInterfacestringRequired

Canonical name of the capability interface the model serves, for example port1/systems/zero/capability-interfaces/speech-audio-generation.

modelstringRequired

The model identifier to pass as `model` in the interface generation message.

displayNamestringRequired

Human readable model name.

promptingInstructionsstringRequired

Free text on how to prompt the model, for example whether lyrics go in the prompt or in a separate field and which emotion or sound tags the model understands.

maxPromptCharactersinteger

Longest accepted text or prompt in characters, when the vendor documents one.

minimum: 1

provenanceModelProvenanceRequired

provenance: Reference ModelProvenance

View source specification ↗