ActorModelManageRequest actor.model-manage-request@1

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

Version
1.0.0
Owner
actor
Visibility
public
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/actor/model-manage-request.v1.json

actor.model-manage-request@1: the body of PUT /api/v1/me/model on OpenVibe.Actor: { choice, model? }. choice is 'auto' (Actor decides, as before), 'openvibe' (OpenVibe's own keys, through OpenVibe.AI) or 'own:<provider>' (your own key for that provider: openai, anthropic, deepseek, google, openrouter or mistral). model is the model id you picked for it, or nothing: OpenVibe.AI then routes the call. The key itself never reaches Actor: it stays sealed in OpenVibe.AI. An unknown provider or a model id that is not one is 422 actor.model.invalid.

Fields

FieldTypeRequiredDescriptionConstraints
choiceenumWhich model your tasks run on.
  • one of "auto", "openvibe", "own:openai", "own:anthropic", "own:deepseek", "own:google", "own:openrouter", "own:mistral"
  • default "auto"
modelstring | nullThe model id you picked, or nothing: OpenVibe.AI routes the call.
  • pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,119}$
  • maxLength 120

Examples

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

Valid: auto
{
  "choice": "auto"
}
Valid: openvibe
{
  "choice": "openvibe"
}
Valid: own
{
  "choice": "own:openai",
  "model": "gpt-5.1"
}
Rejected: unknown-provider
{
  "choice": "own:not-a-provider"
}
Rejected: with-a-key
{
  "choice": "own:openai",
  "api_key": "sk-never-here"
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('actor.model-manage-request@1', value);   // { valid, errors: [{ path, message }] }