InkBotDocs

Models and settings

Server info, the models bots can use, host settings and providers.

Info

GET /info returns { name, version, operatingSystem, workspaceFolder }.

Models

GET /models lists the models bots on this server can use (switched on under their providers):

[
  { "key": "anthropic/claude-opus-5-5", "providerId": "anthropic", "providerName": "Claude (API)", "modelId": "claude-opus-5-5", "modelName": "Claude Opus 5.5", "usesApiKey": true }
]

Use key as a bot's modelKey.

Settings

Method Path Body Returns
GET /settings HostSettings: approvalMode, workspaceFolder, defaultWorkspaceFolder, workspaceIsDefault, approvalTimeoutMinutes, defaultModelKey, allowedCommands
PUT /settings/approval-mode { "mode": "Ask" } 204. Ask, AutoAccept, LlmDecides or FullAccess.
PUT /settings/approval-timeout { "minutes": 30 } 204. How long approval and question cards wait; 0 waits until the reply ends.
PUT /settings/allowed-commands { "commands": ["git status", "npm test"] } 204. Replaces the whole allowlist.
PUT /settings/workspace { "folder": "/srv/work" } HostSettings. An empty folder goes back to the default. Files aren't moved.

Providers

Method Path Body Returns
GET /providers ProviderState[]: every provider, whether it's connected, and its models
POST /providers/{id}/connect { "apiKey": "..." }, { "baseUrl": "..." } or { "useSaved": true } { provider, modelCount }. The key is checked before it's saved.
POST /providers/{id}/disconnect { provider, signOutConfirmed }. Forgets the key or sign-in.
PUT /providers/{id}/models { "modelIds": ["claude-opus-5-5"] } ProviderState. The models switched on.
GET /providers/{id}/accounts AgentAccount[]: provider accounts an agent app keeps (OpenCode)
DELETE /providers/{id}/accounts/{accountId} 204

Provider ids include anthropic, openai, google, xai, kimi, minimax, minimax-plan, openrouter, nous, ollama, unsloth, local, claude-code, chatgpt, codex, grok-build, cursor, kimi-code and opencode.

  • API-key providers take apiKey. Ollama takes baseUrl, and Unsloth Studio takes baseUrl and an optional apiKey.
  • useSaved: true checks again with what's saved, which refreshes the model list.
  • Agent apps (claude-code, codex, grok-build, cursor, kimi-code, opencode) must be installed and signed in on the server first. connect then finds them. canSignInHere is false on servers.
  • POST /providers/{id}/accounts explains how to add an account in the server's terminal, since there is no window to open there.