Skip to content
docs

AiModelOverrideRequest

Runs one agent on a different model for this run. Name the model either with modelName (a model in Maitento’s catalogue) or with customModel (a model you define inline): exactly one of the two.

Kind: an object, used in requests and responses. In a request it is called AiModelOverrideRequestInput.

In a request

Section titled “In a request”
FieldTypeRequiredDescription
agentNamestringyesThe agent (its name in the interaction) to run on the other model. Constraints: required (empty or whitespace-only strings are rejected).
modelNamestring | nullThe name of a catalogue model. Required unless customModel is given.
customModelInlineAiModelDefinitionInput| nullA model defined inline, for one that isn’t in the catalogue. Not allowed with modelName.
purposeAiModelOverridePurposeWhich of the agent’s models this replaces: its own (the default), or the one that vets what its loom offers it.
{
  "agentName": "...",
  "modelName": "...",
  "customModel": {
    "name": "...",
    "apiType": "...",
    "modelIdentifier": "...",
    "credentialProvider": "...",
    "contextWindowTokens": 0,
    "maxOutputTokens": 0,
    "supportsJsonSchemaResponseFormat": false,
    "tokenizerFamily": "...",
    "reasoningEffort": "..."
  },
  "purpose": "Agent"
}

In a response

Section titled “In a response”

Every field is present in a response; empty ones are null.

FieldTypeDescription
agentNamestringThe agent (its name in the interaction) to run on the other model. Constraints: required (empty or whitespace-only strings are rejected).
modelNamestring | nullThe name of a catalogue model. Required unless customModel is given.
customModelInlineAiModelDefinition| nullA model defined inline, for one that isn’t in the catalogue. Not allowed with modelName.
purposeAiModelOverridePurposeWhich of the agent’s models this replaces: its own (the default), or the one that vets what its loom offers it.
{
  "agentName": "...",
  "modelName": "...",
  "customModel": {
    "name": "...",
    "apiType": "...",
    "modelIdentifier": "...",
    "credentialProvider": "...",
    "contextWindowTokens": 0,
    "maxOutputTokens": 0,
    "supportsJsonSchemaResponseFormat": false,
    "tokenizerFamily": "...",
    "reasoningEffort": "..."
  },
  "purpose": "Agent"
}

Where it’s used

Section titled “Where it’s used”
maitento