AppStartRequest

The body of an app start: its inputs, plus optional model keys, model overrides and web settings. Changing a run’s inputs takes the same body, and reads only inputs.

Kind: an object, used in requests.

Fields

Field	Type	Required	Description
inputs	NameValuePair[]	yes	A value for every input the app declares (the parameters of its main), by name. Every declared input is required; a name the app doesn’t declare is ignored. Constraints: required (empty or whitespace-only strings are rejected).
credentials	InteractionProcessCredentialRequest[] | null		Model keys for this run, in the order they are tried. Every interaction the app starts uses them before your tenant’s model keys. Null or empty: only your tenant’s keys are used.
allowMaitentoFallback	boolean | null		Whether an interaction this app starts may use Maitento’s own key for a provider once no key of yours for it is left. Null means no.
credentialStack	string | null		The credential stack the run uses, by id or name, and every interaction and code pipeline it starts. Its credentials serve every model call, in the stack’s order, and Maitento’s own keys are never used. Leave it out to use the app’s own stack, then the namespace’s default, then your tenant’s. Can’t be combined with credentials.
aiModelOverrides	AiModelOverrideRequestInput[] | null		Model overrides for named agents, applied to every interaction this app starts. Null or empty: agents use the models their definitions name.
webDownloadPartitionId	uuid | null		The temporary knowledge base (partition) that pages fetched by the web tools of every interaction and code pipeline this app starts are kept in, passed on to the apps it starts. Ignored unless it is one of your temporary knowledge bases. Null: each run uses its namespace’s default, then the tenant’s.
webAccessOverrides	WebAccessOverrideInput[] | null		Web tool overrides (on or off, for all agents or one by name) applied to every interaction this app starts.

Example

{
  "inputs": [
    {
      "name": "...",
      "value": "..."
    }
  ],
  "credentials": [
    {
      "provider": "...",
      "apiKey": "...",
      "baseUrl": "...",
      "modelNameOverrides": {
        "key": "..."
      },
      "credentialId": "...",
      "isOwnLicense": false,
      "priority": 0
    }
  ],
  "allowMaitentoFallback": false,
  "credentialStack": "...",
  "aiModelOverrides": [
    {
      "agentName": "...",
      "modelName": "...",
      "customModel": {},
      "purpose": "Agent"
    }
  ],
  "webDownloadPartitionId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "webAccessOverrides": [
    {
      "agentName": "...",
      "search": false,
      "fetch": false
    }
  ]
}

Where it’s used

• appRuns.updateInputs (PUT /apps/processes/by-id/{id}/inputs)
• apps.start (PUT /apps/by-id/{id}/versions/{versionNumber}/start)
• apps.start (PUT /namespaces/{namespaceName}/apps/by-name/{name}/versions/latest/start)