opensource/kilocode
3
0
Fork 0
mirror of https://github.com/Kilo-Org/kilocode.git synced 2026-09-01 15:32:11 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
bd69158131aafdcc2f44aede22b573c2b0432f21
kilocode/packages/sdk/openapi.json
T

42301 lines
1.2 MiB
Plaintext
Raw Blame History

{
"openapi": "3.1.0",
"info": {
"title": "kilo",
"version": "1.0.0",
"description": "kilo api"
},
"paths": {
"/auth/{providerID}": {
"put": {
"tags": ["control"],
"operationId": "auth.set",
"parameters": [
{
"name": "providerID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successfully set authentication credentials",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Successfully set authentication credentials"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Set authentication credentials",
"summary": "Set auth credentials",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Auth"
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.auth.set({\n ...\n})"
}
]
},
"delete": {
"tags": ["control"],
"operationId": "auth.remove",
"parameters": [
{
"name": "providerID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successfully removed authentication credentials",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Successfully removed authentication credentials"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Remove authentication credentials",
"summary": "Remove auth credentials",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.auth.remove({\n ...\n})"
}
]
}
},
"/log": {
"post": {
"tags": ["control"],
"operationId": "app.log",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Log entry written successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Log entry written successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Write a log entry to the server logs with specified level and metadata.",
"summary": "Write log",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"service": {
"type": "string",
"description": "Service name for the log entry"
},
"level": {
"type": "string",
"enum": ["debug", "info", "error", "warn"],
"description": "Log level"
},
"message": {
"type": "string",
"description": "Log message"
},
"extra": {
"type": "object"
}
},
"required": ["service", "level", "message"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.app.log({\n ...\n})"
}
]
}
},
"/experimental/control-plane/move-session": {
"post": {
"tags": ["controlPlane"],
"operationId": "experimental.controlPlane.moveSession",
"parameters": [],
"responses": {
"204": {
"description": "Session moved"
},
"400": {
"description": "MoveSessionError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/MoveSessionError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Move a session to another project directory, optionally transferring local changes.",
"summary": "Move session",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"destination": {
"$ref": "#/components/schemas/MoveSessionDestination"
},
"moveChanges": {
"type": "boolean"
}
},
"required": ["sessionID", "destination"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.controlPlane.moveSession({\n ...\n})"
}
]
}
},
"/global/health": {
"get": {
"tags": ["global"],
"operationId": "global.health",
"parameters": [],
"responses": {
"200": {
"description": "Health information",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"healthy": {
"type": "boolean",
"enum": [true]
},
"version": {
"type": "string"
}
},
"required": ["healthy", "version"],
"additionalProperties": false,
"description": "Health information"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get health information about the Kilo server.",
"summary": "Get health",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.global.health({\n ...\n})"
}
]
}
},
"/global/event": {
"get": {
"tags": ["global"],
"operationId": "global.event",
"parameters": [],
"responses": {
"200": {
"description": "Event stream",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/GlobalEvent"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Subscribe to global events from the Kilo system using server-sent events.",
"summary": "Get global events",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.global.event({\n ...\n})"
}
]
}
},
"/global/config": {
"get": {
"tags": ["global"],
"operationId": "global.config.get",
"parameters": [],
"responses": {
"200": {
"description": "Get global config info",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Config"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve the current global Kilo configuration settings and preferences.",
"summary": "Get global configuration",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.global.config.get({\n ...\n})"
}
]
},
"patch": {
"tags": ["global"],
"operationId": "global.config.update",
"parameters": [],
"responses": {
"200": {
"description": "Successfully updated global config",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Config"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Update global Kilo configuration settings and preferences.",
"summary": "Update global configuration",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Config"
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.global.config.update({\n ...\n})"
}
]
}
},
"/global/dispose": {
"post": {
"tags": ["global"],
"operationId": "global.dispose",
"parameters": [],
"responses": {
"200": {
"description": "Global disposed",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Global disposed"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Clean up and dispose all Kilo instances, releasing all resources.",
"summary": "Dispose instance",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.global.dispose({\n ...\n})"
}
]
}
},
"/global/upgrade": {
"post": {
"tags": ["global"],
"operationId": "global.upgrade",
"parameters": [],
"responses": {
"200": {
"description": "Upgrade result",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [true]
},
"version": {
"type": "string"
}
},
"required": ["success", "version"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [false]
},
"error": {
"type": "string"
}
},
"required": ["success", "error"],
"additionalProperties": false
}
],
"description": "Upgrade result"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Upgrade kilo to the specified version or latest if not specified.",
"summary": "Upgrade kilo",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"target": {
"type": "string"
}
},
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.global.upgrade({\n ...\n})"
}
]
}
},
"/event": {
"get": {
"tags": ["event"],
"operationId": "event.subscribe",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Event stream",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Event"
}
}
}
}
},
"description": "Get events",
"summary": "Subscribe to events",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.event.subscribe({\n ...\n})"
}
]
}
},
"/config": {
"get": {
"tags": ["config"],
"operationId": "config.get",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Get config info",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Config"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve the current Kilo configuration settings and preferences.",
"summary": "Get configuration",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.config.get({\n ...\n})"
}
]
},
"patch": {
"tags": ["config"],
"operationId": "config.update",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Successfully updated config",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Config"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Update Kilo configuration settings and preferences.",
"summary": "Update configuration",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Config"
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.config.update({\n ...\n})"
}
]
}
},
"/config/warnings": {
"get": {
"tags": ["config"],
"operationId": "config.warnings",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Config warnings",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
},
"detail": {
"type": "string"
}
},
"required": ["path", "message"],
"additionalProperties": false
},
"description": "Config warnings"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get warnings generated during config loading (e.g., invalid JSON, schema errors).",
"summary": "Get config warnings",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.config.warnings({\n ...\n})"
}
]
}
},
"/config/providers": {
"get": {
"tags": ["config"],
"operationId": "config.providers",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of providers",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"providers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Provider"
}
},
"default": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": ["providers", "default"],
"additionalProperties": false,
"description": "List of providers"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get a list of all configured AI providers and their default models.",
"summary": "List config providers",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.config.providers({\n ...\n})"
}
]
}
},
"/experimental/console": {
"get": {
"tags": ["experimental"],
"operationId": "experimental.console.get",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Active Console provider metadata",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleState"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/effect_HttpApiError_InternalServerError"
}
}
}
}
},
"description": "Get the active Console org name and the set of provider IDs managed by that Console org.",
"summary": "Get active Console provider metadata",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.console.get({\n ...\n})"
}
]
}
},
"/experimental/console/orgs": {
"get": {
"tags": ["experimental"],
"operationId": "experimental.console.listOrgs",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Switchable Console orgs",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"orgs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"accountEmail": {
"type": "string"
},
"accountUrl": {
"type": "string"
},
"orgID": {
"type": "string"
},
"orgName": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": ["accountID", "accountEmail", "accountUrl", "orgID", "orgName", "active"],
"additionalProperties": false
}
}
},
"required": ["orgs"],
"additionalProperties": false,
"description": "Switchable Console orgs"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/effect_HttpApiError_InternalServerError"
}
}
}
}
},
"description": "Get the available Console orgs across logged-in accounts, including the current active org.",
"summary": "List switchable Console orgs",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.console.listOrgs({\n ...\n})"
}
]
}
},
"/experimental/console/switch": {
"post": {
"tags": ["experimental"],
"operationId": "experimental.console.switchOrg",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Switch success",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Switch success"
}
}
}
}
},
"description": "Persist a new active Console account/org selection for the current local Kilo state.",
"summary": "Switch active Console org",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"orgID": {
"type": "string"
}
},
"required": ["accountID", "orgID"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.console.switchOrg({\n ...\n})"
}
]
}
},
"/experimental/tool": {
"get": {
"tags": ["experimental"],
"operationId": "tool.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "provider",
"in": "query",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "model",
"in": "query",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Tools",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ToolList"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Get a list of available tools with their JSON schema parameters for a specific provider and model combination.",
"summary": "List tools",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tool.list({\n ...\n})"
}
]
}
},
"/experimental/tool/ids": {
"get": {
"tags": ["experimental"],
"operationId": "tool.ids",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Tool IDs",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ToolIDs"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Get a list of all available tool IDs, including both built-in tools and dynamically registered tools.",
"summary": "List tool IDs",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tool.ids({\n ...\n})"
}
]
}
},
"/experimental/worktree": {
"get": {
"tags": ["experimental"],
"operationId": "worktree.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of worktrees",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorktreeListItem"
},
"description": "List of worktrees"
}
}
}
},
"400": {
"description": "WorktreeError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/WorktreeError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "List all git worktrees for the current project and whether Kilo manages them.",
"summary": "List worktrees",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.worktree.list({\n ...\n})"
}
]
},
"post": {
"tags": ["experimental"],
"operationId": "worktree.create",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Worktree created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Worktree"
}
}
}
},
"400": {
"description": "WorktreeError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/WorktreeError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Create a new git worktree for the current project and run any configured startup scripts.",
"summary": "Create worktree",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorktreeCreateInput"
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.worktree.create({\n ...\n})"
}
]
},
"delete": {
"tags": ["experimental"],
"operationId": "worktree.remove",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Worktree removed",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Worktree removed"
}
}
}
},
"400": {
"description": "WorktreeError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/WorktreeError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Remove a git worktree and delete its branch.",
"summary": "Remove worktree",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorktreeRemoveInput"
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.worktree.remove({\n ...\n})"
}
]
}
},
"/experimental/worktree/reset": {
"post": {
"tags": ["experimental"],
"operationId": "worktree.reset",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Worktree reset",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Worktree reset"
}
}
}
},
"400": {
"description": "WorktreeError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/WorktreeError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Reset a worktree branch to the primary default branch.",
"summary": "Reset worktree",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorktreeResetInput"
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.worktree.reset({\n ...\n})"
}
]
}
},
"/experimental/worktree/diff": {
"get": {
"tags": ["experimental"],
"operationId": "worktree.diff",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "base",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "File diffs",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotFileDiff"
},
"description": "File diffs"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Get file diffs for a worktree compared to its base branch. Includes uncommitted changes.",
"summary": "Get worktree diff",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.worktree.diff({\n ...\n})"
}
]
}
},
"/experimental/worktree/diff/summary": {
"get": {
"tags": ["experimental"],
"operationId": "worktree.diffSummary",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "base",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Diff summary items",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorktreeDiffItem"
},
"description": "Diff summary items"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Get lightweight file diff metadata for a worktree compared to its base branch.",
"summary": "Get worktree diff summary",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.worktree.diffSummary({\n ...\n})"
}
]
}
},
"/experimental/worktree/diff/file": {
"get": {
"tags": ["experimental"],
"operationId": "worktree.diffFile",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "base",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "file",
"in": "query",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Diff detail item",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorktreeDiffItem"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Get full diff contents for one worktree file compared to its base branch.",
"summary": "Get worktree diff detail",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.worktree.diffFile({\n ...\n})"
}
]
}
},
"/experimental/session": {
"get": {
"tags": ["experimental"],
"operationId": "experimental.session.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "projectID",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "worktrees",
"in": "query",
"schema": {
"type": "boolean"
},
"required": false
},
{
"name": "current",
"in": "query",
"schema": {
"type": "string",
"enum": ["true", "false"]
},
"required": false
},
{
"name": "roots",
"in": "query",
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["true", "false"]
}
]
},
"required": false
},
{
"name": "start",
"in": "query",
"schema": {
"type": "number"
},
"required": false
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "number"
},
"required": false
},
{
"name": "search",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "number"
},
"required": false
},
{
"name": "archived",
"in": "query",
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["true", "false"]
}
]
},
"required": false
}
],
"responses": {
"200": {
"description": "List of sessions",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlobalSession"
},
"description": "List of sessions"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get a list of all Kilo sessions across projects, sorted by most recently updated. Archived sessions are excluded by default.",
"summary": "List sessions",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.session.list({\n ...\n})"
}
]
}
},
"/experimental/session/{sessionID}/background": {
"post": {
"tags": ["experimental"],
"operationId": "experimental.session.background",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Backgrounded subagents",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Backgrounded subagents"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Detach any synchronous subagents currently blocking the session and continue them in the background.",
"summary": "Background subagents",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.session.background({\n ...\n})"
}
]
}
},
"/experimental/resource": {
"get": {
"tags": ["experimental"],
"operationId": "experimental.resource.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "MCP resources",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/McpResource"
},
"description": "MCP resources"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get all available MCP resources from connected servers. Optionally filter by name.",
"summary": "Get MCP resources",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.resource.list({\n ...\n})"
}
]
}
},
"/find": {
"get": {
"tags": ["file"],
"operationId": "find.text",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "pattern",
"in": "query",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Matches",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"required": ["text"],
"additionalProperties": false
},
"lines": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"required": ["text"],
"additionalProperties": false
},
"line_number": {
"type": "integer",
"minimum": 0
},
"absolute_offset": {
"type": "integer",
"minimum": 0
},
"submatches": {
"type": "array",
"items": {
"type": "object",
"properties": {
"match": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"required": ["text"],
"additionalProperties": false
},
"start": {
"type": "integer",
"minimum": 0
},
"end": {
"type": "integer",
"minimum": 0
}
},
"required": ["match", "start", "end"],
"additionalProperties": false
}
}
},
"required": ["path", "lines", "line_number", "absolute_offset", "submatches"],
"additionalProperties": false
},
"description": "Matches"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Search for text patterns across files in the project using ripgrep.",
"summary": "Find text",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.find.text({\n ...\n})"
}
]
}
},
"/find/file": {
"get": {
"tags": ["file"],
"operationId": "find.files",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "dirs",
"in": "query",
"schema": {
"type": "string",
"enum": ["true", "false"]
},
"required": false
},
{
"name": "type",
"in": "query",
"schema": {
"type": "string",
"enum": ["file", "directory"]
},
"required": false
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 200
},
"required": false
}
],
"responses": {
"200": {
"description": "File paths",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "File paths"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Search for files or directories by name or pattern in the project directory.",
"summary": "Find files",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.find.files({\n ...\n})"
}
]
}
},
"/find/symbol": {
"get": {
"tags": ["file"],
"operationId": "find.symbols",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Symbols",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Symbol"
},
"description": "Symbols"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Search for workspace symbols like functions, classes, and variables using LSP.",
"summary": "Find symbols",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.find.symbols({\n ...\n})"
}
]
}
},
"/file": {
"get": {
"tags": ["file"],
"operationId": "file.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Files and directories",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileNode"
},
"description": "Files and directories"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "List files and directories in a specified path.",
"summary": "List files",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.file.list({\n ...\n})"
}
]
}
},
"/file/content": {
"get": {
"tags": ["file"],
"operationId": "file.read",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "File content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileContent"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Read the content of a specified file.",
"summary": "Read file",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.file.read({\n ...\n})"
}
]
}
},
"/file/status": {
"get": {
"tags": ["file"],
"operationId": "file.status",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "File status",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/File"
},
"description": "File status"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get the git status of all files in the project.",
"summary": "Get file status",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.file.status({\n ...\n})"
}
]
}
},
"/instance/dispose": {
"post": {
"tags": ["instance"],
"operationId": "instance.dispose",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Instance disposed",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Instance disposed"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Clean up and dispose the current Kilo instance, releasing all resources.",
"summary": "Dispose instance",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.instance.dispose({\n ...\n})"
}
]
}
},
"/path": {
"get": {
"tags": ["instance"],
"operationId": "path.get",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Path",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Path"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve the current working directory and related path information for the Kilo instance.",
"summary": "Get paths",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.path.get({\n ...\n})"
}
]
}
},
"/vcs": {
"get": {
"tags": ["instance"],
"operationId": "vcs.get",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "VCS info",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VcsInfo"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve version control system (VCS) information for the current project, such as git branch.",
"summary": "Get VCS info",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.vcs.get({\n ...\n})"
}
]
}
},
"/vcs/status": {
"get": {
"tags": ["instance"],
"operationId": "vcs.status",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "VCS status",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VcsFileStatus"
},
"description": "VCS status"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve changed files in the current working tree without patches.",
"summary": "Get VCS status",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.vcs.status({\n ...\n})"
}
]
}
},
"/vcs/diff": {
"get": {
"tags": ["instance"],
"operationId": "vcs.diff",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "mode",
"in": "query",
"schema": {
"type": "string",
"enum": ["git", "branch"]
},
"required": true
},
{
"name": "context",
"in": "query",
"schema": {
"type": "integer",
"minimum": 0
},
"required": false
}
],
"responses": {
"200": {
"description": "VCS diff",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VcsFileDiff"
},
"description": "VCS diff"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve the current git diff for the working tree or against the default branch.",
"summary": "Get VCS diff",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.vcs.diff({\n ...\n})"
}
]
}
},
"/vcs/diff/raw": {
"get": {
"tags": ["instance"],
"operationId": "vcs.diff.raw",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Raw VCS diff",
"content": {
"text/x-diff; charset=utf-8": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve a raw patch for current uncommitted changes.",
"summary": "Get raw VCS diff",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.vcs.diff.raw({\n ...\n})"
}
]
}
},
"/vcs/apply": {
"post": {
"tags": ["instance"],
"operationId": "vcs.apply",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "VCS patch applied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applied": {
"type": "boolean"
}
},
"required": ["applied"],
"additionalProperties": false,
"description": "VCS patch applied"
}
}
}
},
"400": {
"description": "VcsApplyError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/VcsApplyError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Apply a raw patch to the current working tree.",
"summary": "Apply VCS patch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"patch": {
"type": "string"
}
},
"required": ["patch"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.vcs.apply({\n ...\n})"
}
]
}
},
"/command": {
"get": {
"tags": ["instance"],
"operationId": "command.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of commands",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Command"
},
"description": "List of commands"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get a list of all available commands in the Kilo system.",
"summary": "List commands",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.command.list({\n ...\n})"
}
]
}
},
"/agent": {
"get": {
"tags": ["instance"],
"operationId": "app.agents",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of agents",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Agent"
},
"description": "List of agents"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get a list of all available AI agents in the Kilo system.",
"summary": "List agents",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.app.agents({\n ...\n})"
}
]
}
},
"/skill": {
"get": {
"tags": ["instance"],
"operationId": "app.skills",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of skills",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"content": {
"type": "string"
}
},
"required": ["name", "location", "content"],
"additionalProperties": false
},
"description": "List of skills"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get a list of all available skills in the Kilo system.",
"summary": "List skills",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.app.skills({\n ...\n})"
}
]
}
},
"/lsp": {
"get": {
"tags": ["instance"],
"operationId": "lsp.status",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "LSP server status",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LSPStatus"
},
"description": "LSP server status"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get LSP server status",
"summary": "Get LSP status",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.lsp.status({\n ...\n})"
}
]
}
},
"/formatter": {
"get": {
"tags": ["instance"],
"operationId": "formatter.status",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Formatter status",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FormatterStatus"
},
"description": "Formatter status"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get formatter status",
"summary": "Get formatter status",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.formatter.status({\n ...\n})"
}
]
}
},
"/mcp": {
"get": {
"tags": ["mcp"],
"operationId": "mcp.status",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "MCP server status",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/MCPStatus"
},
"description": "MCP server status"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get the status of all Model Context Protocol (MCP) servers.",
"summary": "Get MCP status",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.mcp.status({\n ...\n})"
}
]
},
"post": {
"tags": ["mcp"],
"operationId": "mcp.add",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "MCP server added successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/MCPStatus"
},
"description": "MCP server added successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Dynamically add a new Model Context Protocol (MCP) server to the system.",
"summary": "Add MCP server",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"config": {
"anyOf": [
{
"$ref": "#/components/schemas/McpLocalConfig"
},
{
"$ref": "#/components/schemas/McpRemoteConfig"
}
]
}
},
"required": ["name", "config"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.mcp.add({\n ...\n})"
}
]
}
},
"/mcp/{name}/auth": {
"post": {
"tags": ["mcp"],
"operationId": "mcp.auth.start",
"parameters": [
{
"name": "name",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "OAuth flow started",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"authorizationUrl": {
"type": "string"
},
"oauthState": {
"type": "string"
}
},
"required": ["authorizationUrl", "oauthState"],
"additionalProperties": false,
"description": "OAuth flow started"
}
}
}
},
"400": {
"description": "McpUnsupportedOAuthError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/McpUnsupportedOAuthError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "McpServerNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/McpServerNotFoundError"
}
}
}
}
},
"description": "Start OAuth authentication flow for a Model Context Protocol (MCP) server.",
"summary": "Start MCP OAuth",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.mcp.auth.start({\n ...\n})"
}
]
},
"delete": {
"tags": ["mcp"],
"operationId": "mcp.auth.remove",
"parameters": [
{
"name": "name",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "OAuth credentials removed",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [true]
}
},
"required": ["success"],
"additionalProperties": false,
"description": "OAuth credentials removed"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "McpServerNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/McpServerNotFoundError"
}
}
}
}
},
"description": "Remove OAuth credentials for an MCP server.",
"summary": "Remove MCP OAuth",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.mcp.auth.remove({\n ...\n})"
}
]
}
},
"/mcp/{name}/auth/callback": {
"post": {
"tags": ["mcp"],
"operationId": "mcp.auth.callback",
"parameters": [
{
"name": "name",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "OAuth authentication completed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MCPStatus"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "McpServerNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/McpServerNotFoundError"
}
}
}
}
},
"description": "Complete OAuth authentication for a Model Context Protocol (MCP) server using the authorization code.",
"summary": "Complete MCP OAuth",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string"
}
},
"required": ["code"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.mcp.auth.callback({\n ...\n})"
}
]
}
},
"/mcp/{name}/auth/authenticate": {
"post": {
"tags": ["mcp"],
"operationId": "mcp.auth.authenticate",
"parameters": [
{
"name": "name",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "OAuth authentication completed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MCPStatus"
}
}
}
},
"400": {
"description": "McpUnsupportedOAuthError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/McpUnsupportedOAuthError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "McpServerNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/McpServerNotFoundError"
}
}
}
}
},
"description": "Start OAuth flow and wait for callback (opens browser).",
"summary": "Authenticate MCP OAuth",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.mcp.auth.authenticate({\n ...\n})"
}
]
}
},
"/mcp/{name}/connect": {
"post": {
"tags": ["mcp"],
"operationId": "mcp.connect",
"parameters": [
{
"name": "name",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "MCP server connected successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "MCP server connected successfully"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "McpServerNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/McpServerNotFoundError"
}
}
}
}
},
"description": "Connect an MCP server.",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.mcp.connect({\n ...\n})"
}
]
}
},
"/mcp/{name}/disconnect": {
"post": {
"tags": ["mcp"],
"operationId": "mcp.disconnect",
"parameters": [
{
"name": "name",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "MCP server disconnected successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "MCP server disconnected successfully"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "McpServerNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/McpServerNotFoundError"
}
}
}
}
},
"description": "Disconnect an MCP server.",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.mcp.disconnect({\n ...\n})"
}
]
}
},
"/project": {
"get": {
"tags": ["project"],
"operationId": "project.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of projects",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Project"
},
"description": "List of projects"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get a list of projects that have been opened with Kilo.",
"summary": "List all projects",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.project.list({\n ...\n})"
}
]
}
},
"/project/current": {
"get": {
"tags": ["project"],
"operationId": "project.current",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Current project information",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Project"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve the currently active project that Kilo is working with.",
"summary": "Get current project",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.project.current({\n ...\n})"
}
]
}
},
"/project/git/init": {
"post": {
"tags": ["project"],
"operationId": "project.initGit",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Project information after git initialization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Project"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Create a git repository for the current project and return the refreshed project info.",
"summary": "Initialize git repository",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.project.initGit({\n ...\n})"
}
]
}
},
"/project/{projectID}": {
"patch": {
"tags": ["project"],
"operationId": "project.update",
"parameters": [
{
"name": "projectID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Updated project information",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Project"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "ProjectNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectNotFoundError"
}
}
}
}
},
"description": "Update project properties such as name, icon, and commands.",
"summary": "Update project",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"icon": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"override": {
"type": "string"
},
"color": {
"type": "string"
}
},
"additionalProperties": false
},
"commands": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "Startup script to run when creating a new workspace (worktree)"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.project.update({\n ...\n})"
}
]
}
},
"/project/{projectID}/directories": {
"get": {
"tags": ["project"],
"operationId": "project.directories",
"parameters": [
{
"name": "projectID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Project directories",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectDirectories"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "List known local absolute directories for a project.",
"summary": "List project directories",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.project.directories({\n ...\n})"
}
]
}
},
"/experimental/project/{projectID}/copy": {
"post": {
"tags": ["projectCopy"],
"operationId": "experimental.projectCopy.create",
"parameters": [
{
"name": "projectID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Project copy created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectCopyCopy"
}
}
}
},
"400": {
"description": "ProjectCopyError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectCopyError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Create a local physical copy of a project using the selected strategy.",
"summary": "Create project copy",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"strategy": {
"type": "string",
"enum": ["git_worktree"]
},
"directory": {
"type": "string"
},
"name": {
"type": "string"
},
"context": {
"type": "string"
}
},
"required": ["strategy", "directory"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.projectCopy.create({\n ...\n})"
}
]
},
"delete": {
"tags": ["projectCopy"],
"operationId": "experimental.projectCopy.remove",
"parameters": [
{
"name": "projectID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"204": {
"description": "Project copy removed"
},
"400": {
"description": "ProjectCopyError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectCopyError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Remove a local physical copy of a project using the selected strategy.",
"summary": "Remove project copy",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
}
},
"required": ["directory"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.projectCopy.remove({\n ...\n})"
}
]
}
},
"/experimental/project/{projectID}/copy/refresh": {
"post": {
"tags": ["projectCopy"],
"operationId": "experimental.projectCopy.refresh",
"parameters": [
{
"name": "projectID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"204": {
"description": "Project copies refreshed"
},
"400": {
"description": "ProjectCopyError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectCopyError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Discover local project copies using one or all configured strategies.",
"summary": "Refresh project copies",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.projectCopy.refresh({\n ...\n})"
}
]
}
},
"/pty/shells": {
"get": {
"tags": ["pty"],
"operationId": "pty.shells",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of shells",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"name": {
"type": "string"
},
"acceptable": {
"type": "boolean"
}
},
"required": ["path", "name", "acceptable"],
"additionalProperties": false
},
"description": "List of shells"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get a list of available shells on the system.",
"summary": "List available shells",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.pty.shells({\n ...\n})"
}
]
}
},
"/pty": {
"get": {
"tags": ["pty"],
"operationId": "pty.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of sessions",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Pty"
},
"description": "List of sessions"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get a list of all active pseudo-terminal (PTY) sessions managed by Kilo.",
"summary": "List PTY sessions",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.pty.list({\n ...\n})"
}
]
},
"post": {
"tags": ["pty"],
"operationId": "pty.create",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Created session",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pty"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Create a new pseudo-terminal (PTY) session for running shell commands and processes.",
"summary": "Create PTY session",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"cwd": {
"type": "string"
},
"title": {
"type": "string"
},
"env": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.pty.create({\n ...\n})"
}
]
}
},
"/pty/{ptyID}": {
"get": {
"tags": ["pty"],
"operationId": "pty.get",
"parameters": [
{
"name": "ptyID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^pty.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Session info",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pty"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "PtyNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PtyNotFoundError"
}
}
}
}
},
"description": "Retrieve detailed information about a specific pseudo-terminal (PTY) session.",
"summary": "Get PTY session",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.pty.get({\n ...\n})"
}
]
},
"put": {
"tags": ["pty"],
"operationId": "pty.update",
"parameters": [
{
"name": "ptyID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^pty.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Updated session",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pty"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "PtyNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PtyNotFoundError"
}
}
}
}
},
"description": "Update properties of an existing pseudo-terminal (PTY) session.",
"summary": "Update PTY session",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"sessionID": {
"anyOf": [
{
"type": "string",
"pattern": "^ses"
},
{
"type": "null"
}
]
},
"size": {
"type": "object",
"properties": {
"rows": {
"type": "integer",
"exclusiveMinimum": 0
},
"cols": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"required": ["rows", "cols"],
"additionalProperties": false
}
},
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.pty.update({\n ...\n})"
}
]
},
"delete": {
"tags": ["pty"],
"operationId": "pty.remove",
"parameters": [
{
"name": "ptyID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^pty.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Session removed",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Session removed"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "PtyNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PtyNotFoundError"
}
}
}
}
},
"description": "Remove and terminate a specific pseudo-terminal (PTY) session.",
"summary": "Remove PTY session",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.pty.remove({\n ...\n})"
}
]
}
},
"/pty/{ptyID}/connect-token": {
"post": {
"tags": ["pty"],
"operationId": "pty.connectToken",
"parameters": [
{
"name": "ptyID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^pty.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "WebSocket connect token",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ticket": {
"type": "string"
},
"expires_in": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"required": ["ticket", "expires_in"],
"additionalProperties": false,
"description": "WebSocket connect token"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"403": {
"description": "PtyForbiddenError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PtyForbiddenError"
}
}
}
},
"404": {
"description": "PtyNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PtyNotFoundError"
}
}
}
}
},
"description": "Create a short-lived ticket for opening a PTY WebSocket connection.",
"summary": "Create PTY WebSocket token",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.pty.connectToken({\n ...\n})"
}
]
}
},
"/question": {
"get": {
"tags": ["question"],
"operationId": "question.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of pending questions",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionRequest"
},
"description": "List of pending questions"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get all pending question requests across all sessions.",
"summary": "List pending questions",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.question.list({\n ...\n})"
}
]
}
},
"/question/{requestID}/reply": {
"post": {
"tags": ["question"],
"operationId": "question.reply",
"parameters": [
{
"name": "requestID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^que.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Question answered successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Question answered successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "QuestionNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionNotFoundError"
}
}
}
}
},
"description": "Provide answers to a question request from the AI assistant.",
"summary": "Reply to question request",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionAnswer"
},
"description": "User answers in order of questions (each answer is an array of selected labels)"
}
},
"required": ["answers"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.question.reply({\n ...\n})"
}
]
}
},
"/question/{requestID}/reject": {
"post": {
"tags": ["question"],
"operationId": "question.reject",
"parameters": [
{
"name": "requestID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^que.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Question rejected successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Question rejected successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "QuestionNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionNotFoundError"
}
}
}
}
},
"description": "Reject a question request from the AI assistant.",
"summary": "Reject question request",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.question.reject({\n ...\n})"
}
]
}
},
"/permission": {
"get": {
"tags": ["permission"],
"operationId": "permission.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of pending permissions",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionRequest"
},
"description": "List of pending permissions"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get all pending permission requests across all sessions.",
"summary": "List pending permissions",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.permission.list({\n ...\n})"
}
]
}
},
"/permission/{requestID}/reply": {
"post": {
"tags": ["permission"],
"operationId": "permission.reply",
"parameters": [
{
"name": "requestID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^per.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Permission processed successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Permission processed successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "PermissionNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PermissionNotFoundError"
}
}
}
}
},
"description": "Approve or deny a permission request from the AI assistant.",
"summary": "Respond to permission request",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reply": {
"type": "string",
"enum": ["once", "always", "reject"]
},
"message": {
"type": "string"
}
},
"required": ["reply"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.permission.reply({\n ...\n})"
}
]
}
},
"/permission/{requestID}/always-rules": {
"post": {
"tags": ["permission"],
"operationId": "permission.saveAlwaysRules",
"parameters": [
{
"name": "requestID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^per.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Always-rules saved",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Always-rules saved"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "PermissionNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PermissionNotFoundError"
}
}
}
}
},
"description": "Save approved/denied always-rules for a pending permission request.",
"summary": "Save always-allow/deny permission rules",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"approvedAlways": {
"type": "array",
"items": {
"type": "string"
}
},
"deniedAlways": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.permission.saveAlwaysRules({\n ...\n})"
}
]
}
},
"/permission/allow-everything": {
"post": {
"tags": ["permission"],
"operationId": "permission.allowEverything",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Success"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "PermissionNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PermissionNotFoundError"
}
}
}
}
},
"description": "Enable or disable allowing all permissions without prompts.",
"summary": "Allow everything",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enable": {
"type": "boolean"
},
"requestID": {
"type": "string"
},
"sessionID": {
"type": "string"
}
},
"required": ["enable"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.permission.allowEverything({\n ...\n})"
}
]
}
},
"/provider": {
"get": {
"tags": ["provider"],
"operationId": "provider.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of providers",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"all": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Provider"
}
},
"default": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"connected": {
"type": "array",
"items": {
"type": "string"
}
},
"failed": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["all", "default", "connected", "failed"],
"additionalProperties": false,
"description": "List of providers"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get a list of all available AI providers, including both available and connected ones.",
"summary": "List providers",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.provider.list({\n ...\n})"
}
]
}
},
"/provider/auth": {
"get": {
"tags": ["provider"],
"operationId": "provider.auth",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Provider auth methods",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAuthMethod"
}
},
"description": "Provider auth methods"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve available authentication methods for all AI providers.",
"summary": "Get provider auth methods",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.provider.auth({\n ...\n})"
}
]
}
},
"/provider/{providerID}/oauth/authorize": {
"post": {
"tags": ["provider"],
"operationId": "provider.oauth.authorize",
"parameters": [
{
"name": "providerID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Authorization URL and method",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderAuthAuthorization"
}
}
}
},
"400": {
"description": "ProviderAuthError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ProviderAuthError1"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Start the OAuth authorization flow for a provider.",
"summary": "Start OAuth authorization",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"method": {
"type": "number",
"description": "Auth method index"
},
"inputs": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": ["method"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.provider.oauth.authorize({\n ...\n})"
}
]
}
},
"/provider/{providerID}/oauth/callback": {
"post": {
"tags": ["provider"],
"operationId": "provider.oauth.callback",
"parameters": [
{
"name": "providerID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "OAuth callback processed successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "OAuth callback processed successfully"
}
}
}
},
"400": {
"description": "ProviderAuthError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ProviderAuthError1"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Handle the OAuth callback from a provider after user authorization.",
"summary": "Handle OAuth callback",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"method": {
"type": "number",
"description": "Auth method index"
},
"code": {
"type": "string"
}
},
"required": ["method"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.provider.oauth.callback({\n ...\n})"
}
]
}
},
"/session": {
"get": {
"tags": ["session"],
"operationId": "session.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "scope",
"in": "query",
"schema": {
"type": "string",
"enum": ["project"]
},
"required": false
},
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "roots",
"in": "query",
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["true", "false"]
}
]
},
"required": false
},
{
"name": "start",
"in": "query",
"schema": {
"type": "number"
},
"required": false
},
{
"name": "search",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "number"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of sessions",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Session1"
},
"description": "List of sessions"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get a list of all Kilo sessions, sorted by most recently updated.",
"summary": "List sessions",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.list({\n ...\n})"
}
]
},
"post": {
"tags": ["session"],
"operationId": "session.create",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Successfully created session",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Session3"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Create a new Kilo session for interacting with AI assistants and managing conversations.",
"summary": "Create session",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"parentID": {
"type": "string",
"pattern": "^ses"
},
"title": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"metadata": {
"type": "object"
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
"platform": {
"type": "string"
},
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"sandboxInheritanceToken": {
"type": "string"
}
},
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.create({\n ...\n})"
}
]
}
},
"/session/status": {
"get": {
"tags": ["session"],
"operationId": "session.status",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Get session status",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/SessionStatus"
},
"description": "Get session status"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Retrieve the current status of all sessions, including active, idle, and completed states.",
"summary": "Get session status",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.status({\n ...\n})"
}
]
}
},
"/session/{sessionID}": {
"get": {
"tags": ["session"],
"operationId": "session.get",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Get session",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Session2"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Retrieve detailed information about a specific Kilo session.",
"summary": "Get session",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.get({\n ...\n})"
}
]
},
"delete": {
"tags": ["session"],
"operationId": "session.delete",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Successfully deleted session",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Successfully deleted session"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Delete a session and permanently remove all associated data, including messages and history.",
"summary": "Delete session",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.delete({\n ...\n})"
}
]
},
"patch": {
"tags": ["session"],
"operationId": "session.update",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Successfully updated session",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Session4"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Update properties of an existing session, such as title or other metadata.",
"summary": "Update session",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"metadata": {
"type": "object"
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
"time": {
"type": "object",
"properties": {
"archived": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.update({\n ...\n})"
}
]
}
},
"/session/{sessionID}/children": {
"get": {
"tags": ["session"],
"operationId": "session.children",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of children",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Session1"
},
"description": "List of children"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Retrieve all child sessions that were forked from the specified parent session.",
"summary": "Get session children",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.children({\n ...\n})"
}
]
}
},
"/session/{sessionID}/todo": {
"get": {
"tags": ["session"],
"operationId": "session.todo",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Todo list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Todo"
},
"description": "Todo list"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Retrieve the todo list associated with a specific session, showing tasks and action items.",
"summary": "Get session todos",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.todo({\n ...\n})"
}
]
}
},
"/session/{sessionID}/diff": {
"get": {
"tags": ["session"],
"operationId": "session.diff",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "messageID",
"in": "query",
"schema": {
"type": "string",
"pattern": "^msg"
},
"required": false
}
],
"responses": {
"200": {
"description": "Successfully retrieved diff",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotFileDiff"
},
"description": "Successfully retrieved diff"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get the file changes (diff) that resulted from a specific user message in the session.",
"summary": "Get message diff",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.diff({\n ...\n})"
}
]
}
},
"/session/{sessionID}/message": {
"get": {
"tags": ["session"],
"operationId": "session.messages",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"required": false
},
{
"name": "before",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of messages",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"info": {
"$ref": "#/components/schemas/Message"
},
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Part"
}
}
},
"required": ["info", "parts"],
"additionalProperties": false
},
"description": "List of messages"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Retrieve all messages in a session, including user prompts and AI responses.",
"summary": "Get session messages",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.messages({\n ...\n})"
}
]
},
"post": {
"tags": ["session"],
"operationId": "session.prompt",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Created message",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["info", "parts"],
"properties": {
"info": {
"$ref": "#/components/schemas/AssistantMessage"
},
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Part"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Create and send a new message to a session, streaming the AI response.",
"summary": "Send message",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"model": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
}
},
"required": ["providerID", "modelID"],
"additionalProperties": false
},
"agent": {
"type": "string"
},
"noReply": {
"type": "boolean"
},
"tools": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"format": {
"$ref": "#/components/schemas/OutputFormat"
},
"system": {
"type": "string"
},
"variant": {
"type": "string"
},
"snapshotInitialization": {
"type": "string",
"enum": ["wait"]
},
"editorContext": {
"type": "object",
"properties": {
"visibleFiles": {
"type": "array",
"items": {
"type": "string"
}
},
"openTabs": {
"type": "array",
"items": {
"type": "string"
}
},
"activeFile": {
"type": "string"
},
"shell": {
"type": "string"
}
},
"additionalProperties": false
},
"parts": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TextPartInput"
},
{
"$ref": "#/components/schemas/FilePartInput"
},
{
"$ref": "#/components/schemas/AgentPartInput"
},
{
"$ref": "#/components/schemas/SubtaskPartInput"
}
]
}
}
},
"required": ["parts"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.prompt({\n ...\n})"
}
]
}
},
"/session/{sessionID}/message/{messageID}": {
"get": {
"tags": ["session"],
"operationId": "session.message",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "messageID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^msg.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Message",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"info": {
"$ref": "#/components/schemas/Message"
},
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Part"
}
}
},
"required": ["info", "parts"],
"additionalProperties": false,
"description": "Message"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Retrieve a specific message from a session by its message ID.",
"summary": "Get message",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.message({\n ...\n})"
}
]
},
"delete": {
"tags": ["session"],
"operationId": "session.deleteMessage",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "messageID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^msg.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Successfully deleted message",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Successfully deleted message"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
},
"409": {
"description": "SessionBusyError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionBusyError"
}
}
}
}
},
"description": "Permanently delete a specific message and all of its parts from a session without reverting file changes.",
"summary": "Delete message",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.deleteMessage({\n ...\n})"
}
]
}
},
"/session/{sessionID}/fork": {
"post": {
"tags": ["session"],
"operationId": "session.fork",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Session5"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Create a new session by forking an existing session at a specific message point.",
"summary": "Fork session",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
}
},
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.fork({\n ...\n})"
}
]
}
},
"/session/{sessionID}/abort": {
"post": {
"tags": ["session"],
"operationId": "session.abort",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Aborted session",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Aborted session"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Abort an active session and stop any ongoing AI processing or command execution.",
"summary": "Abort session",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.abort({\n ...\n})"
}
]
}
},
"/session/{sessionID}/init": {
"post": {
"tags": ["session"],
"operationId": "session.init",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "200"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Analyze the current application and create an AGENTS.md file with project-specific agent configurations.",
"summary": "Initialize session",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"modelID": {
"type": "string"
},
"providerID": {
"type": "string"
},
"messageID": {
"type": "string",
"pattern": "^msg"
}
},
"required": ["modelID", "providerID", "messageID"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.init({\n ...\n})"
}
]
}
},
"/session/{sessionID}/share": {
"post": {
"tags": ["session"],
"operationId": "session.share",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Successfully shared session",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Session6"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/effect_HttpApiError_InternalServerError"
}
}
}
}
},
"description": "Create a shareable link for a session, allowing others to view the conversation.",
"summary": "Share session",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.share({\n ...\n})"
}
]
},
"delete": {
"tags": ["session"],
"operationId": "session.unshare",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Successfully unshared session",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Session7"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/effect_HttpApiError_InternalServerError"
}
}
}
}
},
"description": "Remove the shareable link for a session, making it private again.",
"summary": "Unshare session",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.unshare({\n ...\n})"
}
]
}
},
"/session/{sessionID}/summarize": {
"post": {
"tags": ["session"],
"operationId": "session.summarize",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Summarized session",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Summarized session"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Generate a concise summary of the session using AI compaction to preserve key information.",
"summary": "Summarize session",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
},
"auto": {
"type": "boolean"
}
},
"required": ["providerID", "modelID"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.summarize({\n ...\n})"
}
]
}
},
"/session/{sessionID}/prompt_async": {
"post": {
"tags": ["session"],
"operationId": "session.prompt_async",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"204": {
"description": "Prompt accepted"
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Create and send a new message to a session asynchronously, starting the session if needed and returning immediately.",
"summary": "Send async message",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"model": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
}
},
"required": ["providerID", "modelID"],
"additionalProperties": false
},
"agent": {
"type": "string"
},
"noReply": {
"type": "boolean"
},
"tools": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"format": {
"$ref": "#/components/schemas/OutputFormat"
},
"system": {
"type": "string"
},
"variant": {
"type": "string"
},
"snapshotInitialization": {
"type": "string",
"enum": ["wait"]
},
"editorContext": {
"type": "object",
"properties": {
"visibleFiles": {
"type": "array",
"items": {
"type": "string"
}
},
"openTabs": {
"type": "array",
"items": {
"type": "string"
}
},
"activeFile": {
"type": "string"
},
"shell": {
"type": "string"
}
},
"additionalProperties": false
},
"parts": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TextPartInput"
},
{
"$ref": "#/components/schemas/FilePartInput"
},
{
"$ref": "#/components/schemas/AgentPartInput"
},
{
"$ref": "#/components/schemas/SubtaskPartInput"
}
]
}
}
},
"required": ["parts"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.prompt_async({\n ...\n})"
}
]
}
},
"/session/{sessionID}/command": {
"post": {
"tags": ["session"],
"operationId": "session.command",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Created message",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["info", "parts"],
"properties": {
"info": {
"$ref": "#/components/schemas/AssistantMessage"
},
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Part"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Send a new command to a session for execution by the AI assistant.",
"summary": "Send command",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"agent": {
"type": "string"
},
"model": {
"type": "string"
},
"arguments": {
"type": "string"
},
"command": {
"type": "string"
},
"variant": {
"type": "string"
},
"snapshotInitialization": {
"type": "string",
"enum": ["wait"]
},
"parts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"type": {
"type": "string",
"enum": ["file"]
},
"mime": {
"type": "string"
},
"filename": {
"type": "string"
},
"url": {
"type": "string"
},
"source": {
"$ref": "#/components/schemas/FilePartSource"
}
},
"required": ["type", "mime", "url"],
"additionalProperties": false
}
}
},
"required": ["arguments", "command"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.command({\n ...\n})"
}
]
}
},
"/session/{sessionID}/shell": {
"post": {
"tags": ["session"],
"operationId": "session.shell",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Created message",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"info": {
"$ref": "#/components/schemas/Message"
},
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Part"
}
}
},
"required": ["info", "parts"],
"additionalProperties": false,
"description": "Created message"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
},
"409": {
"description": "SessionBusyError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionBusyError"
}
}
}
}
},
"description": "Execute a shell command within the session context and return the AI's response.",
"summary": "Run shell command",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
}
},
"required": ["providerID", "modelID"],
"additionalProperties": false
},
"command": {
"type": "string"
}
},
"required": ["agent", "command"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.shell({\n ...\n})"
}
]
}
},
"/session/{sessionID}/revert": {
"post": {
"tags": ["session"],
"operationId": "session.revert",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Updated session",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Session8"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
},
"409": {
"description": "SessionBusyError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionBusyError"
}
}
}
}
},
"description": "Revert a specific message in a session, undoing its effects and restoring the previous state.",
"summary": "Revert message",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
}
},
"required": ["messageID"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.revert({\n ...\n})"
}
]
}
},
"/session/{sessionID}/unrevert": {
"post": {
"tags": ["session"],
"operationId": "session.unrevert",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Updated session",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Session9"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
},
"409": {
"description": "SessionBusyError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionBusyError"
}
}
}
}
},
"description": "Restore all previously reverted messages in a session.",
"summary": "Restore reverted messages",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.unrevert({\n ...\n})"
}
]
}
},
"/session/{sessionID}/permissions/{permissionID}": {
"post": {
"tags": ["session"],
"operationId": "permission.respond",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "permissionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^per.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Permission processed successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Permission processed successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError | PermissionNotFoundError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/NotFoundError"
},
{
"$ref": "#/components/schemas/PermissionNotFoundError"
}
]
}
}
}
}
},
"description": "Approve or deny a permission request from the AI assistant.",
"summary": "Respond to permission",
"deprecated": true,
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "string",
"enum": ["once", "always", "reject"]
}
},
"required": ["response"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.permission.respond({\n ...\n})"
}
]
}
},
"/session/{sessionID}/message/{messageID}/part/{partID}": {
"delete": {
"tags": ["session"],
"operationId": "part.delete",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "messageID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^msg.*"
},
"required": true
},
{
"name": "partID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^prt.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Successfully deleted part",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Successfully deleted part"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Delete a part from a message.",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.part.delete({\n ...\n})"
}
]
},
"patch": {
"tags": ["session"],
"operationId": "part.update",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "messageID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^msg.*"
},
"required": true
},
{
"name": "partID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^prt.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Successfully updated part",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Part"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Update a part in a message.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Part"
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.part.update({\n ...\n})"
}
]
}
},
"/session/viewed": {
"post": {
"tags": ["session"],
"operationId": "session.viewed",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Viewed sessions updated",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Viewed sessions updated"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Notify the server which sessions the user is currently viewing, or clear all.",
"summary": "Set viewed sessions",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"viewer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$",
"format": "uuid"
},
"active": {
"type": "boolean"
}
},
"required": ["id", "active"],
"additionalProperties": false
},
"attached": {
"type": "array",
"items": {
"type": "string",
"pattern": "^ses",
"maxLength": 234
},
"maxItems": 1000
},
"visible": {
"type": "array",
"items": {
"type": "string",
"pattern": "^ses",
"maxLength": 234
},
"maxItems": 199
}
},
"required": ["viewer", "attached", "visible"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.session.viewed({\n ...\n})"
}
]
}
},
"/sync/start": {
"post": {
"tags": ["sync"],
"operationId": "sync.start",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Workspace sync started",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Workspace sync started"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Start sync loops for workspaces in the current project that have active sessions.",
"summary": "Start workspace sync",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.sync.start({\n ...\n})"
}
]
}
},
"/sync/replay": {
"post": {
"tags": ["sync"],
"operationId": "sync.replay",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Replayed sync events",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sessionID": {
"type": "string"
}
},
"required": ["sessionID"],
"additionalProperties": false,
"description": "Replayed sync events"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Validate and replay a complete sync event history.",
"summary": "Replay sync events",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"events": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^evt_"
},
"aggregateID": {
"type": "string"
},
"seq": {
"type": "integer",
"minimum": 0
},
"type": {
"type": "string"
},
"data": {
"type": "object"
}
},
"required": ["id", "aggregateID", "seq", "type", "data"],
"additionalProperties": false
}
}
},
"required": ["directory", "events"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.sync.replay({\n ...\n})"
}
]
}
},
"/sync/steal": {
"post": {
"tags": ["sync"],
"operationId": "sync.steal",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Session stolen into workspace",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
}
},
"required": ["sessionID"],
"additionalProperties": false,
"description": "Session stolen into workspace"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Update a session to belong to the current workspace through the sync event system.",
"summary": "Steal session into workspace",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
}
},
"required": ["sessionID"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.sync.steal({\n ...\n})"
}
]
}
},
"/sync/history": {
"post": {
"tags": ["sync"],
"operationId": "sync.history.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Sync events",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^evt_"
},
"aggregate_id": {
"type": "string"
},
"seq": {
"type": "integer",
"minimum": 0
},
"type": {
"type": "string"
},
"data": {
"type": "object"
}
},
"required": ["id", "aggregate_id", "seq", "type", "data"],
"additionalProperties": false
},
"description": "Sync events"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "List sync events for all aggregates. Keys are aggregate IDs the client already knows about, values are the last known sequence ID. Events with seq > value are returned for those aggregates. Aggregates not listed in the input get their full history.",
"summary": "List sync events",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "integer",
"minimum": 0
}
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.sync.history.list({\n ...\n})"
}
]
}
},
"/tui/append-prompt": {
"post": {
"tags": ["tui"],
"operationId": "tui.appendPrompt",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Prompt processed successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Prompt processed successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Append prompt to the TUI.",
"summary": "Append TUI prompt",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"required": ["text"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.appendPrompt({\n ...\n})"
}
]
}
},
"/tui/open-help": {
"post": {
"tags": ["tui"],
"operationId": "tui.openHelp",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Help dialog opened successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Help dialog opened successfully"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Open the help dialog in the TUI to display user assistance information.",
"summary": "Open help dialog",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.openHelp({\n ...\n})"
}
]
}
},
"/tui/open-sessions": {
"post": {
"tags": ["tui"],
"operationId": "tui.openSessions",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Session dialog opened successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Session dialog opened successfully"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Open the session dialog.",
"summary": "Open sessions dialog",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.openSessions({\n ...\n})"
}
]
}
},
"/tui/open-themes": {
"post": {
"tags": ["tui"],
"operationId": "tui.openThemes",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Theme dialog opened successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Theme dialog opened successfully"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Open the theme dialog.",
"summary": "Open themes dialog",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.openThemes({\n ...\n})"
}
]
}
},
"/tui/open-models": {
"post": {
"tags": ["tui"],
"operationId": "tui.openModels",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Model dialog opened successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Model dialog opened successfully"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Open the model dialog.",
"summary": "Open models dialog",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.openModels({\n ...\n})"
}
]
}
},
"/tui/submit-prompt": {
"post": {
"tags": ["tui"],
"operationId": "tui.submitPrompt",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Prompt submitted successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Prompt submitted successfully"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Submit the prompt.",
"summary": "Submit TUI prompt",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.submitPrompt({\n ...\n})"
}
]
}
},
"/tui/clear-prompt": {
"post": {
"tags": ["tui"],
"operationId": "tui.clearPrompt",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Prompt cleared successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Prompt cleared successfully"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Clear the prompt.",
"summary": "Clear TUI prompt",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.clearPrompt({\n ...\n})"
}
]
}
},
"/tui/execute-command": {
"post": {
"tags": ["tui"],
"operationId": "tui.executeCommand",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Command executed successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Command executed successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Execute a TUI command.",
"summary": "Execute TUI command",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"command": {
"type": "string"
}
},
"required": ["command"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.executeCommand({\n ...\n})"
}
]
}
},
"/tui/show-toast": {
"post": {
"tags": ["tui"],
"operationId": "tui.showToast",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Toast notification shown successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Toast notification shown successfully"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Show a toast notification in the TUI.",
"summary": "Show TUI toast",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"message": {
"type": "string"
},
"variant": {
"type": "string",
"enum": ["info", "success", "warning", "error"]
},
"duration": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"required": ["message", "variant"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.showToast({\n ...\n})"
}
]
}
},
"/tui/publish": {
"post": {
"tags": ["tui"],
"operationId": "tui.publish",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Event published successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Event published successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Publish a TUI event.",
"summary": "Publish TUI event",
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/EventTuiPromptAppend"
},
{
"$ref": "#/components/schemas/EventTuiCommandExecute"
},
{
"$ref": "#/components/schemas/EventTuiToastShow"
},
{
"$ref": "#/components/schemas/EventTuiSessionSelect"
}
]
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.publish({\n ...\n})"
}
]
}
},
"/tui/select-session": {
"post": {
"tags": ["tui"],
"operationId": "tui.selectSession",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Session selected successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Session selected successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Navigate the TUI to display the specified session.",
"summary": "Select session",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses",
"description": "Session ID to navigate to"
}
},
"required": ["sessionID"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.selectSession({\n ...\n})"
}
]
}
},
"/tui/control/next": {
"get": {
"tags": ["tui"],
"operationId": "tui.control.next",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Next TUI request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"body": {}
},
"required": ["path", "body"],
"additionalProperties": false,
"description": "Next TUI request"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve the next TUI request from the queue for processing.",
"summary": "Get next TUI request",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.control.next({\n ...\n})"
}
]
}
},
"/tui/control/response": {
"post": {
"tags": ["tui"],
"operationId": "tui.control.response",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Response submitted successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Response submitted successfully"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Submit a response to the TUI request queue to complete a pending request.",
"summary": "Submit TUI response",
"requestBody": {
"content": {
"application/json": {
"schema": {}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.control.response({\n ...\n})"
}
]
}
},
"/experimental/workspace/adapter": {
"get": {
"tags": ["workspace"],
"operationId": "experimental.workspace.adapter.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Workspace adapters",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": ["type", "name", "description"],
"additionalProperties": false
},
"description": "Workspace adapters"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "List all available workspace adapters for the current project.",
"summary": "List workspace adapters",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.workspace.adapter.list({\n ...\n})"
}
]
}
},
"/experimental/workspace": {
"get": {
"tags": ["workspace"],
"operationId": "experimental.workspace.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Workspaces",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Workspace"
},
"description": "Workspaces"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "List all workspaces.",
"summary": "List workspaces",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.workspace.list({\n ...\n})"
}
]
},
"post": {
"tags": ["workspace"],
"operationId": "experimental.workspace.create",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Workspace created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Workspace"
}
}
}
},
"400": {
"description": "WorkspaceCreateError | BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkspaceCreateError"
},
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Create a workspace for the current project.",
"summary": "Create workspace",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^wrk"
},
"type": {
"type": "string"
},
"branch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"extra": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"required": ["type"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.workspace.create({\n ...\n})"
}
]
}
},
"/experimental/workspace/sync-list": {
"post": {
"tags": ["workspace"],
"operationId": "experimental.workspace.syncList",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"204": {
"description": "Workspace list synced"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Register missing workspaces returned by workspace adapters.",
"summary": "Sync workspace list",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.workspace.syncList({\n ...\n})"
}
]
}
},
"/experimental/workspace/status": {
"get": {
"tags": ["workspace"],
"operationId": "experimental.workspace.status",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Workspace status",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"status": {
"type": "string",
"enum": ["connected", "connecting", "disconnected", "error"]
}
},
"required": ["workspaceID", "status"],
"additionalProperties": false
},
"description": "Workspace status"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get connection status for workspaces in the current project.",
"summary": "Workspace status",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.workspace.status({\n ...\n})"
}
]
}
},
"/experimental/workspace/{id}": {
"delete": {
"tags": ["workspace"],
"operationId": "experimental.workspace.remove",
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"type": "string",
"pattern": "^wrk.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Workspace removed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Workspace"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Remove an existing workspace.",
"summary": "Remove workspace",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.workspace.remove({\n ...\n})"
}
]
}
},
"/experimental/workspace/warp": {
"post": {
"tags": ["workspace"],
"operationId": "experimental.workspace.warp",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"204": {
"description": "Session warped"
},
"400": {
"description": "WorkspaceWarpError | VcsApplyError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkspaceWarpError"
},
{
"$ref": "#/components/schemas/VcsApplyError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Move a session's sync history into the target workspace, or detach it to the local project.",
"summary": "Warp session into workspace",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"pattern": "^wrk"
},
{
"type": "null"
}
]
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"copyChanges": {
"type": "boolean"
}
},
"required": ["id", "sessionID"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.experimental.workspace.warp({\n ...\n})"
}
]
}
},
"/agent-builder/preview": {
"post": {
"tags": ["agent-builder"],
"operationId": "agentBuilder.preview",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Agent markdown preview",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
},
"scope": {
"type": "string",
"enum": ["global", "project"]
},
"path": {
"type": "string"
},
"markdown": {
"type": "string"
}
},
"required": ["id", "scope", "path", "markdown"],
"additionalProperties": false,
"description": "Agent markdown preview"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Validate an agent builder payload and return the canonical agent markdown without writing it.",
"summary": "Preview agent markdown",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
},
"scope": {
"type": "string",
"enum": ["global", "project"]
},
"description": {
"type": "string"
},
"mode": {
"type": "string",
"enum": ["primary", "subagent", "all"]
},
"model": {
"type": "string"
},
"color": {
"type": "string"
},
"steps": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"tools": {
"type": "array",
"items": {
"type": "string"
}
},
"permission": {
"type": "object"
},
"prompt": {
"type": "string",
"pattern": "\\S"
}
},
"required": ["id", "prompt"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.agentBuilder.preview({\n ...\n})"
}
]
}
},
"/agent-builder/{id}": {
"put": {
"tags": ["agent-builder"],
"operationId": "agentBuilder.save",
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Saved agent markdown",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
},
"scope": {
"type": "string",
"enum": ["global", "project"]
},
"path": {
"type": "string"
},
"markdown": {
"type": "string"
}
},
"required": ["id", "scope", "path", "markdown"],
"additionalProperties": false,
"description": "Saved agent markdown"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Save an agent builder payload as a canonical agent markdown file.",
"summary": "Save agent markdown",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
},
"scope": {
"type": "string",
"enum": ["global", "project"]
},
"description": {
"type": "string"
},
"mode": {
"type": "string",
"enum": ["primary", "subagent", "all"]
},
"model": {
"type": "string"
},
"color": {
"type": "string"
},
"steps": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"tools": {
"type": "array",
"items": {
"type": "string"
}
},
"permission": {
"type": "object"
},
"prompt": {
"type": "string",
"pattern": "\\S"
}
},
"required": ["prompt"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.agentBuilder.save({\n ...\n})"
}
]
}
},
"/background-process": {
"get": {
"tags": ["background-process"],
"operationId": "backgroundProcess.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of background processes",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackgroundProcessInfo"
},
"description": "List of background processes"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "List tracked background processes for the current instance.",
"summary": "List background processes",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.backgroundProcess.list({\n ...\n})"
}
]
}
},
"/background-process/{processID}": {
"get": {
"tags": ["background-process"],
"operationId": "backgroundProcess.get",
"parameters": [
{
"name": "processID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^bgp.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Background process info",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackgroundProcessInfo"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Get status and retained output for one background process.",
"summary": "Get background process",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.backgroundProcess.get({\n ...\n})"
}
]
}
},
"/background-process/{processID}/logs": {
"get": {
"tags": ["background-process"],
"operationId": "backgroundProcess.logs",
"parameters": [
{
"name": "processID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^bgp.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Background process logs",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackgroundProcessLogs"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Get the retained output tail for one background process.",
"summary": "Get background process logs",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.backgroundProcess.logs({\n ...\n})"
}
]
}
},
"/background-process/{processID}/stop": {
"post": {
"tags": ["background-process"],
"operationId": "backgroundProcess.stop",
"parameters": [
{
"name": "processID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^bgp.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Stopped background process",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackgroundProcessInfo"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Terminate a background process and its child process tree.",
"summary": "Stop background process",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.backgroundProcess.stop({\n ...\n})"
}
]
}
},
"/background-process/{processID}/restart": {
"post": {
"tags": ["background-process"],
"operationId": "backgroundProcess.restart",
"parameters": [
{
"name": "processID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^bgp.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Restarted background process",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackgroundProcessInfo"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Stop and restart a background process with its original command.",
"summary": "Restart background process",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.backgroundProcess.restart({\n ...\n})"
}
]
}
},
"/background-process/session/{sessionID}/stop": {
"post": {
"tags": ["background-process"],
"operationId": "backgroundProcess.stopSession",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Stopped session background processes",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Stopped session background processes"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Terminate and forget all background processes associated with one session.",
"summary": "Stop session background processes",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.backgroundProcess.stopSession({\n ...\n})"
}
]
}
},
"/session/{sessionID}/branch-name": {
"post": {
"tags": ["branch-name"],
"operationId": "branchName.generate",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Generated branch name or null when the task is not clear yet",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"branch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": ["branch"],
"additionalProperties": false,
"description": "Generated branch name or null when the task is not clear yet"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Generate a task-focused branch name from the current conversation.",
"summary": "Generate branch name",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"prompt": {
"type": "string"
},
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
}
},
"required": ["prompt"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.branchName.generate({\n ...\n})"
}
]
}
},
"/commit-message": {
"post": {
"tags": ["commit-message"],
"operationId": "commitMessage.generate",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Generated commit message",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": ["message"],
"additionalProperties": false,
"description": "Generated commit message"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"422": {
"description": "CommitMessageNoChangesError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommitMessageNoChangesError"
}
}
}
}
},
"description": "Generate a commit message using AI based on the current git diff.",
"summary": "Generate commit message",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Workspace/repo path"
},
"selectedFiles": {
"type": "array",
"items": {
"type": "string"
}
},
"previousMessage": {
"type": "string"
},
"language": {
"type": "string"
}
},
"required": ["path"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.commitMessage.generate({\n ...\n})"
}
]
}
},
"/config/overlay": {
"get": {
"tags": ["config-console"],
"operationId": "config.overlay",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "scope",
"in": "query",
"schema": {
"type": "string",
"enum": ["global", "project"],
"default": "project"
},
"required": false
}
],
"responses": {
"200": {
"description": "Resolved config overlay",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigOverlayResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Resolve global, project, and effective config values with source metadata for inheritance-aware settings UI.",
"summary": "Get config overlay",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.config.overlay({\n ...\n})"
}
]
},
"patch": {
"tags": ["config-console"],
"operationId": "config.overlayUpdate",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Effective configuration after patch",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Config"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Apply a minimal global or project config patch, including unset paths for reverting local overrides.",
"summary": "Patch config overlay",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": ["global", "project"],
"default": "project"
},
"set": {
"type": "object"
},
"unset": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.config.overlayUpdate({\n ...\n})"
}
]
}
},
"/config/sources": {
"get": {
"tags": ["config-console"],
"operationId": "config.sources",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Config source inventory",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigSourcesResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "List config source metadata in load order without exposing config contents or secrets.",
"summary": "List config sources",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.config.sources({\n ...\n})"
}
]
}
},
"/config/effective": {
"get": {
"tags": ["config-console"],
"operationId": "config.effective",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Effective config info",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Config"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve effective config for the current instance directory.",
"summary": "Get effective configuration",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.config.effective({\n ...\n})"
}
]
}
},
"/config/rules": {
"get": {
"tags": ["config-console"],
"operationId": "config.rules",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "scope",
"in": "query",
"schema": {
"const": "project",
"default": "project",
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Project rules",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigRulesResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "List project instruction files used by Kilo and return their current contents.",
"summary": "Get project rules",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.config.rules({\n ...\n})"
}
]
},
"put": {
"tags": ["config-console"],
"operationId": "config.rulesUpdate",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Project rules after update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigRulesResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Create or update the project AGENTS.md rules file.",
"summary": "Update project rules",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": ["project"],
"default": "project"
},
"content": {
"type": "string"
}
},
"required": ["content"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.config.rulesUpdate({\n ...\n})"
}
]
}
},
"/config/model-state": {
"get": {
"tags": ["config-console"],
"operationId": "config.modelState",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Model state",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigModelStateResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve TUI-compatible recent and favorite model selections.",
"summary": "Get model state",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.config.modelState({\n ...\n})"
}
]
},
"patch": {
"tags": ["config-console"],
"operationId": "config.modelStateUpdate",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Updated model state",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigModelStateResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Patch TUI-compatible model selections shared with Kilo Console.",
"summary": "Update model state",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"favorite": {
"type": "array",
"items": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
}
},
"required": ["providerID", "modelID"],
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.config.modelStateUpdate({\n ...\n})"
}
]
}
},
"/tui/config": {
"get": {
"tags": ["config-console"],
"operationId": "tui.config.get",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Effective TUI configuration",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TuiConfigGetResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve the effective TUI configuration for the current instance directory.",
"summary": "Get TUI configuration",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.config.get({\n ...\n})"
}
]
},
"patch": {
"tags": ["config-console"],
"operationId": "tui.config.update",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "scope",
"in": "query",
"schema": {
"type": "string",
"enum": ["project", "global"],
"default": "project"
},
"required": false
}
],
"responses": {
"200": {
"description": "Effective TUI configuration after the update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TuiConfigGetResponse"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Patch global or project TUI configuration and return the effective TUI configuration.",
"summary": "Update TUI configuration",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"$schema": {
"type": "string"
},
"theme": {
"type": "string"
},
"keybinds": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"plugin": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"prefixItems": [
{
"type": "string"
},
{
"type": "object"
}
],
"maxItems": 2,
"minItems": 2
}
]
}
},
"plugin_enabled": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"title_icon": {
"type": "string",
"enum": ["none", "unicode", "emojis"],
"description": "Status icon style shown in terminal titles"
},
"scroll_speed": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"scroll_acceleration": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": ["enabled"],
"additionalProperties": false
},
"diff_style": {
"type": "string",
"enum": ["auto", "stacked"]
},
"mouse": {
"type": "boolean"
},
"attention": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"notifications": {
"type": "boolean"
},
"sound": {
"type": "boolean"
},
"volume": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.config.update({\n ...\n})"
}
]
}
},
"/tui/keybinds": {
"get": {
"tags": ["config-console"],
"operationId": "tui.keybind.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "TUI keybind metadata",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TuiKeybindListResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "List valid TUI keybind commands, descriptions, groups, and default bindings from the CLI schema.",
"summary": "List TUI keybinds",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.tui.keybind.list({\n ...\n})"
}
]
}
},
"/enhance-prompt": {
"post": {
"tags": ["enhance-prompt"],
"operationId": "enhancePrompt.enhance",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Enhanced prompt text",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"required": ["text"],
"additionalProperties": false,
"description": "Enhanced prompt text"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Rewrite a user's draft prompt into a clearer, more specific, and more effective prompt.",
"summary": "Enhance prompt",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"text": {
"type": "string",
"minLength": 1,
"description": "The user's draft prompt to enhance"
}
},
"required": ["text"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.enhancePrompt.enhance({\n ...\n})"
}
]
}
},
"/indexing/status": {
"get": {
"tags": ["indexing"],
"operationId": "indexing.status",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Indexing status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexingStatus"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve the current code indexing status for the active project.",
"summary": "Get indexing status",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.indexing.status({\n ...\n})"
}
]
}
},
"/indexing/warnings": {
"get": {
"tags": ["indexing"],
"operationId": "indexing.warnings",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Indexing warnings",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexingWarning"
},
"description": "Indexing warnings"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve code indexing warnings for the active project.",
"summary": "Get indexing warnings",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.indexing.warnings({\n ...\n})"
}
]
}
},
"/indexing/models": {
"get": {
"tags": ["indexing"],
"operationId": "indexing.models",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Kilo embedding model catalog",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KiloEmbeddingModelCatalog"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Retrieve the embedding models available through the active Kilo account.",
"summary": "List Kilo embedding models",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.indexing.models({\n ...\n})"
}
]
}
},
"/instance/reload": {
"post": {
"tags": ["instance-reload"],
"operationId": "instance.reload",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Instance reloaded",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Instance reloaded"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"409": {
"description": "ConflictError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictError"
}
}
}
}
},
"description": "Atomically dispose and reboot the current Kilo instance, reloading config, skills, agents, commands, and MCP prompts from disk. Returns 409 if a session is actively running.",
"summary": "Reload instance",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.instance.reload({\n ...\n})"
}
]
}
},
"/interactive-terminal": {
"get": {
"tags": ["interactive-terminal"],
"operationId": "interactiveTerminal.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of interactive terminals",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InteractiveTerminalSnapshot"
},
"description": "List of interactive terminals"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "List active human-driven terminal sessions for the current instance.",
"summary": "List interactive terminals",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.interactiveTerminal.list({\n ...\n})"
}
]
}
},
"/interactive-terminal/{terminalID}": {
"get": {
"tags": ["interactive-terminal"],
"operationId": "interactiveTerminal.get",
"parameters": [
{
"name": "terminalID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Interactive terminal snapshot",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InteractiveTerminalSnapshot"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Get metadata and retained output for an active interactive terminal.",
"summary": "Get interactive terminal",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.interactiveTerminal.get({\n ...\n})"
}
]
}
},
"/interactive-terminal/{terminalID}/input": {
"post": {
"tags": ["interactive-terminal"],
"operationId": "interactiveTerminal.write",
"parameters": [
{
"name": "terminalID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Input written",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Input written"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Send raw keyboard input to an active interactive terminal.",
"summary": "Write interactive terminal input",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InteractiveTerminalWriteInput"
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.interactiveTerminal.write({\n ...\n})"
}
]
}
},
"/interactive-terminal/{terminalID}/resize": {
"post": {
"tags": ["interactive-terminal"],
"operationId": "interactiveTerminal.resize",
"parameters": [
{
"name": "terminalID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Terminal resized",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Terminal resized"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Resize an active interactive terminal's PTY.",
"summary": "Resize interactive terminal",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InteractiveTerminalResizeInput"
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.interactiveTerminal.resize({\n ...\n})"
}
]
}
},
"/interactive-terminal/{terminalID}/close": {
"post": {
"tags": ["interactive-terminal"],
"operationId": "interactiveTerminal.close",
"parameters": [
{
"name": "terminalID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Terminal closed",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Terminal closed"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Terminate an active interactive terminal and unblock its tool call.",
"summary": "Close interactive terminal",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.interactiveTerminal.close({\n ...\n})"
}
]
}
},
"/kilo/profile": {
"get": {
"tags": ["kilo"],
"operationId": "kilo.profile",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Profile data",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"profile": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"organizations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
}
},
"required": ["id", "name", "role"],
"additionalProperties": false
}
},
"selectedOrganizationId": {
"type": "string"
},
"hasPersonalAccount": {
"type": "boolean"
}
},
"required": ["email"],
"additionalProperties": false
},
"balance": {
"anyOf": [
{
"type": "object",
"properties": {
"balance": {
"type": "number"
}
},
"required": ["balance"],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"kiloPass": {
"anyOf": [
{
"type": "object",
"properties": {
"currentPeriodBaseCreditsUsd": {
"type": "number"
},
"currentPeriodUsageUsd": {
"type": "number"
},
"currentPeriodBonusCreditsUsd": {
"type": "number"
},
"nextBillingAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"currentPeriodBaseCreditsUsd",
"currentPeriodUsageUsd",
"currentPeriodBonusCreditsUsd"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"currentOrgId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": ["profile", "balance", "kiloPass", "currentOrgId"],
"additionalProperties": false,
"description": "Profile data"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Fetch user profile and organizations from Kilo Gateway",
"summary": "Get Kilo Gateway profile",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilo.profile({\n ...\n})"
}
]
}
},
"/kilo/auth-status": {
"get": {
"tags": ["kilo"],
"operationId": "kilo.authStatus",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Kilo authentication status",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"authenticated": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": ["api", "oauth"]
}
},
"required": ["authenticated"],
"additionalProperties": false,
"description": "Kilo authentication status"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Check whether a locally stored Kilo credential can authenticate Gateway requests",
"summary": "Get Kilo authentication status",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilo.authStatus({\n ...\n})"
}
]
}
},
"/kilo/modes": {
"get": {
"tags": ["kilo"],
"operationId": "kilo.modes",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Organization modes list",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"modes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"organization_id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"created_by": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"config": {
"type": "object",
"properties": {
"roleDefinition": {
"type": "string"
},
"whenToUse": {
"type": "string"
},
"description": {
"type": "string"
},
"customInstructions": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"prefixItems": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"fileRegex": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
],
"maxItems": 2,
"minItems": 2
}
]
}
}
},
"additionalProperties": false
}
},
"required": [
"id",
"organization_id",
"name",
"slug",
"created_by",
"created_at",
"updated_at",
"config"
],
"additionalProperties": false
}
}
},
"required": ["modes"],
"additionalProperties": false,
"description": "Organization modes list"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Fetch custom modes defined for the current organization",
"summary": "Get organization custom modes",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilo.modes({\n ...\n})"
}
]
}
},
"/kilo/fim": {
"post": {
"tags": ["kilo"],
"operationId": "kilo.fim",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Streaming FIM completion response",
"content": {
"text/event-stream": {
"schema": {
"type": "object",
"properties": {
"choices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"delta": {
"type": "object",
"properties": {
"content": {
"type": "string"
}
}
},
"text": {
"type": "string"
}
}
}
},
"usage": {
"type": "object",
"properties": {
"prompt_tokens": {
"type": "number"
},
"completion_tokens": {
"type": "number"
}
}
},
"cost": {
"type": "number"
}
}
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Proxy a Fill-in-the-Middle completion request to the Kilo Gateway",
"summary": "FIM completion",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
},
"provider": {
"type": "string"
},
"model": {
"type": "string"
},
"maxTokens": {
"type": "number"
},
"temperature": {
"type": "number"
}
},
"required": ["prefix", "suffix"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilo.fim({\n ...\n})"
}
]
}
},
"/kilo/edit": {
"post": {
"tags": ["kilo"],
"operationId": "kilo.edit",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Next Edit completion",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"prompt_tokens": {
"type": "number"
},
"completion_tokens": {
"type": "number"
}
},
"additionalProperties": false
}
},
"required": ["content"],
"additionalProperties": false,
"description": "Next Edit completion"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Proxy a Mercury-style Next Edit request. The client supplies structured editor context; the gateway assembles the sentinel-tagged prompt and forwards to the upstream edit endpoint.",
"summary": "Next Edit completion",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"model": {
"type": "string"
},
"maxTokens": {
"type": "number"
},
"currentFilePath": {
"type": "string"
},
"currentFileContent": {
"type": "string"
},
"cursorLine": {
"type": "number"
},
"cursorCharacter": {
"type": "number"
},
"editableRegionStartLine": {
"type": "number"
},
"editableRegionEndLine": {
"type": "number"
},
"recentlyViewedSnippets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"filepath": {
"type": "string"
},
"content": {
"type": "string"
}
},
"required": ["filepath", "content"],
"additionalProperties": false
}
},
"editDiffHistory": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"currentFilePath",
"currentFileContent",
"cursorLine",
"cursorCharacter",
"editableRegionStartLine",
"editableRegionEndLine",
"recentlyViewedSnippets",
"editDiffHistory"
],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilo.edit({\n ...\n})"
}
]
}
},
"/kilo/audio/transcriptions": {
"post": {
"tags": ["kilo"],
"operationId": "kilo.audio.transcriptions",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Transcription response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"usage": {}
},
"required": ["text"],
"additionalProperties": false,
"description": "Transcription response"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Proxy an audio transcription request to the Kilo Gateway",
"summary": "Speech to text transcription",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"model": {
"type": "string"
},
"input_audio": {
"type": "object",
"properties": {
"data": {
"type": "string"
},
"format": {
"type": "string"
}
},
"required": ["data", "format"],
"additionalProperties": false
},
"language": {
"type": "string"
},
"prompt": {
"type": "string"
},
"temperature": {
"type": "number"
}
},
"required": ["model", "input_audio"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilo.audio.transcriptions({\n ...\n})"
}
]
}
},
"/kilo/models/images": {
"get": {
"tags": ["kilo"],
"operationId": "kilo.models.images",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Image-capable model list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": ["id", "name"],
"additionalProperties": false
},
"description": "Image-capable model list"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "List image-capable models from the Kilo Gateway OpenRouter passthrough",
"summary": "Image generation models",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilo.models.images({\n ...\n})"
}
]
}
},
"/kilo/notifications": {
"get": {
"tags": ["kilo"],
"operationId": "kilo.notifications",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Notifications list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"message": {
"type": "string"
},
"action": {
"type": "object",
"properties": {
"actionText": {
"type": "string"
},
"actionURL": {
"type": "string"
}
},
"required": ["actionText", "actionURL"],
"additionalProperties": false
},
"showIn": {
"type": "array",
"items": {
"type": "string"
}
},
"suggestModelId": {
"type": "string"
}
},
"required": ["id", "title", "message"],
"additionalProperties": false
},
"description": "Notifications list"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Fetch notifications from Kilo Gateway for CLI display",
"summary": "Get Kilo notifications",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilo.notifications({\n ...\n})"
}
]
}
},
"/kilo/organization": {
"post": {
"tags": ["kilo"],
"operationId": "kilo.organization.set",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Organization updated successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Organization updated successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Switch to a different Kilo Gateway organization",
"summary": "Update Kilo Gateway organization",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"organizationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": ["organizationId"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilo.organization.set({\n ...\n})"
}
]
}
},
"/kilo/claw/status": {
"get": {
"tags": ["kilo"],
"operationId": "kilo.claw.status",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Instance status",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"anyOf": [
{
"type": "string",
"enum": [
"provisioned",
"starting",
"restarting",
"recovering",
"running",
"stopped",
"destroying",
"restoring"
]
},
{
"type": "null"
}
]
},
"sandboxId": {
"type": "string"
},
"flyRegion": {
"type": "string"
},
"machineSize": {
"type": "object",
"properties": {
"cpus": {
"type": "number"
},
"memory_mb": {
"type": "number"
}
},
"required": ["cpus", "memory_mb"],
"additionalProperties": false
},
"openclawVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastStartedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastStoppedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"channelCount": {
"type": "number"
},
"secretCount": {
"type": "number"
},
"userId": {
"type": "string"
},
"botName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": ["status"],
"additionalProperties": false,
"description": "Instance status"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"503": {
"description": "ServiceUnavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/effect_HttpApiError_ServiceUnavailable"
}
}
}
}
},
"description": "Fetch the user's KiloClaw instance status via the KiloClaw worker",
"summary": "Get KiloClaw instance status",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilo.claw.status({\n ...\n})"
}
]
}
},
"/kilo/claw/chat-credentials": {
"get": {
"tags": ["kilo"],
"operationId": "kilo.claw.chatCredentials",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Kilo Chat credentials or null",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"token": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"kiloChatUrl": {
"type": "string"
},
"eventServiceUrl": {
"type": "string"
}
},
"required": ["token", "expiresAt", "kiloChatUrl", "eventServiceUrl"],
"additionalProperties": false
},
{
"type": "null"
}
]
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Returns the bearer token and endpoint URLs the client uses to talk to the Kilo Chat worker and the Event Service. The bearer is the user's existing long-lived Kilo JWT — kilo-chat and event-service both verify it directly with NEXTAUTH_SECRET, so no separate token mint is needed.",
"summary": "Get KiloClaw chat credentials",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilo.claw.chatCredentials({\n ...\n})"
}
]
}
},
"/kilo/cloud-sessions": {
"get": {
"tags": ["kilo"],
"operationId": "kilo.cloudSessions",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "number"
},
"required": false
},
{
"name": "gitUrl",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Cloud sessions list",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cliSessions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"session_id": {
"type": "string"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"version": {
"type": "number"
}
},
"required": ["session_id", "title", "created_at", "updated_at", "version"],
"additionalProperties": false
}
},
"nextCursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": ["cliSessions", "nextCursor"],
"additionalProperties": false,
"description": "Cloud sessions list"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Fetch cloud CLI sessions from Kilo API",
"summary": "Get cloud sessions",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilo.cloudSessions({\n ...\n})"
}
]
}
},
"/kilo/cloud/session/{id}": {
"get": {
"tags": ["kilo"],
"operationId": "kilo.cloud.session.get",
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Cloud session data",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"info": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
},
"updated": {
"type": "number"
}
},
"required": ["created", "updated"],
"additionalProperties": false
}
},
"required": ["id", "title", "time"]
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"info": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sessionID": {
"type": "string"
},
"role": {
"type": "string",
"enum": ["user", "assistant"]
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
},
"completed": {
"type": "number"
}
},
"required": ["created"],
"additionalProperties": false
}
},
"required": ["id", "sessionID", "role", "time"]
},
"parts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sessionID": {
"type": "string"
},
"messageID": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": ["id", "sessionID", "messageID", "type"]
}
}
},
"required": ["info", "parts"]
}
}
},
"required": ["info", "messages"],
"additionalProperties": false,
"description": "Cloud session data"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Fetch full session data from the Kilo cloud for preview",
"summary": "Get cloud session",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilo.cloud.session.get({\n ...\n})"
}
]
}
},
"/kilo/cloud/session/import": {
"post": {
"tags": ["kilo"],
"operationId": "kilo.cloud.session.import",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Imported session info",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
},
"updated": {
"type": "number"
}
},
"required": ["created", "updated"],
"additionalProperties": false
}
},
"required": ["id", "title", "time"],
"description": "Imported session info"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Download a cloud-synced session and write it to local storage with fresh IDs.",
"summary": "Import session from cloud",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sessionId": {
"type": "string"
}
},
"required": ["sessionId"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilo.cloud.session.import({\n ...\n})"
}
]
}
},
"/kilocode/heap/snapshot": {
"post": {
"tags": ["kilocode"],
"operationId": "kilocode.heap.snapshot",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Heap snapshot file path",
"content": {
"application/json": {
"schema": {
"type": "string",
"description": "Heap snapshot file path"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Write a heap snapshot for the CLI process to the log directory.",
"summary": "Write heap snapshot",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.heap.snapshot({\n ...\n})"
}
]
}
},
"/kilocode/agent/requirements": {
"get": {
"tags": ["kilocode"],
"operationId": "kilocode.agentRequirements",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "agent",
"in": "query",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Agent requirement status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentRequirementResult"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Check whether the selected agent's requirements are available in the request directory.",
"summary": "Check agent requirements",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.agentRequirements({\n ...\n})"
}
]
}
},
"/kilocode/skill/remove": {
"post": {
"tags": ["kilocode"],
"operationId": "kilocode.removeSkill",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Skill removed",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Skill removed"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Remove a skill by deleting its manifest from disk and clearing it from cache.",
"summary": "Remove a skill",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"location": {
"type": "string"
}
},
"required": ["location"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.removeSkill({\n ...\n})"
}
]
}
},
"/kilocode/agent/remove": {
"post": {
"tags": ["kilocode"],
"operationId": "kilocode.removeAgent",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Agent removed",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Agent removed"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Remove a custom (non-native) agent by deleting its markdown file from disk and refreshing state.",
"summary": "Remove a custom agent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": ["name"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.removeAgent({\n ...\n})"
}
]
}
},
"/kilocode/notebook": {
"get": {
"tags": ["kilocode"],
"operationId": "kilocode.notebook.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Pending notebook host requests",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotebookRequest"
},
"description": "Pending notebook host requests"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "List pending native notebook requests for the routed workspace.",
"summary": "List pending notebook requests",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.notebook.list({\n ...\n})"
}
]
}
},
"/kilocode/notebook/{requestID}/reply": {
"post": {
"tags": ["kilocode"],
"operationId": "kilocode.notebook.reply",
"parameters": [
{
"name": "requestID",
"in": "path",
"schema": {
"$ref": "#/components/schemas/NotebookRequestID"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Notebook reply accepted",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Notebook reply accepted"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Complete a pending native notebook request with a structured result.",
"summary": "Reply to a notebook request",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"$ref": "#/components/schemas/NotebookResult"
}
},
"required": ["result"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.notebook.reply({\n ...\n})"
}
]
}
},
"/kilocode/notebook/{requestID}/reject": {
"post": {
"tags": ["kilocode"],
"operationId": "kilocode.notebook.reject",
"parameters": [
{
"name": "requestID",
"in": "path",
"schema": {
"$ref": "#/components/schemas/NotebookRequestID"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Notebook rejection accepted",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Notebook rejection accepted"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Complete a pending native notebook request with a structured host error.",
"summary": "Reject a notebook request",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/NotebookFailure"
}
},
"required": ["error"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.notebook.reject({\n ...\n})"
}
]
}
},
"/kilocode/agent-manager": {
"get": {
"tags": ["kilocode"],
"operationId": "kilocode.agentManager.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Pending Agent Manager host requests",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentManagerRequest"
},
"description": "Pending Agent Manager host requests"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "List pending native Agent Manager orchestration requests for the routed workspace.",
"summary": "List pending Agent Manager requests",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.agentManager.list({\n ...\n})"
}
]
}
},
"/kilocode/agent-manager/{requestID}/reply": {
"post": {
"tags": ["kilocode"],
"operationId": "kilocode.agentManager.reply",
"parameters": [
{
"name": "requestID",
"in": "path",
"schema": {
"$ref": "#/components/schemas/AgentManagerRequestID"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Agent Manager reply accepted",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Agent Manager reply accepted"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Complete a pending Agent Manager orchestration request with a structured result.",
"summary": "Reply to an Agent Manager request",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"$ref": "#/components/schemas/AgentManagerResult"
}
},
"required": ["result"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.agentManager.reply({\n ...\n})"
}
]
}
},
"/kilocode/agent-manager/{requestID}/reject": {
"post": {
"tags": ["kilocode"],
"operationId": "kilocode.agentManager.reject",
"parameters": [
{
"name": "requestID",
"in": "path",
"schema": {
"$ref": "#/components/schemas/AgentManagerRequestID"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Agent Manager rejection accepted",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Agent Manager rejection accepted"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Complete a pending Agent Manager orchestration request with a structured host error.",
"summary": "Reject an Agent Manager request",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/AgentManagerFailure"
}
},
"required": ["error"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.agentManager.reject({\n ...\n})"
}
]
}
},
"/session/{sessionID}/model-usage": {
"get": {
"tags": ["kilocode"],
"operationId": "kilocode.sessionModelUsage",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Model usage for a session tree",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sessionIDs": {
"type": "array",
"items": {
"type": "string",
"pattern": "^ses"
}
},
"totals": {
"type": "object",
"properties": {
"steps": {
"type": "integer",
"minimum": 0
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "integer",
"minimum": 0
},
"output": {
"type": "integer",
"minimum": 0
},
"reasoning": {
"type": "integer",
"minimum": 0
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "integer",
"minimum": 0
},
"write": {
"type": "integer",
"minimum": 0
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
}
},
"required": ["steps", "cost", "tokens"],
"additionalProperties": false
},
"models": {
"type": "array",
"items": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
},
"steps": {
"type": "integer",
"minimum": 0
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "integer",
"minimum": 0
},
"output": {
"type": "integer",
"minimum": 0
},
"reasoning": {
"type": "integer",
"minimum": 0
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "integer",
"minimum": 0
},
"write": {
"type": "integer",
"minimum": 0
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
}
},
"required": ["providerID", "modelID", "steps", "cost", "tokens"],
"additionalProperties": false
}
}
},
"required": ["sessionIDs", "totals", "models"],
"additionalProperties": false,
"description": "Model usage for a session tree"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Get token usage and direct cost by model for the complete top-level session tree.",
"summary": "Get session model usage",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.sessionModelUsage({\n ...\n})"
}
]
}
},
"/kilocode/anaconda-desktop/status": {
"get": {
"tags": ["anaconda-desktop"],
"operationId": "anacondaDesktop.status",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Anaconda Desktop setup status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnacondaDesktopStatus"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Discover the locally installed Anaconda Desktop and its active inference server.",
"summary": "Get Anaconda Desktop setup status",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.anacondaDesktop.status({\n ...\n})"
}
]
}
},
"/kilocode/anaconda-desktop/open": {
"post": {
"tags": ["anaconda-desktop"],
"operationId": "anacondaDesktop.open",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Anaconda Desktop opened",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"enum": [true],
"description": "Anaconda Desktop opened"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"409": {
"description": "AnacondaDesktopConflictError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnacondaDesktopConflictError"
}
}
}
},
"500": {
"description": "AnacondaDesktopOperationError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnacondaDesktopOperationError"
}
}
}
}
},
"description": "Open the locally installed Anaconda Desktop application.",
"summary": "Open Anaconda Desktop",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.anacondaDesktop.open({\n ...\n})"
}
]
}
},
"/kilocode/anaconda-desktop/sync": {
"post": {
"tags": ["anaconda-desktop"],
"operationId": "anacondaDesktop.sync",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Anaconda Desktop connection synchronized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["ready"]
},
"serverID": {
"type": "string",
"minLength": 1
},
"serverName": {
"type": "string",
"minLength": 1
},
"models": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
}
},
"required": ["id", "name"],
"additionalProperties": false
},
"minItems": 1
},
"context": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"toolcall": {
"type": "string",
"enum": ["supported", "unsupported", "unknown"]
}
},
"required": ["type", "serverID", "models", "context", "toolcall"],
"additionalProperties": false,
"description": "Anaconda Desktop connection synchronized"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"409": {
"description": "AnacondaDesktopConflictError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnacondaDesktopConflictError"
}
}
}
},
"500": {
"description": "AnacondaDesktopOperationError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnacondaDesktopOperationError"
}
}
}
}
},
"description": "Discover the active local inference server and replace Kilo provider authentication metadata.",
"summary": "Synchronize Anaconda Desktop provider",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"acknowledgeToolLimitations": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.anacondaDesktop.sync({\n ...\n})"
}
]
}
},
"/network": {
"get": {
"tags": ["network"],
"operationId": "network.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of pending network reconnect requests",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionNetworkWait"
},
"description": "List of pending network reconnect requests"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get all pending network reconnect requests across all sessions.",
"summary": "List pending network waits",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.network.list({\n ...\n})"
}
]
}
},
"/network/{requestID}/reply": {
"post": {
"tags": ["network"],
"operationId": "network.reply",
"parameters": [
{
"name": "requestID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^que.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Network wait resumed successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Network wait resumed successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Resume a pending session after reconnecting network-dependent services.",
"summary": "Resume after network wait",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.network.reply({\n ...\n})"
}
]
}
},
"/network/{requestID}/reject": {
"post": {
"tags": ["network"],
"operationId": "network.reject",
"parameters": [
{
"name": "requestID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^que.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Network wait rejected successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Network wait rejected successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Stop a pending session instead of resuming after network reconnect.",
"summary": "Reject network resume request",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.network.reject({\n ...\n})"
}
]
}
},
"/remote/enable": {
"post": {
"tags": ["remote"],
"operationId": "remote.enable",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Remote connection enabled",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"connected": {
"type": "boolean"
}
},
"required": ["enabled", "connected"],
"additionalProperties": false,
"description": "Remote connection enabled"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Enable WebSocket connection to UserConnectionDO for real-time session relay and commands.",
"summary": "Enable remote connection",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.remote.enable({\n ...\n})"
}
]
}
},
"/remote/disable": {
"post": {
"tags": ["remote"],
"operationId": "remote.disable",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Remote connection disabled",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"connected": {
"type": "boolean"
}
},
"required": ["enabled", "connected"],
"additionalProperties": false,
"description": "Remote connection disabled"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Close the remote WebSocket connection to UserConnectionDO.",
"summary": "Disable remote connection",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.remote.disable({\n ...\n})"
}
]
}
},
"/remote/status": {
"get": {
"tags": ["remote"],
"operationId": "remote.status",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Remote connection status",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"connected": {
"type": "boolean"
}
},
"required": ["enabled", "connected"],
"additionalProperties": false,
"description": "Remote connection status"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get the current state of the remote WebSocket connection.",
"summary": "Get remote connection status",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.remote.status({\n ...\n})"
}
]
}
},
"/sandbox/support": {
"get": {
"tags": ["sandbox"],
"operationId": "sandbox.support",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Sandbox backend support",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"reason": {
"type": "string"
}
},
"required": ["available"],
"additionalProperties": false,
"description": "Sandbox backend support"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get sandbox backend availability without creating a session.",
"summary": "Get sandbox backend support",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.sandbox.support({\n ...\n})"
}
]
}
},
"/session/{sessionID}/sandbox": {
"get": {
"tags": ["sandbox"],
"operationId": "sandbox.status",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Session sandbox status",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"available": {
"type": "boolean"
},
"reason": {
"type": "string"
},
"version": {
"type": "integer"
}
},
"required": ["directory", "enabled", "available", "version"],
"additionalProperties": false,
"description": "Session sandbox status"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Get the effective sandbox state for one session.",
"summary": "Get session sandbox status",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.sandbox.status({\n ...\n})"
}
]
}
},
"/session/{sessionID}/sandbox/toggle": {
"post": {
"tags": ["sandbox"],
"operationId": "sandbox.toggle",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Updated session sandbox status",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"available": {
"type": "boolean"
},
"reason": {
"type": "string"
},
"version": {
"type": "integer"
}
},
"required": ["directory", "enabled", "available", "version"],
"additionalProperties": false,
"description": "Updated session sandbox status"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Toggle and persist the sandbox state for one session.",
"summary": "Toggle session sandbox",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.sandbox.toggle({\n ...\n})"
}
]
}
},
"/kilocode/session-import/project": {
"post": {
"tags": ["session-import"],
"operationId": "kilocode.sessionImport.project",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Project import result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KilocodeSessionImportResult"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Insert or update a project row used by legacy session import.",
"summary": "Insert project for session import",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"worktree": {
"type": "string"
},
"vcs": {
"type": "string"
},
"name": {
"type": "string"
},
"iconUrl": {
"type": "string"
},
"iconColor": {
"type": "string"
},
"timeCreated": {
"type": "number"
},
"timeUpdated": {
"type": "number"
},
"timeInitialized": {
"type": "number"
},
"sandboxes": {
"type": "array",
"items": {
"type": "string"
}
},
"commands": {
"type": "object",
"properties": {
"start": {
"type": "string"
}
},
"additionalProperties": false
}
},
"required": ["id", "worktree", "timeCreated", "timeUpdated", "sandboxes"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.sessionImport.project({\n ...\n})"
}
]
}
},
"/kilocode/session-import/session": {
"post": {
"tags": ["session-import"],
"operationId": "kilocode.sessionImport.session",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Session import result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KilocodeSessionImportResult"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Insert or update a session row used by legacy session import.",
"summary": "Insert session for session import",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"projectID": {
"type": "string"
},
"force": {
"type": "boolean"
},
"workspaceID": {
"type": "string"
},
"parentID": {
"type": "string"
},
"slug": {
"type": "string"
},
"directory": {
"type": "string"
},
"title": {
"type": "string"
},
"version": {
"type": "string"
},
"shareURL": {
"type": "string"
},
"summary": {
"type": "object",
"properties": {
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"files": {
"type": "number"
},
"diffs": {
"type": "array",
"items": {
"type": "object"
}
}
},
"required": ["additions", "deletions", "files"],
"additionalProperties": false
},
"revert": {
"type": "object",
"properties": {
"messageID": {
"type": "string"
},
"partID": {
"type": "string"
},
"snapshot": {
"type": "string"
},
"diff": {
"type": "string"
}
},
"required": ["messageID"],
"additionalProperties": false
},
"permission": {
"type": "object"
},
"timeCreated": {
"type": "number"
},
"timeUpdated": {
"type": "number"
},
"timeCompacting": {
"type": "number"
},
"timeArchived": {
"type": "number"
}
},
"required": ["id", "projectID", "slug", "directory", "title", "version", "timeCreated", "timeUpdated"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.sessionImport.session({\n ...\n})"
}
]
}
},
"/kilocode/session-import/message": {
"post": {
"tags": ["session-import"],
"operationId": "kilocode.sessionImport.message",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Message import result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KilocodeSessionImportResult"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Insert or update a message row used by legacy session import.",
"summary": "Insert message for session import",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sessionID": {
"type": "string"
},
"timeCreated": {
"type": "number"
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": ["user"]
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
}
},
"required": ["created"],
"additionalProperties": false
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
}
},
"required": ["providerID", "modelID"],
"additionalProperties": false
},
"tools": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
}
},
"required": ["role", "time", "agent", "model"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": ["assistant"]
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
},
"completed": {
"type": "number"
}
},
"required": ["created"],
"additionalProperties": false
},
"parentID": {
"type": "string"
},
"modelID": {
"type": "string"
},
"providerID": {
"type": "string"
},
"mode": {
"type": "string"
},
"agent": {
"type": "string"
},
"path": {
"type": "object",
"properties": {
"cwd": {
"type": "string"
},
"root": {
"type": "string"
}
},
"required": ["cwd", "root"],
"additionalProperties": false
},
"summary": {
"type": "boolean"
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"structured": {},
"variant": {
"type": "string"
},
"finish": {
"type": "string"
}
},
"required": [
"role",
"time",
"parentID",
"modelID",
"providerID",
"mode",
"agent",
"path",
"cost",
"tokens"
],
"additionalProperties": false
}
]
}
},
"required": ["id", "sessionID", "timeCreated", "data"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.sessionImport.message({\n ...\n})"
}
]
}
},
"/kilocode/session-import/part": {
"post": {
"tags": ["session-import"],
"operationId": "kilocode.sessionImport.part",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Part import result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KilocodeSessionImportResult"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Insert or update a part row used by legacy session import.",
"summary": "Insert part for session import",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"messageID": {
"type": "string"
},
"sessionID": {
"type": "string"
},
"timeCreated": {
"type": "number"
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["text"]
},
"text": {
"type": "string"
},
"synthetic": {
"type": "boolean"
},
"ignored": {
"type": "boolean"
},
"time": {
"type": "object",
"properties": {
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": ["start"],
"additionalProperties": false
},
"metadata": {
"type": "object"
}
},
"required": ["type", "text"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["reasoning"]
},
"text": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": ["start"],
"additionalProperties": false
}
},
"required": ["type", "text", "time"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["tool"]
},
"callID": {
"type": "string"
},
"tool": {
"type": "string"
},
"state": {
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["pending"]
},
"input": {
"type": "object"
},
"raw": {
"type": "string"
}
},
"required": ["status", "input", "raw"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["running"]
},
"input": {
"type": "object"
},
"title": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"start": {
"type": "number"
}
},
"required": ["start"],
"additionalProperties": false
}
},
"required": ["status", "input", "time"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["completed"]
},
"input": {
"type": "object"
},
"output": {
"type": "string"
},
"title": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"start": {
"type": "number"
},
"end": {
"type": "number"
},
"compacted": {
"type": "number"
}
},
"required": ["start", "end"],
"additionalProperties": false
}
},
"required": ["status", "input", "output", "title", "metadata", "time"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["error"]
},
"input": {
"type": "object"
},
"error": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": ["start", "end"],
"additionalProperties": false
}
},
"required": ["status", "input", "error", "time"],
"additionalProperties": false
}
]
},
"metadata": {
"type": "object"
}
},
"required": ["type", "callID", "tool", "state"],
"additionalProperties": false
}
]
}
},
"required": ["id", "messageID", "sessionID", "data"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.kilocode.sessionImport.part({\n ...\n})"
}
]
}
},
"/suggestion": {
"get": {
"tags": ["suggestion"],
"operationId": "suggestion.list",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "List of pending suggestions",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SuggestionRequest"
},
"description": "List of pending suggestions"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
}
},
"description": "Get all pending suggestion requests across all sessions.",
"summary": "List pending suggestions",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.suggestion.list({\n ...\n})"
}
]
}
},
"/suggestion/{requestID}/accept": {
"post": {
"tags": ["suggestion"],
"operationId": "suggestion.accept",
"parameters": [
{
"name": "requestID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Suggestion accepted successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Suggestion accepted successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Accept a suggestion request from the AI assistant.",
"summary": "Accept suggestion request",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"description": "Zero-based action index to accept"
}
},
"required": ["index"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.suggestion.accept({\n ...\n})"
}
]
}
},
"/suggestion/{requestID}/dismiss": {
"post": {
"tags": ["suggestion"],
"operationId": "suggestion.dismiss",
"parameters": [
{
"name": "requestID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Suggestion dismissed successfully",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Suggestion dismissed successfully"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Dismiss a suggestion request from the AI assistant.",
"summary": "Dismiss suggestion request",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.suggestion.dismiss({\n ...\n})"
}
]
}
},
"/telemetry/capture": {
"post": {
"tags": ["telemetry"],
"operationId": "telemetry.capture",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Event captured",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Event captured"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Forward a telemetry event to PostHog via kilo-telemetry.",
"summary": "Capture telemetry event",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Event name"
},
"properties": {
"type": "object"
}
},
"required": ["event"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.telemetry.capture({\n ...\n})"
}
]
}
},
"/telemetry/setEnabled": {
"post": {
"tags": ["telemetry"],
"operationId": "telemetry.setEnabled",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "State updated",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "State updated"
}
}
}
},
"400": {
"description": "BadRequest | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/effect_HttpApiError_BadRequest"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
}
},
"description": "Update the PostHog client's opt-in/out state at runtime. The CLI reads KILO_TELEMETRY_LEVEL once at spawn — this route lets clients (e.g. the VS Code extension) propagate runtime telemetry consent changes.",
"summary": "Set PostHog telemetry enabled state",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": ["enabled"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.telemetry.setEnabled({\n ...\n})"
}
]
}
},
"/memory/status": {
"get": {
"tags": ["memory"],
"operationId": "memory.status",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Memory status",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"root": {
"type": "string"
},
"state": {
"type": "object",
"properties": {
"version": {
"type": "number",
"enum": [1]
},
"enabled": {
"type": "boolean"
},
"scope": {
"type": "string",
"enum": ["project"]
},
"autoInject": {
"type": "boolean"
},
"autoConsolidate": {
"type": "boolean"
},
"verbose": {
"type": "boolean"
},
"capture": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": ["selective"]
},
"turnClose": {
"type": "boolean"
},
"explicit": {
"type": "boolean"
},
"maxOpsPerRun": {
"type": "number"
},
"minIntervalMs": {
"type": "number"
},
"timeoutMs": {
"type": "number"
}
},
"required": ["mode", "turnClose", "explicit", "maxOpsPerRun", "minIntervalMs", "timeoutMs"],
"additionalProperties": false
},
"limits": {
"type": "object",
"properties": {
"maxProjectIndexBytes": {
"type": "number"
},
"maxSessionFiles": {
"type": "number"
},
"maxRecentSessions": {
"type": "number"
},
"maxConsolidationInputBytes": {
"type": "number"
},
"maxLineChars": {
"type": "number"
},
"maxSessionLineChars": {
"type": "number"
}
},
"required": [
"maxProjectIndexBytes",
"maxSessionFiles",
"maxRecentSessions",
"maxConsolidationInputBytes",
"maxLineChars",
"maxSessionLineChars"
],
"additionalProperties": false
},
"stats": {
"type": "object",
"properties": {
"lastInjectedAt": {
"type": "number"
},
"lastInjectedBytes": {
"type": "number"
},
"lastInjectedTokens": {
"type": "number"
},
"lastInjectedSessionID": {
"type": "string"
},
"lastTypedConsolidationAt": {
"type": "number"
},
"lastSessionSavedAt": {
"type": "number"
},
"lastConsolidationCost": {
"type": "number"
},
"lastConsolidationTokens": {
"type": "number"
},
"lastOperationCount": {
"type": "number"
},
"lastRecallAt": {
"type": "number"
},
"lastRecallCount": {
"type": "number"
},
"lastRecallSessionID": {
"type": "string"
}
},
"required": [
"lastInjectedAt",
"lastInjectedBytes",
"lastInjectedTokens",
"lastInjectedSessionID",
"lastTypedConsolidationAt",
"lastSessionSavedAt",
"lastConsolidationCost",
"lastConsolidationTokens",
"lastOperationCount",
"lastRecallAt",
"lastRecallCount",
"lastRecallSessionID"
],
"additionalProperties": false
}
},
"required": [
"version",
"enabled",
"scope",
"autoInject",
"autoConsolidate",
"verbose",
"capture",
"limits",
"stats"
],
"additionalProperties": false
},
"exists": {
"type": "object",
"properties": {
"state": {
"type": "boolean"
},
"index": {
"type": "boolean"
}
},
"required": ["state", "index"],
"additionalProperties": false
},
"index": {
"type": "object",
"properties": {
"bytes": {
"type": "number"
},
"estimatedTokens": {
"type": "number"
},
"preview": {
"type": "string"
}
},
"required": ["bytes", "estimatedTokens", "preview"],
"additionalProperties": false
}
},
"required": ["root", "state", "exists", "index"],
"additionalProperties": false,
"description": "Memory status"
}
}
}
},
"400": {
"description": "MemoryApiClientError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/MemoryApiClientError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"503": {
"description": "MemoryApiServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemoryApiServerError"
}
}
}
}
},
"description": "Return memory state, index preview, and token estimate for the active workspace.",
"summary": "Get memory status",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.memory.status({\n ...\n})"
}
]
}
},
"/memory/show": {
"get": {
"tags": ["memory"],
"operationId": "memory.show",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Memory source and index",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"root": {
"type": "string"
},
"state": {
"type": "object",
"properties": {
"version": {
"type": "number",
"enum": [1]
},
"enabled": {
"type": "boolean"
},
"scope": {
"type": "string",
"enum": ["project"]
},
"autoInject": {
"type": "boolean"
},
"autoConsolidate": {
"type": "boolean"
},
"verbose": {
"type": "boolean"
},
"capture": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": ["selective"]
},
"turnClose": {
"type": "boolean"
},
"explicit": {
"type": "boolean"
},
"maxOpsPerRun": {
"type": "number"
},
"minIntervalMs": {
"type": "number"
},
"timeoutMs": {
"type": "number"
}
},
"required": ["mode", "turnClose", "explicit", "maxOpsPerRun", "minIntervalMs", "timeoutMs"],
"additionalProperties": false
},
"limits": {
"type": "object",
"properties": {
"maxProjectIndexBytes": {
"type": "number"
},
"maxSessionFiles": {
"type": "number"
},
"maxRecentSessions": {
"type": "number"
},
"maxConsolidationInputBytes": {
"type": "number"
},
"maxLineChars": {
"type": "number"
},
"maxSessionLineChars": {
"type": "number"
}
},
"required": [
"maxProjectIndexBytes",
"maxSessionFiles",
"maxRecentSessions",
"maxConsolidationInputBytes",
"maxLineChars",
"maxSessionLineChars"
],
"additionalProperties": false
},
"stats": {
"type": "object",
"properties": {
"lastInjectedAt": {
"type": "number"
},
"lastInjectedBytes": {
"type": "number"
},
"lastInjectedTokens": {
"type": "number"
},
"lastInjectedSessionID": {
"type": "string"
},
"lastTypedConsolidationAt": {
"type": "number"
},
"lastSessionSavedAt": {
"type": "number"
},
"lastConsolidationCost": {
"type": "number"
},
"lastConsolidationTokens": {
"type": "number"
},
"lastOperationCount": {
"type": "number"
},
"lastRecallAt": {
"type": "number"
},
"lastRecallCount": {
"type": "number"
},
"lastRecallSessionID": {
"type": "string"
}
},
"required": [
"lastInjectedAt",
"lastInjectedBytes",
"lastInjectedTokens",
"lastInjectedSessionID",
"lastTypedConsolidationAt",
"lastSessionSavedAt",
"lastConsolidationCost",
"lastConsolidationTokens",
"lastOperationCount",
"lastRecallAt",
"lastRecallCount",
"lastRecallSessionID"
],
"additionalProperties": false
}
},
"required": [
"version",
"enabled",
"scope",
"autoInject",
"autoConsolidate",
"verbose",
"capture",
"limits",
"stats"
],
"additionalProperties": false
},
"sources": {
"type": "object",
"properties": {
"project": {
"type": "string"
},
"environment": {
"type": "string"
},
"corrections": {
"type": "string"
}
},
"required": ["project", "environment", "corrections"],
"additionalProperties": false
},
"index": {
"type": "string"
},
"items": {
"type": "string"
},
"changes": {
"type": "string"
},
"decisions": {
"type": "string"
}
},
"required": ["root", "state", "sources", "index", "items", "changes", "decisions"],
"additionalProperties": false,
"description": "Memory source and index"
}
}
}
},
"400": {
"description": "MemoryApiClientError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/MemoryApiClientError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"503": {
"description": "MemoryApiServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemoryApiServerError"
}
}
}
}
},
"description": "Return source memory files, generated index, recent decision summary, and memory save decisions.",
"summary": "Show memory",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.memory.show({\n ...\n})"
}
]
}
},
"/memory/enable": {
"post": {
"tags": ["memory"],
"operationId": "memory.enable",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Memory enabled",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"root": {
"type": "string"
},
"state": {
"type": "object",
"properties": {
"version": {
"type": "number",
"enum": [1]
},
"enabled": {
"type": "boolean"
},
"scope": {
"type": "string",
"enum": ["project"]
},
"autoInject": {
"type": "boolean"
},
"autoConsolidate": {
"type": "boolean"
},
"verbose": {
"type": "boolean"
},
"capture": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": ["selective"]
},
"turnClose": {
"type": "boolean"
},
"explicit": {
"type": "boolean"
},
"maxOpsPerRun": {
"type": "number"
},
"minIntervalMs": {
"type": "number"
},
"timeoutMs": {
"type": "number"
}
},
"required": ["mode", "turnClose", "explicit", "maxOpsPerRun", "minIntervalMs", "timeoutMs"],
"additionalProperties": false
},
"limits": {
"type": "object",
"properties": {
"maxProjectIndexBytes": {
"type": "number"
},
"maxSessionFiles": {
"type": "number"
},
"maxRecentSessions": {
"type": "number"
},
"maxConsolidationInputBytes": {
"type": "number"
},
"maxLineChars": {
"type": "number"
},
"maxSessionLineChars": {
"type": "number"
}
},
"required": [
"maxProjectIndexBytes",
"maxSessionFiles",
"maxRecentSessions",
"maxConsolidationInputBytes",
"maxLineChars",
"maxSessionLineChars"
],
"additionalProperties": false
},
"stats": {
"type": "object",
"properties": {
"lastInjectedAt": {
"type": "number"
},
"lastInjectedBytes": {
"type": "number"
},
"lastInjectedTokens": {
"type": "number"
},
"lastInjectedSessionID": {
"type": "string"
},
"lastTypedConsolidationAt": {
"type": "number"
},
"lastSessionSavedAt": {
"type": "number"
},
"lastConsolidationCost": {
"type": "number"
},
"lastConsolidationTokens": {
"type": "number"
},
"lastOperationCount": {
"type": "number"
},
"lastRecallAt": {
"type": "number"
},
"lastRecallCount": {
"type": "number"
},
"lastRecallSessionID": {
"type": "string"
}
},
"required": [
"lastInjectedAt",
"lastInjectedBytes",
"lastInjectedTokens",
"lastInjectedSessionID",
"lastTypedConsolidationAt",
"lastSessionSavedAt",
"lastConsolidationCost",
"lastConsolidationTokens",
"lastOperationCount",
"lastRecallAt",
"lastRecallCount",
"lastRecallSessionID"
],
"additionalProperties": false
}
},
"required": [
"version",
"enabled",
"scope",
"autoInject",
"autoConsolidate",
"verbose",
"capture",
"limits",
"stats"
],
"additionalProperties": false
},
"index": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"bytes": {
"type": "number"
},
"tokens": {
"type": "number"
},
"truncated": {
"type": "boolean"
}
},
"required": ["text", "bytes", "tokens", "truncated"],
"additionalProperties": false
}
},
"required": ["root", "state", "index"],
"additionalProperties": false,
"description": "Memory enabled"
}
}
}
},
"400": {
"description": "MemoryApiClientError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/MemoryApiClientError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"503": {
"description": "MemoryApiServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemoryApiServerError"
}
}
}
}
},
"description": "Scaffold and enable project memory for the active workspace.",
"summary": "Enable memory",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.memory.enable({\n ...\n})"
}
]
}
},
"/memory/disable": {
"post": {
"tags": ["memory"],
"operationId": "memory.disable",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Memory disabled",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"root": {
"type": "string"
},
"state": {
"type": "object",
"properties": {
"version": {
"type": "number",
"enum": [1]
},
"enabled": {
"type": "boolean"
},
"scope": {
"type": "string",
"enum": ["project"]
},
"autoInject": {
"type": "boolean"
},
"autoConsolidate": {
"type": "boolean"
},
"verbose": {
"type": "boolean"
},
"capture": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": ["selective"]
},
"turnClose": {
"type": "boolean"
},
"explicit": {
"type": "boolean"
},
"maxOpsPerRun": {
"type": "number"
},
"minIntervalMs": {
"type": "number"
},
"timeoutMs": {
"type": "number"
}
},
"required": ["mode", "turnClose", "explicit", "maxOpsPerRun", "minIntervalMs", "timeoutMs"],
"additionalProperties": false
},
"limits": {
"type": "object",
"properties": {
"maxProjectIndexBytes": {
"type": "number"
},
"maxSessionFiles": {
"type": "number"
},
"maxRecentSessions": {
"type": "number"
},
"maxConsolidationInputBytes": {
"type": "number"
},
"maxLineChars": {
"type": "number"
},
"maxSessionLineChars": {
"type": "number"
}
},
"required": [
"maxProjectIndexBytes",
"maxSessionFiles",
"maxRecentSessions",
"maxConsolidationInputBytes",
"maxLineChars",
"maxSessionLineChars"
],
"additionalProperties": false
},
"stats": {
"type": "object",
"properties": {
"lastInjectedAt": {
"type": "number"
},
"lastInjectedBytes": {
"type": "number"
},
"lastInjectedTokens": {
"type": "number"
},
"lastInjectedSessionID": {
"type": "string"
},
"lastTypedConsolidationAt": {
"type": "number"
},
"lastSessionSavedAt": {
"type": "number"
},
"lastConsolidationCost": {
"type": "number"
},
"lastConsolidationTokens": {
"type": "number"
},
"lastOperationCount": {
"type": "number"
},
"lastRecallAt": {
"type": "number"
},
"lastRecallCount": {
"type": "number"
},
"lastRecallSessionID": {
"type": "string"
}
},
"required": [
"lastInjectedAt",
"lastInjectedBytes",
"lastInjectedTokens",
"lastInjectedSessionID",
"lastTypedConsolidationAt",
"lastSessionSavedAt",
"lastConsolidationCost",
"lastConsolidationTokens",
"lastOperationCount",
"lastRecallAt",
"lastRecallCount",
"lastRecallSessionID"
],
"additionalProperties": false
}
},
"required": [
"version",
"enabled",
"scope",
"autoInject",
"autoConsolidate",
"verbose",
"capture",
"limits",
"stats"
],
"additionalProperties": false
}
},
"required": ["root", "state"],
"additionalProperties": false,
"description": "Memory disabled"
}
}
}
},
"400": {
"description": "MemoryApiClientError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/MemoryApiClientError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"503": {
"description": "MemoryApiServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemoryApiServerError"
}
}
}
}
},
"description": "Disable project memory without deleting local memory files.",
"summary": "Disable memory",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.memory.disable({\n ...\n})"
}
]
}
},
"/memory/configure": {
"post": {
"tags": ["memory"],
"operationId": "memory.configure",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Memory configured",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"root": {
"type": "string"
},
"state": {
"type": "object",
"properties": {
"version": {
"type": "number",
"enum": [1]
},
"enabled": {
"type": "boolean"
},
"scope": {
"type": "string",
"enum": ["project"]
},
"autoInject": {
"type": "boolean"
},
"autoConsolidate": {
"type": "boolean"
},
"verbose": {
"type": "boolean"
},
"capture": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": ["selective"]
},
"turnClose": {
"type": "boolean"
},
"explicit": {
"type": "boolean"
},
"maxOpsPerRun": {
"type": "number"
},
"minIntervalMs": {
"type": "number"
},
"timeoutMs": {
"type": "number"
}
},
"required": ["mode", "turnClose", "explicit", "maxOpsPerRun", "minIntervalMs", "timeoutMs"],
"additionalProperties": false
},
"limits": {
"type": "object",
"properties": {
"maxProjectIndexBytes": {
"type": "number"
},
"maxSessionFiles": {
"type": "number"
},
"maxRecentSessions": {
"type": "number"
},
"maxConsolidationInputBytes": {
"type": "number"
},
"maxLineChars": {
"type": "number"
},
"maxSessionLineChars": {
"type": "number"
}
},
"required": [
"maxProjectIndexBytes",
"maxSessionFiles",
"maxRecentSessions",
"maxConsolidationInputBytes",
"maxLineChars",
"maxSessionLineChars"
],
"additionalProperties": false
},
"stats": {
"type": "object",
"properties": {
"lastInjectedAt": {
"type": "number"
},
"lastInjectedBytes": {
"type": "number"
},
"lastInjectedTokens": {
"type": "number"
},
"lastInjectedSessionID": {
"type": "string"
},
"lastTypedConsolidationAt": {
"type": "number"
},
"lastSessionSavedAt": {
"type": "number"
},
"lastConsolidationCost": {
"type": "number"
},
"lastConsolidationTokens": {
"type": "number"
},
"lastOperationCount": {
"type": "number"
},
"lastRecallAt": {
"type": "number"
},
"lastRecallCount": {
"type": "number"
},
"lastRecallSessionID": {
"type": "string"
}
},
"required": [
"lastInjectedAt",
"lastInjectedBytes",
"lastInjectedTokens",
"lastInjectedSessionID",
"lastTypedConsolidationAt",
"lastSessionSavedAt",
"lastConsolidationCost",
"lastConsolidationTokens",
"lastOperationCount",
"lastRecallAt",
"lastRecallCount",
"lastRecallSessionID"
],
"additionalProperties": false
}
},
"required": [
"version",
"enabled",
"scope",
"autoInject",
"autoConsolidate",
"verbose",
"capture",
"limits",
"stats"
],
"additionalProperties": false
}
},
"required": ["root", "state"],
"additionalProperties": false,
"description": "Memory configured"
}
}
}
},
"400": {
"description": "MemoryApiClientError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/MemoryApiClientError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"503": {
"description": "MemoryApiServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemoryApiServerError"
}
}
}
}
},
"description": "Update project memory settings such as automatic project fact capture.",
"summary": "Configure memory",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"autoConsolidate": {
"type": "boolean"
},
"verbose": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.memory.configure({\n ...\n})"
}
]
}
},
"/memory/rebuild": {
"post": {
"tags": ["memory"],
"operationId": "memory.rebuild",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Memory rebuilt",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"root": {
"type": "string"
},
"state": {
"type": "object",
"properties": {
"version": {
"type": "number",
"enum": [1]
},
"enabled": {
"type": "boolean"
},
"scope": {
"type": "string",
"enum": ["project"]
},
"autoInject": {
"type": "boolean"
},
"autoConsolidate": {
"type": "boolean"
},
"verbose": {
"type": "boolean"
},
"capture": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": ["selective"]
},
"turnClose": {
"type": "boolean"
},
"explicit": {
"type": "boolean"
},
"maxOpsPerRun": {
"type": "number"
},
"minIntervalMs": {
"type": "number"
},
"timeoutMs": {
"type": "number"
}
},
"required": ["mode", "turnClose", "explicit", "maxOpsPerRun", "minIntervalMs", "timeoutMs"],
"additionalProperties": false
},
"limits": {
"type": "object",
"properties": {
"maxProjectIndexBytes": {
"type": "number"
},
"maxSessionFiles": {
"type": "number"
},
"maxRecentSessions": {
"type": "number"
},
"maxConsolidationInputBytes": {
"type": "number"
},
"maxLineChars": {
"type": "number"
},
"maxSessionLineChars": {
"type": "number"
}
},
"required": [
"maxProjectIndexBytes",
"maxSessionFiles",
"maxRecentSessions",
"maxConsolidationInputBytes",
"maxLineChars",
"maxSessionLineChars"
],
"additionalProperties": false
},
"stats": {
"type": "object",
"properties": {
"lastInjectedAt": {
"type": "number"
},
"lastInjectedBytes": {
"type": "number"
},
"lastInjectedTokens": {
"type": "number"
},
"lastInjectedSessionID": {
"type": "string"
},
"lastTypedConsolidationAt": {
"type": "number"
},
"lastSessionSavedAt": {
"type": "number"
},
"lastConsolidationCost": {
"type": "number"
},
"lastConsolidationTokens": {
"type": "number"
},
"lastOperationCount": {
"type": "number"
},
"lastRecallAt": {
"type": "number"
},
"lastRecallCount": {
"type": "number"
},
"lastRecallSessionID": {
"type": "string"
}
},
"required": [
"lastInjectedAt",
"lastInjectedBytes",
"lastInjectedTokens",
"lastInjectedSessionID",
"lastTypedConsolidationAt",
"lastSessionSavedAt",
"lastConsolidationCost",
"lastConsolidationTokens",
"lastOperationCount",
"lastRecallAt",
"lastRecallCount",
"lastRecallSessionID"
],
"additionalProperties": false
}
},
"required": [
"version",
"enabled",
"scope",
"autoInject",
"autoConsolidate",
"verbose",
"capture",
"limits",
"stats"
],
"additionalProperties": false
},
"index": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"bytes": {
"type": "number"
},
"tokens": {
"type": "number"
},
"truncated": {
"type": "boolean"
}
},
"required": ["text", "bytes", "tokens", "truncated"],
"additionalProperties": false
}
},
"required": ["root", "state", "index"],
"additionalProperties": false,
"description": "Memory rebuilt"
}
}
}
},
"400": {
"description": "MemoryApiClientError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/MemoryApiClientError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"503": {
"description": "MemoryApiServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemoryApiServerError"
}
}
}
}
},
"description": "Regenerate index.kmem from source memory files.",
"summary": "Rebuild memory index",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.memory.rebuild({\n ...\n})"
}
]
}
},
"/memory/remember": {
"post": {
"tags": ["memory"],
"operationId": "memory.remember",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Memory operation result",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"operationCount": {
"type": "number"
},
"added": {
"type": "number"
},
"removed": {
"type": "number"
},
"skipped": {
"type": "array",
"items": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"enum": ["self_referential", "out_of_scope", "secret"]
},
"text": {
"type": "string"
}
},
"required": ["reason"],
"additionalProperties": false
}
},
"index": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"bytes": {
"type": "number"
},
"tokens": {
"type": "number"
},
"truncated": {
"type": "boolean"
}
},
"required": ["text", "bytes", "tokens", "truncated"],
"additionalProperties": false
}
},
"required": ["operationCount", "added", "removed", "skipped", "index"],
"additionalProperties": false,
"description": "Memory operation result"
}
}
}
},
"400": {
"description": "MemoryApiClientError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/MemoryApiClientError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"503": {
"description": "MemoryApiServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemoryApiServerError"
}
}
}
}
},
"description": "Persist explicit user-provided memory text through the deterministic operation pipeline.",
"summary": "Remember text",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"text": {
"type": "string",
"minLength": 1,
"maxLength": 12000
},
"key": {
"type": "string",
"maxLength": 256
},
"file": {
"type": "string",
"enum": ["project.md", "environment.md", "corrections.md"]
},
"section": {
"type": "string",
"maxLength": 80,
"pattern": "^[^\\x00-\\x1f\\x7f]*$"
},
"sessionID": {
"type": "string",
"maxLength": 128
}
},
"required": ["text"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.memory.remember({\n ...\n})"
}
]
}
},
"/memory/correct": {
"post": {
"tags": ["memory"],
"operationId": "memory.correct",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Memory correction result",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"operationCount": {
"type": "number"
},
"added": {
"type": "number"
},
"removed": {
"type": "number"
},
"skipped": {
"type": "array",
"items": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"enum": ["self_referential", "out_of_scope", "secret"]
},
"text": {
"type": "string"
}
},
"required": ["reason"],
"additionalProperties": false
}
},
"index": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"bytes": {
"type": "number"
},
"tokens": {
"type": "number"
},
"truncated": {
"type": "boolean"
}
},
"required": ["text", "bytes", "tokens", "truncated"],
"additionalProperties": false
}
},
"required": ["operationCount", "added", "removed", "skipped", "index"],
"additionalProperties": false,
"description": "Memory correction result"
}
}
}
},
"400": {
"description": "MemoryApiClientError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/MemoryApiClientError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"503": {
"description": "MemoryApiServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemoryApiServerError"
}
}
}
}
},
"description": "Persist explicit corrective memory under corrections.md.",
"summary": "Remember correction",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"text": {
"type": "string",
"minLength": 1,
"maxLength": 12000
},
"key": {
"type": "string",
"maxLength": 256
},
"sessionID": {
"type": "string",
"maxLength": 128
}
},
"required": ["text"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.memory.correct({\n ...\n})"
}
]
}
},
"/memory/forget": {
"post": {
"tags": ["memory"],
"operationId": "memory.forget",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Memory forget result",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"operationCount": {
"type": "number"
},
"added": {
"type": "number"
},
"removed": {
"type": "number"
},
"skipped": {
"type": "array",
"items": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"enum": ["self_referential", "out_of_scope", "secret"]
},
"text": {
"type": "string"
}
},
"required": ["reason"],
"additionalProperties": false
}
},
"index": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"bytes": {
"type": "number"
},
"tokens": {
"type": "number"
},
"truncated": {
"type": "boolean"
}
},
"required": ["text", "bytes", "tokens", "truncated"],
"additionalProperties": false
}
},
"required": ["operationCount", "added", "removed", "skipped", "index"],
"additionalProperties": false,
"description": "Memory forget result"
}
}
}
},
"400": {
"description": "MemoryApiClientError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/MemoryApiClientError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"503": {
"description": "MemoryApiServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemoryApiServerError"
}
}
}
}
},
"description": "Remove memory lines by exact key, id, or normalized key text and rebuild the index.",
"summary": "Forget memory",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"minLength": 1,
"maxLength": 12000
},
"sessionID": {
"type": "string",
"maxLength": 128
}
},
"required": ["query"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.memory.forget({\n ...\n})"
}
]
}
},
"/memory/purge": {
"post": {
"tags": ["memory"],
"operationId": "memory.purge",
"parameters": [
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Memory purged",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"root": {
"type": "string"
},
"purged": {
"type": "boolean"
}
},
"required": ["root", "purged"],
"additionalProperties": false,
"description": "Memory purged"
}
}
}
},
"400": {
"description": "MemoryApiClientError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/MemoryApiClientError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"503": {
"description": "MemoryApiServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemoryApiServerError"
}
}
}
}
},
"description": "Delete all project memory files for the active workspace.",
"summary": "Purge memory",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirm": {
"type": "boolean",
"enum": [true]
}
},
"required": ["confirm"],
"additionalProperties": false
}
}
}
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.memory.purge({\n ...\n})"
}
]
}
},
"/api/health": {
"get": {
"tags": ["kilo experimental HttpApi"],
"operationId": "v2.health.get",
"parameters": [],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"healthy": {
"type": "boolean",
"enum": [true]
}
},
"required": ["healthy"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
}
},
"description": "Check whether the v2 API server is ready to accept requests.",
"summary": "Check v2 server health",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.health.get({\n ...\n})"
}
]
}
},
"/api/agent": {
"get": {
"tags": ["kilo experimental HttpApi"],
"operationId": "v2.agent.list",
"parameters": [
{
"name": "location",
"in": "query",
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"workspace": {
"type": "string"
}
},
"additionalProperties": false
},
"required": false,
"style": "deepObject",
"explode": true
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"location": {
"$ref": "#/components/schemas/LocationInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentV2Info"
}
}
},
"required": ["location", "data"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
}
},
"description": "Retrieve currently registered v2 agents.",
"summary": "List v2 agents",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.agent.list({\n ...\n})"
}
]
}
},
"/api/session": {
"get": {
"tags": ["v2"],
"operationId": "v2.session.list",
"parameters": [
{
"name": "workspace",
"in": "query",
"schema": {
"type": "string",
"pattern": "^wrk"
},
"required": false
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "number"
},
"required": false
},
{
"name": "order",
"in": "query",
"schema": {
"type": "string",
"enum": ["asc", "desc"]
},
"required": false
},
{
"name": "search",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "directory",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "project",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "subpath",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"description": "Opaque pagination cursor returned as cursor.previous or cursor.next in the previous response."
},
"required": false
}
],
"security": [],
"responses": {
"200": {
"description": "V2SessionsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V2SessionsResponse"
}
}
}
},
"400": {
"description": "InvalidCursorError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/InvalidCursorError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
}
},
"description": "Retrieve sessions in the requested order. Items keep that order across pages; use cursor.next or cursor.previous to move through the ordered list.",
"summary": "List v2 sessions",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.session.list({\n ...\n})"
}
]
}
},
"/api/session/{sessionID}/prompt": {
"post": {
"tags": ["v2"],
"operationId": "v2.session.prompt",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SessionInputAdmitted"
}
},
"required": ["data"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"404": {
"description": "SessionNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionNotFoundError"
}
}
}
},
"409": {
"description": "ConflictError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictError"
}
}
}
}
},
"description": "Durably admit one v2 session input and schedule agent-loop execution unless resume is false.",
"summary": "Send v2 message",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^msg_"
},
"prompt": {
"$ref": "#/components/schemas/Prompt"
},
"delivery": {
"type": "string",
"enum": ["steer", "queue"]
},
"resume": {
"type": "boolean"
}
},
"required": ["prompt"],
"additionalProperties": false
}
}
},
"required": true
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.session.prompt({\n ...\n})"
}
]
}
},
"/api/session/{sessionID}/compact": {
"post": {
"tags": ["v2"],
"operationId": "v2.session.compact",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
}
],
"security": [],
"responses": {
"204": {
"description": "<No Content>"
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"404": {
"description": "SessionNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionNotFoundError"
}
}
}
},
"503": {
"description": "ServiceUnavailableError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailableError"
}
}
}
}
},
"description": "Compact a v2 session conversation.",
"summary": "Compact v2 session",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.session.compact({\n ...\n})"
}
]
}
},
"/api/session/{sessionID}/wait": {
"post": {
"tags": ["v2"],
"operationId": "v2.session.wait",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
}
],
"security": [],
"responses": {
"204": {
"description": "<No Content>"
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"404": {
"description": "SessionNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionNotFoundError"
}
}
}
},
"503": {
"description": "ServiceUnavailableError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailableError"
}
}
}
}
},
"description": "Wait for a v2 session agent loop to become idle.",
"summary": "Wait for v2 session",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.session.wait({\n ...\n})"
}
]
}
},
"/api/session/{sessionID}/context": {
"get": {
"tags": ["v2"],
"operationId": "v2.session.context",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionMessage"
}
}
},
"required": ["data"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"404": {
"description": "SessionNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionNotFoundError"
}
}
}
},
"500": {
"description": "UnknownError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnknownError1"
}
}
}
}
},
"description": "Retrieve the active context messages for a v2 session (all messages after the last compaction).",
"summary": "Get v2 session context",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.session.context({\n ...\n})"
}
]
}
},
"/api/session/{sessionID}/message": {
"get": {
"tags": ["v2 messages"],
"operationId": "v2.session.messages",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "number"
},
"required": false
},
{
"name": "order",
"in": "query",
"schema": {
"type": "string",
"enum": ["asc", "desc"]
},
"required": false
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"description": "Opaque pagination cursor returned as cursor.previous or cursor.next in the previous response. Do not combine with order."
},
"required": false
}
],
"security": [],
"responses": {
"200": {
"description": "V2SessionMessagesResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V2SessionMessagesResponse"
}
}
}
},
"400": {
"description": "InvalidCursorError | InvalidRequestError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/InvalidCursorError"
},
{
"$ref": "#/components/schemas/InvalidRequestError"
}
]
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"404": {
"description": "SessionNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionNotFoundError"
}
}
}
},
"500": {
"description": "UnknownError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnknownError1"
}
}
}
}
},
"description": "Retrieve projected v2 messages for a session. Items keep the requested order across pages; use cursor.next or cursor.previous to move through the ordered timeline.",
"summary": "Get v2 session messages",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.session.messages({\n ...\n})"
}
]
}
},
"/api/model": {
"get": {
"tags": ["v2 models"],
"operationId": "v2.model.list",
"parameters": [
{
"name": "location",
"in": "query",
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"workspace": {
"type": "string"
}
},
"additionalProperties": false
},
"required": false,
"style": "deepObject",
"explode": true
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"location": {
"$ref": "#/components/schemas/LocationInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelV2Info"
}
}
},
"required": ["location", "data"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"503": {
"description": "ServiceUnavailableError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailableError"
}
}
}
}
},
"description": "Retrieve available v2 models ordered by release date.",
"summary": "List v2 models",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.model.list({\n ...\n})"
}
]
}
},
"/api/provider": {
"get": {
"tags": ["v2 providers"],
"operationId": "v2.provider.list",
"parameters": [
{
"name": "location",
"in": "query",
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"workspace": {
"type": "string"
}
},
"additionalProperties": false
},
"required": false,
"style": "deepObject",
"explode": true
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"location": {
"$ref": "#/components/schemas/LocationInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderV2Info"
}
}
},
"required": ["location", "data"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"503": {
"description": "ServiceUnavailableError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailableError"
}
}
}
}
},
"description": "Retrieve active v2 AI providers so clients can show provider availability and configuration.",
"summary": "List v2 providers",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.provider.list({\n ...\n})"
}
]
}
},
"/api/provider/{providerID}": {
"get": {
"tags": ["v2 providers"],
"operationId": "v2.provider.get",
"parameters": [
{
"name": "providerID",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "location",
"in": "query",
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"workspace": {
"type": "string"
}
},
"additionalProperties": false
},
"required": false,
"style": "deepObject",
"explode": true
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"location": {
"$ref": "#/components/schemas/LocationInfo"
},
"data": {
"$ref": "#/components/schemas/ProviderV2Info"
}
},
"required": ["location", "data"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"404": {
"description": "ProviderNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderNotFoundError"
}
}
}
},
"503": {
"description": "ServiceUnavailableError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailableError"
}
}
}
}
},
"description": "Retrieve a single v2 AI provider so clients can inspect its availability and endpoint settings.",
"summary": "Get v2 provider",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.provider.get({\n ...\n})"
}
]
}
},
"/api/permission/request": {
"get": {
"tags": ["v2 permissions"],
"operationId": "v2.permission.request.list",
"parameters": [
{
"name": "location",
"in": "query",
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"workspace": {
"type": "string"
}
},
"additionalProperties": false
},
"required": false,
"style": "deepObject",
"explode": true
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"location": {
"$ref": "#/components/schemas/LocationInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionV2Request"
}
}
},
"required": ["location", "data"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
}
},
"description": "Retrieve pending permission requests for a location.",
"summary": "List pending permission requests",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.permission.request.list({\n ...\n})"
}
]
}
},
"/api/session/{sessionID}/permission/request": {
"get": {
"tags": ["v2 session permissions"],
"operationId": "v2.session.permission.list",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionV2Request"
}
}
},
"required": ["data"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"404": {
"description": "SessionNotFoundError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionNotFoundError"
}
}
}
}
},
"description": "Retrieve pending permission requests owned by a session.",
"summary": "List session permission requests",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.session.permission.list({\n ...\n})"
}
]
}
},
"/api/session/{sessionID}/permission/request/{requestID}/reply": {
"post": {
"tags": ["v2 session permissions"],
"operationId": "v2.session.permission.reply",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "requestID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^per"
},
"required": true
}
],
"security": [],
"responses": {
"204": {
"description": "<No Content>"
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"404": {
"description": "SessionNotFoundError | PermissionNotFoundError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/SessionNotFoundError"
},
{
"$ref": "#/components/schemas/PermissionNotFoundError"
}
]
}
}
}
}
},
"description": "Respond to a pending permission request owned by a session.",
"summary": "Reply to pending permission request",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reply": {
"$ref": "#/components/schemas/PermissionV2Reply"
},
"message": {
"type": "string"
}
},
"required": ["reply"],
"additionalProperties": false
}
}
},
"required": true
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.session.permission.reply({\n ...\n})"
}
]
}
},
"/api/permission/saved": {
"get": {
"tags": ["v2 saved permissions"],
"operationId": "v2.permission.saved.list",
"parameters": [
{
"name": "projectID",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionSavedInfo"
}
}
},
"required": ["data"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
}
},
"description": "Retrieve saved permissions, optionally filtered by project.",
"summary": "List saved permissions",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.permission.saved.list({\n ...\n})"
}
]
}
},
"/api/permission/saved/{id}": {
"delete": {
"tags": ["v2 saved permissions"],
"operationId": "v2.permission.saved.remove",
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"security": [],
"responses": {
"204": {
"description": "<No Content>"
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
}
},
"description": "Remove a saved permission by ID.",
"summary": "Remove saved permission",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.permission.saved.remove({\n ...\n})"
}
]
}
},
"/api/fs/read": {
"get": {
"tags": ["v2 filesystem"],
"operationId": "v2.fs.read",
"parameters": [
{
"name": "location",
"in": "query",
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"workspace": {
"type": "string"
}
},
"additionalProperties": false
},
"required": false,
"style": "deepObject",
"explode": true
},
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "reference",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"location": {
"$ref": "#/components/schemas/LocationInfo"
},
"data": {
"anyOf": [
{
"$ref": "#/components/schemas/FileSystemTextContent"
},
{
"$ref": "#/components/schemas/FileSystemBinaryContent"
}
]
}
},
"required": ["location", "data"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
}
},
"description": "Read one file relative to the requested location.",
"summary": "Read file",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.fs.read({\n ...\n})"
}
]
}
},
"/api/fs/list": {
"get": {
"tags": ["v2 filesystem"],
"operationId": "v2.fs.list",
"parameters": [
{
"name": "location",
"in": "query",
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"workspace": {
"type": "string"
}
},
"additionalProperties": false
},
"required": false,
"style": "deepObject",
"explode": true
},
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
},
"required": false
},
{
"name": "reference",
"in": "query",
"schema": {
"type": "string"
},
"required": false
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"location": {
"$ref": "#/components/schemas/LocationInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemEntry"
}
}
},
"required": ["location", "data"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
}
},
"description": "List direct children of one directory relative to the requested location.",
"summary": "List directory",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.fs.list({\n ...\n})"
}
]
}
},
"/api/command": {
"get": {
"tags": ["v2 commands"],
"operationId": "v2.command.list",
"parameters": [
{
"name": "location",
"in": "query",
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"workspace": {
"type": "string"
}
},
"additionalProperties": false
},
"required": false,
"style": "deepObject",
"explode": true
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"location": {
"$ref": "#/components/schemas/LocationInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommandV2Info"
}
}
},
"required": ["location", "data"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
}
},
"description": "Retrieve currently registered v2 commands.",
"summary": "List v2 commands",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.command.list({\n ...\n})"
}
]
}
},
"/api/skill": {
"get": {
"tags": ["v2 skills"],
"operationId": "v2.skill.list",
"parameters": [
{
"name": "location",
"in": "query",
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"workspace": {
"type": "string"
}
},
"additionalProperties": false
},
"required": false,
"style": "deepObject",
"explode": true
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"location": {
"$ref": "#/components/schemas/LocationInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SkillV2Info"
}
}
},
"required": ["location", "data"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
}
},
"description": "Retrieve currently registered v2 skills.",
"summary": "List v2 skills",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.skill.list({\n ...\n})"
}
]
}
},
"/api/event": {
"get": {
"tags": ["v2 events"],
"operationId": "v2.event.subscribe",
"parameters": [
{
"name": "location",
"in": "query",
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"workspace": {
"type": "string"
}
},
"additionalProperties": false
},
"required": false,
"style": "deepObject",
"explode": true
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"text/event-stream": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
}
},
"description": "Subscribe to native EventV2 payloads for a location.",
"summary": "Subscribe to v2 events",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.event.subscribe({\n ...\n})"
}
]
}
},
"/api/question/request": {
"get": {
"tags": ["v2 questions"],
"operationId": "v2.question.request.list",
"parameters": [
{
"name": "location",
"in": "query",
"schema": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"workspace": {
"type": "string"
}
},
"additionalProperties": false
},
"required": false,
"style": "deepObject",
"explode": true
}
],
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"location": {
"$ref": "#/components/schemas/LocationInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionV2Request"
}
}
},
"required": ["location", "data"],
"additionalProperties": false
}
}
}
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
}
},
"description": "Retrieve pending question requests for a location.",
"summary": "List pending question requests",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.question.request.list({\n ...\n})"
}
]
}
},
"/api/session/{sessionID}/question/request/{requestID}/reply": {
"post": {
"tags": ["v2 session questions"],
"operationId": "v2.session.question.reply",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "requestID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^que"
},
"required": true
}
],
"security": [],
"responses": {
"204": {
"description": "<No Content>"
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"404": {
"description": "SessionNotFoundError | QuestionNotFoundError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/SessionNotFoundError"
},
{
"$ref": "#/components/schemas/QuestionNotFoundError"
}
]
}
}
}
}
},
"description": "Answer a pending question request owned by a session.",
"summary": "Reply to pending question request",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionV2Reply"
}
}
},
"required": true
},
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.session.question.reply({\n ...\n})"
}
]
}
},
"/api/session/{sessionID}/question/request/{requestID}/reject": {
"post": {
"tags": ["v2 session questions"],
"operationId": "v2.session.question.reject",
"parameters": [
{
"name": "sessionID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^ses.*"
},
"required": true
},
{
"name": "requestID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^que"
},
"required": true
}
],
"security": [],
"responses": {
"204": {
"description": "<No Content>"
},
"400": {
"description": "InvalidRequestError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestError"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"404": {
"description": "SessionNotFoundError | QuestionNotFoundError",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/SessionNotFoundError"
},
{
"$ref": "#/components/schemas/QuestionNotFoundError"
}
]
}
}
}
}
},
"description": "Reject a pending question request owned by a session.",
"summary": "Reject pending question request",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.v2.session.question.reject({\n ...\n})"
}
]
}
},
"/pty/{ptyID}/connect": {
"get": {
"tags": ["pty"],
"operationId": "pty.connect",
"parameters": [
{
"name": "ptyID",
"in": "path",
"schema": {
"type": "string",
"pattern": "^pty.*"
},
"required": true
},
{
"in": "query",
"name": "directory",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "workspace",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "cursor",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "ticket",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Connected session",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"description": "Connected session"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/effect_HttpApiError_Forbidden"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
}
},
"description": "Establish a WebSocket connection to interact with a pseudo-terminal (PTY) session in real-time.",
"summary": "Connect to PTY session",
"x-codeSamples": [
{
"lang": "js",
"source": "import { createKiloClient } from \"@kilocode/sdk\"\n\nconst client = createKiloClient()\nawait client.pty.connect({\n ...\n})"
}
]
}
}
},
"components": {
"schemas": {
"Event": {
"anyOf": [
{
"$ref": "#/components/schemas/EventServerInstanceDisposed"
},
{
"$ref": "#/components/schemas/EventSessionNetworkAsked"
},
{
"$ref": "#/components/schemas/EventSessionNetworkReplied"
},
{
"$ref": "#/components/schemas/EventSessionNetworkRejected"
},
{
"$ref": "#/components/schemas/EventSessionNetworkRestored"
},
{
"$ref": "#/components/schemas/EventBackground_processUpdated"
},
{
"$ref": "#/components/schemas/EventBackground_processDeleted"
},
{
"$ref": "#/components/schemas/EventInteractive_terminalUpdated"
},
{
"$ref": "#/components/schemas/EventInteractive_terminalData"
},
{
"$ref": "#/components/schemas/EventInteractive_terminalDeleted"
},
{
"$ref": "#/components/schemas/EventSessionTurnOpen"
},
{
"$ref": "#/components/schemas/EventSessionTurnClose"
},
{
"$ref": "#/components/schemas/EventSandboxStatusChanged"
},
{
"$ref": "#/components/schemas/EventSuggestionShown"
},
{
"$ref": "#/components/schemas/EventSuggestionAccepted"
},
{
"$ref": "#/components/schemas/EventSuggestionDismissed"
},
{
"$ref": "#/components/schemas/EventKilocodeAgent_managerStart"
},
{
"$ref": "#/components/schemas/EventKilocodeAgent_managerRequested"
},
{
"$ref": "#/components/schemas/EventKilocodeAgent_managerCancelled"
},
{
"$ref": "#/components/schemas/EventKilocodeNotebookRequested"
},
{
"$ref": "#/components/schemas/EventKilocodeNotebookCancelled"
},
{
"$ref": "#/components/schemas/EventLspClientDiagnostics"
},
{
"$ref": "#/components/schemas/EventKilo-sessionsRemote-status-changed"
},
{
"$ref": "#/components/schemas/EventMemoryStatus1"
},
{
"$ref": "#/components/schemas/EventMemoryUpdated1"
},
{
"$ref": "#/components/schemas/EventMemoryError1"
},
{
"$ref": "#/components/schemas/EventIndexingStatus"
},
{
"$ref": "#/components/schemas/EventIndexingWarning"
},
{
"$ref": "#/components/schemas/EventServerConnected"
},
{
"$ref": "#/components/schemas/EventGlobalDisposed"
},
{
"$ref": "#/components/schemas/EventGlobalConfigUpdated"
},
{
"$ref": "#/components/schemas/EventPluginAdded"
},
{
"$ref": "#/components/schemas/EventCatalogModelUpdated"
},
{
"$ref": "#/components/schemas/EventSessionCreated"
},
{
"$ref": "#/components/schemas/EventSessionUpdated"
},
{
"$ref": "#/components/schemas/EventSessionDeleted"
},
{
"$ref": "#/components/schemas/EventMessageUpdated"
},
{
"$ref": "#/components/schemas/EventMessageRemoved"
},
{
"$ref": "#/components/schemas/EventMessagePartUpdated"
},
{
"$ref": "#/components/schemas/EventMessagePartRemoved"
},
{
"$ref": "#/components/schemas/EventSessionNextAgentSwitched"
},
{
"$ref": "#/components/schemas/EventSessionNextModelSwitched"
},
{
"$ref": "#/components/schemas/EventSessionNextMoved"
},
{
"$ref": "#/components/schemas/EventSessionNextPrompted"
},
{
"$ref": "#/components/schemas/EventSessionNextPromptAdmitted"
},
{
"$ref": "#/components/schemas/EventSessionNextPromptPromoted"
},
{
"$ref": "#/components/schemas/EventSessionNextContextUpdated"
},
{
"$ref": "#/components/schemas/EventSessionNextSynthetic"
},
{
"$ref": "#/components/schemas/EventSessionNextShellStarted"
},
{
"$ref": "#/components/schemas/EventSessionNextShellEnded"
},
{
"$ref": "#/components/schemas/EventSessionNextStepStarted"
},
{
"$ref": "#/components/schemas/EventSessionNextStepEnded"
},
{
"$ref": "#/components/schemas/EventSessionNextStepFailed"
},
{
"$ref": "#/components/schemas/EventSessionNextTextStarted"
},
{
"$ref": "#/components/schemas/EventSessionNextTextDelta"
},
{
"$ref": "#/components/schemas/EventSessionNextTextEnded"
},
{
"$ref": "#/components/schemas/EventSessionNextReasoningStarted"
},
{
"$ref": "#/components/schemas/EventSessionNextReasoningDelta"
},
{
"$ref": "#/components/schemas/EventSessionNextReasoningEnded"
},
{
"$ref": "#/components/schemas/EventSessionNextToolInputStarted"
},
{
"$ref": "#/components/schemas/EventSessionNextToolInputDelta"
},
{
"$ref": "#/components/schemas/EventSessionNextToolInputEnded"
},
{
"$ref": "#/components/schemas/EventSessionNextToolCalled"
},
{
"$ref": "#/components/schemas/EventSessionNextToolProgress"
},
{
"$ref": "#/components/schemas/EventSessionNextToolSuccess"
},
{
"$ref": "#/components/schemas/EventSessionNextToolFailed"
},
{
"$ref": "#/components/schemas/EventSessionNextRetried"
},
{
"$ref": "#/components/schemas/EventSessionNextCompactionStarted"
},
{
"$ref": "#/components/schemas/EventSessionNextCompactionDelta"
},
{
"$ref": "#/components/schemas/EventSessionNextCompactionEnded"
},
{
"$ref": "#/components/schemas/EventQuestionAsked"
},
{
"$ref": "#/components/schemas/EventQuestionReplied"
},
{
"$ref": "#/components/schemas/EventQuestionRejected"
},
{
"$ref": "#/components/schemas/Event.tui.prompt.append"
},
{
"$ref": "#/components/schemas/Event.tui.command.execute"
},
{
"$ref": "#/components/schemas/EventTuiToastShow1"
},
{
"$ref": "#/components/schemas/Event.tui.session.select"
},
{
"$ref": "#/components/schemas/EventMcpToolsChanged"
},
{
"$ref": "#/components/schemas/EventMcpBrowserOpenFailed"
},
{
"$ref": "#/components/schemas/EventMessagePartDelta"
},
{
"$ref": "#/components/schemas/EventSessionDiff"
},
{
"$ref": "#/components/schemas/EventSessionError"
},
{
"$ref": "#/components/schemas/EventModels-devRefreshed"
},
{
"$ref": "#/components/schemas/EventInstallationUpdated"
},
{
"$ref": "#/components/schemas/EventInstallationUpdate-available"
},
{
"$ref": "#/components/schemas/EventPermissionAsked"
},
{
"$ref": "#/components/schemas/EventPermissionReplied"
},
{
"$ref": "#/components/schemas/EventTodoUpdated"
},
{
"$ref": "#/components/schemas/EventSessionStatus"
},
{
"$ref": "#/components/schemas/EventSessionIdle"
},
{
"$ref": "#/components/schemas/EventSessionCompacted"
},
{
"$ref": "#/components/schemas/EventCommandExecuted"
},
{
"$ref": "#/components/schemas/EventProjectDirectoriesUpdated"
},
{
"$ref": "#/components/schemas/EventProjectUpdated"
},
{
"$ref": "#/components/schemas/EventLspUpdated"
},
{
"$ref": "#/components/schemas/EventFileEdited"
},
{
"$ref": "#/components/schemas/EventFileWatcherUpdated"
},
{
"$ref": "#/components/schemas/EventVcsBranchUpdated"
},
{
"$ref": "#/components/schemas/EventWorkspaceReady"
},
{
"$ref": "#/components/schemas/EventWorkspaceFailed"
},
{
"$ref": "#/components/schemas/EventWorkspaceStatus"
},
{
"$ref": "#/components/schemas/EventWorktreeReady"
},
{
"$ref": "#/components/schemas/EventWorktreeFailed"
},
{
"$ref": "#/components/schemas/EventAccountAdded"
},
{
"$ref": "#/components/schemas/EventAccountRemoved"
},
{
"$ref": "#/components/schemas/EventAccountSwitched"
},
{
"$ref": "#/components/schemas/EventPermissionV2Asked"
},
{
"$ref": "#/components/schemas/EventPermissionV2Replied"
},
{
"$ref": "#/components/schemas/EventPtyCreated"
},
{
"$ref": "#/components/schemas/EventPtyUpdated"
},
{
"$ref": "#/components/schemas/EventPtyExited"
},
{
"$ref": "#/components/schemas/EventPtyDeleted"
},
{
"$ref": "#/components/schemas/EventQuestionV2Asked"
},
{
"$ref": "#/components/schemas/EventQuestionV2Replied"
},
{
"$ref": "#/components/schemas/EventQuestionV2Rejected"
},
{
"$ref": "#/components/schemas/EventServerInstanceDisposed"
}
]
},
"QuestionReplied": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"requestID": {
"type": "string",
"pattern": "^que"
},
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionAnswer"
}
}
},
"required": ["sessionID", "requestID", "answers"],
"additionalProperties": false
},
"QuestionRejected": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"requestID": {
"type": "string",
"pattern": "^que"
}
},
"required": ["sessionID", "requestID"],
"additionalProperties": false
},
"OAuth": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["oauth"]
},
"refresh": {
"type": "string"
},
"access": {
"type": "string"
},
"expires": {
"type": "integer",
"minimum": 0
},
"accountId": {
"type": "string"
},
"enterpriseUrl": {
"type": "string"
}
},
"required": ["type", "refresh", "access", "expires"],
"additionalProperties": false
},
"ApiAuth": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["api"]
},
"key": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": ["type", "key"],
"additionalProperties": false
},
"WellKnownAuth": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["wellknown"]
},
"key": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": ["type", "key", "token"],
"additionalProperties": false
},
"Auth": {
"anyOf": [
{
"$ref": "#/components/schemas/OAuth"
},
{
"$ref": "#/components/schemas/ApiAuth"
},
{
"$ref": "#/components/schemas/WellKnownAuth"
}
]
},
"effect_HttpApiError_BadRequest": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["BadRequest"]
}
},
"required": ["_tag"],
"additionalProperties": false
},
"InvalidRequestError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["InvalidRequestError"]
},
"message": {
"type": "string"
},
"kind": {
"type": "string"
},
"field": {
"type": "string"
}
},
"required": ["_tag", "message"],
"additionalProperties": false
},
"MoveSessionError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["MoveSessionError"]
},
"data": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": ["message"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"SessionNetworkWait": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^que"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"message": {
"type": "string"
},
"restored": {
"type": "boolean"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
},
"restored": {
"type": "number"
}
},
"required": ["created"],
"additionalProperties": false
}
},
"required": ["id", "sessionID", "message", "restored", "time"],
"additionalProperties": false
},
"BackgroundProcessInfo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"pid": {
"type": "integer",
"exclusiveMinimum": 0
},
"command": {
"type": "string"
},
"cwd": {
"type": "string"
},
"description": {
"type": "string"
},
"ports": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"status": {
"type": "string",
"enum": ["starting", "running", "ready", "exited", "failed", "stopping", "stopped"]
},
"lifetime": {
"type": "string",
"enum": ["session", "parent", "persistent"]
},
"ready": {
"type": "boolean"
},
"exitCode": {
"type": "integer",
"minimum": 0
},
"signal": {
"type": "string"
},
"output": {
"type": "string"
},
"time": {
"type": "object",
"properties": {
"started": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"ended": {
"type": "integer",
"minimum": 0
}
},
"required": ["started", "updated"],
"additionalProperties": false
}
},
"required": ["id", "sessionID", "command", "cwd", "ports", "status", "lifetime", "ready", "output", "time"],
"additionalProperties": false
},
"InteractiveTerminalInfo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"pid": {
"type": "integer",
"exclusiveMinimum": 0
},
"command": {
"type": "string"
},
"cwd": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"type": "string",
"enum": ["running", "closed"]
},
"cols": {
"type": "integer",
"exclusiveMinimum": 0
},
"rows": {
"type": "integer",
"exclusiveMinimum": 0
},
"exitCode": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"signal": {
"type": "string"
},
"closedBy": {
"type": "string",
"enum": ["exit", "user", "abort"]
},
"time": {
"type": "object",
"properties": {
"started": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"ended": {
"type": "integer",
"minimum": 0
}
},
"required": ["started", "updated"],
"additionalProperties": false
}
},
"required": ["id", "sessionID", "pid", "command", "cwd", "status", "cols", "rows", "time"],
"additionalProperties": false
},
"SuggestionRequest": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^sug"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"text": {
"type": "string"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Button or option label (1-5 words)"
},
"description": {
"type": "string"
},
"prompt": {
"type": "string",
"description": "Synthetic user prompt to inject when this action is accepted"
}
},
"required": ["label", "prompt"],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 2
},
"blocking": {
"type": "boolean"
},
"tool": {
"type": "object",
"properties": {
"messageID": {
"type": "string"
},
"callID": {
"type": "string"
}
},
"required": ["messageID", "callID"],
"additionalProperties": false
}
},
"required": ["id", "sessionID", "text", "actions"],
"additionalProperties": false
},
"AgentManagerRequestID": {
"type": "string"
},
"AgentManagerFilterState": {
"type": "string",
"enum": ["idle", "busy", "retry", "offline", "waiting"]
},
"AgentManagerOverviewFilter": {
"type": "object",
"properties": {
"sectionIDs": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 100
},
"states": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentManagerFilterState"
},
"maxItems": 5
}
},
"additionalProperties": false
},
"AgentManagerOverviewRequest": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/AgentManagerRequestID"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"operation": {
"type": "string",
"enum": ["overview"]
},
"filter": {
"$ref": "#/components/schemas/AgentManagerOverviewFilter"
}
},
"required": ["id", "sessionID", "operation"],
"additionalProperties": false
},
"AgentManagerPromptRequest": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/AgentManagerRequestID"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"operation": {
"type": "string",
"enum": ["prompt"]
},
"targetSessionID": {
"type": "string",
"pattern": "^ses"
},
"prompt": {
"type": "string",
"minLength": 1,
"maxLength": 100000
}
},
"required": ["id", "sessionID", "operation", "targetSessionID", "prompt"],
"additionalProperties": false
},
"AgentManagerRequest": {
"anyOf": [
{
"$ref": "#/components/schemas/AgentManagerOverviewRequest"
},
{
"$ref": "#/components/schemas/AgentManagerPromptRequest"
}
]
},
"NotebookRequestID": {
"type": "string"
},
"NotebookReadRequest": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/NotebookRequestID"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"operation": {
"type": "string",
"enum": ["read"]
},
"includeOutputs": {
"type": "boolean"
}
},
"required": ["id", "sessionID", "path", "operation", "includeOutputs"],
"additionalProperties": false
},
"NotebookEditRequest": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/NotebookRequestID"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"operation": {
"type": "string",
"enum": ["edit"]
},
"expectedRevision": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Opaque notebook content revision; pass it back unchanged and do not parse or increment it"
},
"index": {
"type": "integer",
"minimum": 0,
"description": "Zero-based cell index"
},
"edit": {
"anyOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": ["insert"]
},
"kind": {
"type": "string",
"enum": ["code", "markdown"]
},
"language": {
"type": "string",
"maxLength": 200
},
"source": {
"type": "string",
"maxLength": 200000
}
},
"required": ["action", "kind", "source"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": ["replace"]
},
"kind": {
"type": "string",
"enum": ["code", "markdown"]
},
"language": {
"type": "string",
"maxLength": 200
},
"source": {
"type": "string",
"maxLength": 200000
}
},
"required": ["action", "kind", "source"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": ["delete"]
}
},
"required": ["action"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": ["create"]
}
},
"required": ["action"],
"additionalProperties": false
}
]
}
},
"required": ["id", "sessionID", "path", "operation", "index", "edit"],
"additionalProperties": false
},
"NotebookExecuteRequest": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/NotebookRequestID"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"operation": {
"type": "string",
"enum": ["execute"]
},
"expectedRevision": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Opaque notebook content revision; pass it back unchanged and do not parse or increment it"
},
"index": {
"type": "integer",
"minimum": 0,
"description": "Zero-based cell index"
}
},
"required": ["id", "sessionID", "path", "operation", "expectedRevision", "index"],
"additionalProperties": false
},
"NotebookRequest": {
"anyOf": [
{
"$ref": "#/components/schemas/NotebookReadRequest"
},
{
"$ref": "#/components/schemas/NotebookEditRequest"
},
{
"$ref": "#/components/schemas/NotebookExecuteRequest"
}
]
},
"IndexingStatusState": {
"type": "string",
"enum": ["Disabled", "In Progress", "Complete", "Error", "Standby"]
},
"IndexingStatus": {
"type": "object",
"properties": {
"state": {
"$ref": "#/components/schemas/IndexingStatusState"
},
"message": {
"type": "string"
},
"processedFiles": {
"type": "integer",
"minimum": 0
},
"totalFiles": {
"type": "integer",
"minimum": 0
},
"percent": {
"type": "integer",
"minimum": 0,
"maximum": 100
}
},
"required": ["state", "message", "processedFiles", "totalFiles", "percent"],
"additionalProperties": false
},
"IndexingWarning": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": ["qdrant.version-incompatible", "qdrant.version-unavailable"]
},
"message": {
"type": "string"
}
},
"required": ["code", "message"],
"additionalProperties": false
},
"SnapshotFileDiff": {
"type": "object",
"properties": {
"file": {
"type": "string"
},
"patch": {
"type": "string"
},
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"status": {
"type": "string",
"enum": ["added", "deleted", "modified"]
}
},
"required": ["additions", "deletions"],
"additionalProperties": false
},
"PermissionAction": {
"type": "string",
"enum": ["allow", "deny", "ask"]
},
"PermissionRule": {
"type": "object",
"properties": {
"permission": {
"type": "string"
},
"pattern": {
"type": "string"
},
"action": {
"$ref": "#/components/schemas/PermissionAction"
}
},
"required": ["permission", "pattern", "action"],
"additionalProperties": false
},
"PermissionRuleset": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionRule"
}
},
"Session": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^ses"
},
"slug": {
"type": "string"
},
"projectID": {
"type": "string"
},
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"directory": {
"type": "string"
},
"path": {
"type": "string"
},
"parentID": {
"type": "string",
"pattern": "^ses"
},
"summary": {
"type": "object",
"properties": {
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"files": {
"type": "number"
},
"diffs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotFileDiff"
}
}
},
"required": ["additions", "deletions", "files"],
"additionalProperties": false
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"share": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": ["url"],
"additionalProperties": false
},
"title": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"version": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"compacting": {
"type": "integer",
"minimum": 0
},
"archived": {
"type": "number"
}
},
"required": ["created", "updated"],
"additionalProperties": false
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
"revert": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
},
"snapshot": {
"type": "string"
},
"diff": {
"type": "string"
}
},
"required": ["messageID"],
"additionalProperties": false
}
},
"required": ["id", "slug", "projectID", "directory", "title", "version", "time"],
"additionalProperties": false
},
"OutputFormatText": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["text"]
}
},
"required": ["type"],
"additionalProperties": false
},
"JSONSchema": {
"type": "object"
},
"OutputFormatJsonSchema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["json_schema"]
},
"schema": {
"$ref": "#/components/schemas/JSONSchema"
},
"retryCount": {
"type": "integer",
"minimum": 0
}
},
"required": ["type", "schema"],
"additionalProperties": false
},
"OutputFormat": {
"anyOf": [
{
"$ref": "#/components/schemas/OutputFormatText"
},
{
"$ref": "#/components/schemas/OutputFormatJsonSchema"
}
]
},
"UserMessage": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^msg"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"role": {
"type": "string",
"enum": ["user"]
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number",
"minimum": 0
}
},
"required": ["created"],
"additionalProperties": false
},
"format": {
"$ref": "#/components/schemas/OutputFormat"
},
"summary": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"body": {
"type": "string"
},
"diffs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotFileDiff"
}
}
},
"required": ["diffs"],
"additionalProperties": false
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["providerID", "modelID"],
"additionalProperties": false
},
"system": {
"type": "string"
},
"tools": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"editorContext": {
"type": "object",
"properties": {
"visibleFiles": {
"type": "array",
"items": {
"type": "string"
}
},
"openTabs": {
"type": "array",
"items": {
"type": "string"
}
},
"activeFile": {
"type": "string"
},
"shell": {
"type": "string"
}
},
"additionalProperties": false
}
},
"required": ["id", "sessionID", "role", "time", "agent", "model"],
"additionalProperties": false
},
"ProviderAuthError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["ProviderAuthError"]
},
"data": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": ["providerID", "message"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"UnknownError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["UnknownError"]
},
"data": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"ref": {
"type": "string"
}
},
"required": ["message"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"MessageOutputLengthError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["MessageOutputLengthError"]
},
"data": {
"type": "object",
"properties": {}
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"MessageAbortedError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["MessageAbortedError"]
},
"data": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": ["message"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"StructuredOutputError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["StructuredOutputError"]
},
"data": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"retries": {
"type": "integer",
"minimum": 0
}
},
"required": ["message", "retries"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"ContextOverflowError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["ContextOverflowError"]
},
"data": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"responseBody": {
"type": "string"
}
},
"required": ["message"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"APIError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["APIError"]
},
"data": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"statusCode": {
"type": "integer",
"minimum": 0
},
"isRetryable": {
"type": "boolean"
},
"responseHeaders": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"responseBody": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": ["message", "isRetryable"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"AssistantMessage": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^msg"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"role": {
"type": "string",
"enum": ["assistant"]
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
},
"completed": {
"type": "integer",
"minimum": 0
}
},
"required": ["created"],
"additionalProperties": false
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/ProviderAuthError"
},
{
"$ref": "#/components/schemas/UnknownError"
},
{
"$ref": "#/components/schemas/MessageOutputLengthError"
},
{
"$ref": "#/components/schemas/MessageAbortedError"
},
{
"$ref": "#/components/schemas/StructuredOutputError"
},
{
"$ref": "#/components/schemas/ContextOverflowError"
},
{
"$ref": "#/components/schemas/APIError"
}
]
},
"parentID": {
"type": "string",
"pattern": "^msg"
},
"modelID": {
"type": "string"
},
"providerID": {
"type": "string"
},
"mode": {
"type": "string"
},
"agent": {
"type": "string"
},
"path": {
"type": "object",
"properties": {
"cwd": {
"type": "string"
},
"root": {
"type": "string"
}
},
"required": ["cwd", "root"],
"additionalProperties": false
},
"summary": {
"type": "boolean"
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"structured": {},
"variant": {
"type": "string"
},
"finish": {
"type": "string"
}
},
"required": [
"id",
"sessionID",
"role",
"time",
"parentID",
"modelID",
"providerID",
"mode",
"agent",
"path",
"cost",
"tokens"
],
"additionalProperties": false
},
"Message": {
"anyOf": [
{
"$ref": "#/components/schemas/UserMessage"
},
{
"$ref": "#/components/schemas/AssistantMessage"
}
]
},
"TextPart": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"type": {
"type": "string",
"enum": ["text"]
},
"text": {
"type": "string"
},
"synthetic": {
"type": "boolean"
},
"ignored": {
"type": "boolean"
},
"time": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0
},
"end": {
"type": "integer",
"minimum": 0
}
},
"required": ["start"],
"additionalProperties": false
},
"metadata": {
"type": "object"
}
},
"required": ["id", "sessionID", "messageID", "type", "text"],
"additionalProperties": false
},
"SubtaskPart": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"type": {
"type": "string",
"enum": ["subtask"]
},
"prompt": {
"type": "string"
},
"description": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
}
},
"required": ["providerID", "modelID"],
"additionalProperties": false
},
"command": {
"type": "string"
}
},
"required": ["id", "sessionID", "messageID", "type", "prompt", "description", "agent"],
"additionalProperties": false
},
"ReasoningPart": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"type": {
"type": "string",
"enum": ["reasoning"]
},
"text": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0
},
"end": {
"type": "integer",
"minimum": 0
}
},
"required": ["start"],
"additionalProperties": false
}
},
"required": ["id", "sessionID", "messageID", "type", "text", "time"],
"additionalProperties": false
},
"FilePartSourceText": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": ["value", "start", "end"],
"additionalProperties": false
},
"FileSource": {
"type": "object",
"properties": {
"text": {
"$ref": "#/components/schemas/FilePartSourceText"
},
"type": {
"type": "string",
"enum": ["file"]
},
"path": {
"type": "string"
}
},
"required": ["text", "type", "path"],
"additionalProperties": false
},
"Range": {
"type": "object",
"properties": {
"start": {
"type": "object",
"properties": {
"line": {
"type": "integer",
"minimum": 0
},
"character": {
"type": "integer",
"minimum": 0
}
},
"required": ["line", "character"],
"additionalProperties": false
},
"end": {
"type": "object",
"properties": {
"line": {
"type": "integer",
"minimum": 0
},
"character": {
"type": "integer",
"minimum": 0
}
},
"required": ["line", "character"],
"additionalProperties": false
}
},
"required": ["start", "end"],
"additionalProperties": false
},
"SymbolSource": {
"type": "object",
"properties": {
"text": {
"$ref": "#/components/schemas/FilePartSourceText"
},
"type": {
"type": "string",
"enum": ["symbol"]
},
"path": {
"type": "string"
},
"range": {
"$ref": "#/components/schemas/Range"
},
"name": {
"type": "string"
},
"kind": {
"type": "integer",
"minimum": 0
}
},
"required": ["text", "type", "path", "range", "name", "kind"],
"additionalProperties": false
},
"ResourceSource": {
"type": "object",
"properties": {
"text": {
"$ref": "#/components/schemas/FilePartSourceText"
},
"type": {
"type": "string",
"enum": ["resource"]
},
"clientName": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": ["text", "type", "clientName", "uri"],
"additionalProperties": false
},
"FilePartSource": {
"anyOf": [
{
"$ref": "#/components/schemas/FileSource"
},
{
"$ref": "#/components/schemas/SymbolSource"
},
{
"$ref": "#/components/schemas/ResourceSource"
}
]
},
"FilePart": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"type": {
"type": "string",
"enum": ["file"]
},
"mime": {
"type": "string"
},
"filename": {
"type": "string"
},
"url": {
"type": "string"
},
"source": {
"$ref": "#/components/schemas/FilePartSource"
}
},
"required": ["id", "sessionID", "messageID", "type", "mime", "url"],
"additionalProperties": false
},
"ToolStatePending": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["pending"]
},
"input": {
"type": "object"
},
"raw": {
"type": "string"
}
},
"required": ["status", "input", "raw"],
"additionalProperties": false
},
"ToolStateRunning": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["running"]
},
"input": {
"type": "object"
},
"title": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0
}
},
"required": ["start"],
"additionalProperties": false
}
},
"required": ["status", "input", "time"],
"additionalProperties": false
},
"ToolStateCompleted": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["completed"]
},
"input": {
"type": "object"
},
"output": {
"type": "string"
},
"title": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0
},
"end": {
"type": "integer",
"minimum": 0
},
"compacted": {
"type": "integer",
"minimum": 0
}
},
"required": ["start", "end"],
"additionalProperties": false
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilePart"
}
}
},
"required": ["status", "input", "output", "title", "metadata", "time"],
"additionalProperties": false
},
"ToolStateError": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["error"]
},
"input": {
"type": "object"
},
"error": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0
},
"end": {
"type": "integer",
"minimum": 0
}
},
"required": ["start", "end"],
"additionalProperties": false
}
},
"required": ["status", "input", "error", "time"],
"additionalProperties": false
},
"ToolState": {
"anyOf": [
{
"$ref": "#/components/schemas/ToolStatePending"
},
{
"$ref": "#/components/schemas/ToolStateRunning"
},
{
"$ref": "#/components/schemas/ToolStateCompleted"
},
{
"$ref": "#/components/schemas/ToolStateError"
}
]
},
"ToolPart": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"type": {
"type": "string",
"enum": ["tool"]
},
"callID": {
"type": "string"
},
"tool": {
"type": "string"
},
"state": {
"$ref": "#/components/schemas/ToolState"
},
"metadata": {
"type": "object"
}
},
"required": ["id", "sessionID", "messageID", "type", "callID", "tool", "state"],
"additionalProperties": false
},
"StepStartPart": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"type": {
"type": "string",
"enum": ["step-start"]
},
"snapshot": {
"type": "string"
}
},
"required": ["id", "sessionID", "messageID", "type"],
"additionalProperties": false
},
"StepFinishPart": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"type": {
"type": "string",
"enum": ["step-finish"]
},
"reason": {
"type": "string"
},
"snapshot": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
}
},
"required": ["providerID", "modelID"],
"additionalProperties": false
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
}
},
"required": ["id", "sessionID", "messageID", "type", "reason", "cost", "tokens"],
"additionalProperties": false
},
"SnapshotPart": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"type": {
"type": "string",
"enum": ["snapshot"]
},
"snapshot": {
"type": "string"
}
},
"required": ["id", "sessionID", "messageID", "type", "snapshot"],
"additionalProperties": false
},
"PatchPart": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"type": {
"type": "string",
"enum": ["patch"]
},
"hash": {
"type": "string"
},
"files": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["id", "sessionID", "messageID", "type", "hash", "files"],
"additionalProperties": false
},
"AgentPart": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"type": {
"type": "string",
"enum": ["agent"]
},
"name": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"start": {
"type": "integer",
"minimum": 0
},
"end": {
"type": "integer",
"minimum": 0
}
},
"required": ["value", "start", "end"],
"additionalProperties": false
}
},
"required": ["id", "sessionID", "messageID", "type", "name"],
"additionalProperties": false
},
"RetryPart": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"type": {
"type": "string",
"enum": ["retry"]
},
"attempt": {
"type": "integer",
"minimum": 0
},
"error": {
"$ref": "#/components/schemas/APIError"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
}
},
"required": ["created"],
"additionalProperties": false
}
},
"required": ["id", "sessionID", "messageID", "type", "attempt", "error", "time"],
"additionalProperties": false
},
"CompactionPart": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"type": {
"type": "string",
"enum": ["compaction"]
},
"auto": {
"type": "boolean"
},
"overflow": {
"type": "boolean"
},
"tail_start_id": {
"type": "string",
"pattern": "^msg"
}
},
"required": ["id", "sessionID", "messageID", "type", "auto"],
"additionalProperties": false
},
"Part": {
"anyOf": [
{
"$ref": "#/components/schemas/TextPart"
},
{
"$ref": "#/components/schemas/SubtaskPart"
},
{
"$ref": "#/components/schemas/ReasoningPart"
},
{
"$ref": "#/components/schemas/FilePart"
},
{
"$ref": "#/components/schemas/ToolPart"
},
{
"$ref": "#/components/schemas/StepStartPart"
},
{
"$ref": "#/components/schemas/StepFinishPart"
},
{
"$ref": "#/components/schemas/SnapshotPart"
},
{
"$ref": "#/components/schemas/PatchPart"
},
{
"$ref": "#/components/schemas/AgentPart"
},
{
"$ref": "#/components/schemas/RetryPart"
},
{
"$ref": "#/components/schemas/CompactionPart"
}
]
},
"Prompt": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PromptFileAttachment"
}
},
"agents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PromptAgentAttachment"
}
},
"references": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PromptReferenceAttachment"
}
}
},
"required": ["text"],
"additionalProperties": false
},
"QuestionOption": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Display text (1-5 words, concise)"
},
"description": {
"type": "string",
"description": "Explanation of choice"
},
"labelKey": {
"type": "string"
},
"descriptionKey": {
"type": "string"
},
"mode": {
"type": "string"
}
},
"required": ["label", "description"],
"additionalProperties": false
},
"QuestionInfo": {
"type": "object",
"properties": {
"question": {
"type": "string",
"description": "Complete question"
},
"header": {
"type": "string",
"description": "Very short label (max 30 chars)"
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionOption"
},
"description": "Available choices"
},
"multiple": {
"type": "boolean"
},
"questionKey": {
"type": "string"
},
"headerKey": {
"type": "string"
},
"custom": {
"type": "boolean"
}
},
"required": ["question", "header", "options"],
"additionalProperties": false
},
"QuestionTool": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"callID": {
"type": "string"
}
},
"required": ["messageID", "callID"],
"additionalProperties": false
},
"QuestionAnswer": {
"type": "array",
"items": {
"type": "string"
}
},
"Event.tui.prompt.append": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["tui.prompt.append"]
},
"properties": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"required": ["text"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"Event.tui.command.execute": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["tui.command.execute"]
},
"properties": {
"type": "object",
"properties": {
"command": {
"anyOf": [
{
"type": "string",
"enum": [
"session.list",
"session.new",
"session.share",
"session.interrupt",
"session.compact",
"session.page.up",
"session.page.down",
"session.line.up",
"session.line.down",
"session.half.page.up",
"session.half.page.down",
"session.first",
"session.last",
"prompt.clear",
"prompt.submit",
"agent.cycle"
]
},
{
"type": "string"
}
]
}
},
"required": ["command"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"Event.tui.toast.show": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["tui.toast.show"]
},
"properties": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"message": {
"type": "string"
},
"variant": {
"type": "string",
"enum": ["info", "success", "warning", "error"]
},
"duration": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"required": ["message", "variant"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"Event.tui.session.select": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["tui.session.select"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses",
"description": "Session ID to navigate to"
}
},
"required": ["sessionID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"AgentRequirementError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["AgentRequirementError"]
},
"data": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"agent": {
"type": "string"
},
"directory": {
"type": "string"
},
"state": {
"type": "string",
"enum": ["blocked", "error"]
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": ["ready", "missing", "error"]
},
"message": {
"type": "string"
}
},
"required": ["name", "status"],
"additionalProperties": false
}
},
"mcps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": ["ready", "missing", "error"]
},
"message": {
"type": "string"
}
},
"required": ["name", "status"],
"additionalProperties": false
}
},
"vscode_extensions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "\\S"
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$"
}
},
"required": ["name", "id"],
"additionalProperties": false
}
}
},
"required": ["message", "agent", "directory", "state", "skills", "mcps", "vscode_extensions"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"SessionStatus": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["idle"]
}
},
"required": ["type"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["retry"]
},
"attempt": {
"type": "integer",
"minimum": 0
},
"message": {
"type": "string"
},
"action": {
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"provider": {
"type": "string"
},
"title": {
"type": "string"
},
"message": {
"type": "string"
},
"label": {
"type": "string"
},
"link": {
"type": "string"
}
},
"required": ["reason", "provider", "title", "message", "label"],
"additionalProperties": false
},
"next": {
"type": "integer",
"minimum": 0
}
},
"required": ["type", "attempt", "message", "next"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["busy"]
}
},
"required": ["type"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["offline"]
},
"requestID": {
"type": "string",
"pattern": "^que"
},
"message": {
"type": "string"
}
},
"required": ["type", "requestID", "message"],
"additionalProperties": false
}
]
},
"Pty": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^pty"
},
"title": {
"type": "string"
},
"command": {
"type": "string"
},
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"cwd": {
"type": "string"
},
"status": {
"type": "string",
"enum": ["running", "exited"]
},
"pid": {
"type": "integer",
"minimum": 0
},
"sessionID": {
"anyOf": [
{
"type": "string",
"pattern": "^ses"
},
{
"type": "null"
}
]
}
},
"required": ["id", "title", "command", "args", "cwd", "status", "pid"],
"additionalProperties": false
},
"GlobalEvent": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"project": {
"type": "string"
},
"workspace": {
"type": "string"
},
"payload": {
"anyOf": [
{
"$ref": "#/components/schemas/EventServerInstanceDisposed"
},
{
"$ref": "#/components/schemas/EventSessionNetworkAsked"
},
{
"$ref": "#/components/schemas/EventSessionNetworkReplied"
},
{
"$ref": "#/components/schemas/EventSessionNetworkRejected"
},
{
"$ref": "#/components/schemas/EventSessionNetworkRestored"
},
{
"$ref": "#/components/schemas/EventBackground_processUpdated"
},
{
"$ref": "#/components/schemas/EventBackground_processDeleted"
},
{
"$ref": "#/components/schemas/EventInteractive_terminalUpdated"
},
{
"$ref": "#/components/schemas/EventInteractive_terminalData"
},
{
"$ref": "#/components/schemas/EventInteractive_terminalDeleted"
},
{
"$ref": "#/components/schemas/EventSessionTurnOpen"
},
{
"$ref": "#/components/schemas/EventSessionTurnClose"
},
{
"$ref": "#/components/schemas/EventSandboxStatusChanged"
},
{
"$ref": "#/components/schemas/EventSuggestionShown"
},
{
"$ref": "#/components/schemas/EventSuggestionAccepted"
},
{
"$ref": "#/components/schemas/EventSuggestionDismissed"
},
{
"$ref": "#/components/schemas/EventKilocodeAgent_managerStart"
},
{
"$ref": "#/components/schemas/EventKilocodeAgent_managerRequested"
},
{
"$ref": "#/components/schemas/EventKilocodeAgent_managerCancelled"
},
{
"$ref": "#/components/schemas/EventKilocodeNotebookRequested"
},
{
"$ref": "#/components/schemas/EventKilocodeNotebookCancelled"
},
{
"$ref": "#/components/schemas/EventLspClientDiagnostics"
},
{
"$ref": "#/components/schemas/EventKilo-sessionsRemote-status-changed"
},
{
"$ref": "#/components/schemas/EventMemoryStatus"
},
{
"$ref": "#/components/schemas/EventMemoryUpdated"
},
{
"$ref": "#/components/schemas/EventMemoryError"
},
{
"$ref": "#/components/schemas/EventIndexingStatus"
},
{
"$ref": "#/components/schemas/EventIndexingWarning"
},
{
"$ref": "#/components/schemas/EventServerConnected"
},
{
"$ref": "#/components/schemas/EventGlobalDisposed"
},
{
"$ref": "#/components/schemas/EventGlobalConfigUpdated"
},
{
"$ref": "#/components/schemas/EventPluginAdded"
},
{
"$ref": "#/components/schemas/EventCatalogModelUpdated"
},
{
"$ref": "#/components/schemas/EventSessionCreated"
},
{
"$ref": "#/components/schemas/EventSessionUpdated"
},
{
"$ref": "#/components/schemas/EventSessionDeleted"
},
{
"$ref": "#/components/schemas/EventMessageUpdated"
},
{
"$ref": "#/components/schemas/EventMessageRemoved"
},
{
"$ref": "#/components/schemas/EventMessagePartUpdated"
},
{
"$ref": "#/components/schemas/EventMessagePartRemoved"
},
{
"$ref": "#/components/schemas/EventSessionNextAgentSwitched"
},
{
"$ref": "#/components/schemas/EventSessionNextModelSwitched"
},
{
"$ref": "#/components/schemas/EventSessionNextMoved"
},
{
"$ref": "#/components/schemas/EventSessionNextPrompted"
},
{
"$ref": "#/components/schemas/EventSessionNextPromptAdmitted"
},
{
"$ref": "#/components/schemas/EventSessionNextPromptPromoted"
},
{
"$ref": "#/components/schemas/EventSessionNextContextUpdated"
},
{
"$ref": "#/components/schemas/EventSessionNextSynthetic"
},
{
"$ref": "#/components/schemas/EventSessionNextShellStarted"
},
{
"$ref": "#/components/schemas/EventSessionNextShellEnded"
},
{
"$ref": "#/components/schemas/EventSessionNextStepStarted"
},
{
"$ref": "#/components/schemas/EventSessionNextStepEnded"
},
{
"$ref": "#/components/schemas/EventSessionNextStepFailed"
},
{
"$ref": "#/components/schemas/EventSessionNextTextStarted"
},
{
"$ref": "#/components/schemas/EventSessionNextTextDelta"
},
{
"$ref": "#/components/schemas/EventSessionNextTextEnded"
},
{
"$ref": "#/components/schemas/EventSessionNextReasoningStarted"
},
{
"$ref": "#/components/schemas/EventSessionNextReasoningDelta"
},
{
"$ref": "#/components/schemas/EventSessionNextReasoningEnded"
},
{
"$ref": "#/components/schemas/EventSessionNextToolInputStarted"
},
{
"$ref": "#/components/schemas/EventSessionNextToolInputDelta"
},
{
"$ref": "#/components/schemas/EventSessionNextToolInputEnded"
},
{
"$ref": "#/components/schemas/EventSessionNextToolCalled"
},
{
"$ref": "#/components/schemas/EventSessionNextToolProgress"
},
{
"$ref": "#/components/schemas/EventSessionNextToolSuccess"
},
{
"$ref": "#/components/schemas/EventSessionNextToolFailed"
},
{
"$ref": "#/components/schemas/EventSessionNextRetried"
},
{
"$ref": "#/components/schemas/EventSessionNextCompactionStarted"
},
{
"$ref": "#/components/schemas/EventSessionNextCompactionDelta"
},
{
"$ref": "#/components/schemas/EventSessionNextCompactionEnded"
},
{
"$ref": "#/components/schemas/EventQuestionAsked"
},
{
"$ref": "#/components/schemas/EventQuestionReplied"
},
{
"$ref": "#/components/schemas/EventQuestionRejected"
},
{
"$ref": "#/components/schemas/Event.tui.prompt.append"
},
{
"$ref": "#/components/schemas/Event.tui.command.execute"
},
{
"$ref": "#/components/schemas/Event.tui.toast.show"
},
{
"$ref": "#/components/schemas/Event.tui.session.select"
},
{
"$ref": "#/components/schemas/EventMcpToolsChanged"
},
{
"$ref": "#/components/schemas/EventMcpBrowserOpenFailed"
},
{
"$ref": "#/components/schemas/EventMessagePartDelta"
},
{
"$ref": "#/components/schemas/EventSessionDiff"
},
{
"$ref": "#/components/schemas/EventSessionError"
},
{
"$ref": "#/components/schemas/EventModels-devRefreshed"
},
{
"$ref": "#/components/schemas/EventInstallationUpdated"
},
{
"$ref": "#/components/schemas/EventInstallationUpdate-available"
},
{
"$ref": "#/components/schemas/EventPermissionAsked"
},
{
"$ref": "#/components/schemas/EventPermissionReplied"
},
{
"$ref": "#/components/schemas/EventTodoUpdated"
},
{
"$ref": "#/components/schemas/EventSessionStatus"
},
{
"$ref": "#/components/schemas/EventSessionIdle"
},
{
"$ref": "#/components/schemas/EventSessionCompacted"
},
{
"$ref": "#/components/schemas/EventCommandExecuted"
},
{
"$ref": "#/components/schemas/EventProjectDirectoriesUpdated"
},
{
"$ref": "#/components/schemas/EventProjectUpdated"
},
{
"$ref": "#/components/schemas/EventLspUpdated"
},
{
"$ref": "#/components/schemas/EventFileEdited"
},
{
"$ref": "#/components/schemas/EventFileWatcherUpdated"
},
{
"$ref": "#/components/schemas/EventVcsBranchUpdated"
},
{
"$ref": "#/components/schemas/EventWorkspaceReady"
},
{
"$ref": "#/components/schemas/EventWorkspaceFailed"
},
{
"$ref": "#/components/schemas/EventWorkspaceStatus"
},
{
"$ref": "#/components/schemas/EventWorktreeReady"
},
{
"$ref": "#/components/schemas/EventWorktreeFailed"
},
{
"$ref": "#/components/schemas/EventAccountAdded"
},
{
"$ref": "#/components/schemas/EventAccountRemoved"
},
{
"$ref": "#/components/schemas/EventAccountSwitched"
},
{
"$ref": "#/components/schemas/EventPermissionV2Asked"
},
{
"$ref": "#/components/schemas/EventPermissionV2Replied"
},
{
"$ref": "#/components/schemas/EventPtyCreated"
},
{
"$ref": "#/components/schemas/EventPtyUpdated"
},
{
"$ref": "#/components/schemas/EventPtyExited"
},
{
"$ref": "#/components/schemas/EventPtyDeleted"
},
{
"$ref": "#/components/schemas/EventQuestionV2Asked"
},
{
"$ref": "#/components/schemas/EventQuestionV2Replied"
},
{
"$ref": "#/components/schemas/EventQuestionV2Rejected"
},
{
"$ref": "#/components/schemas/EventServerInstanceDisposed"
},
{
"$ref": "#/components/schemas/SyncEventSessionCreated"
},
{
"$ref": "#/components/schemas/SyncEventSessionUpdated"
},
{
"$ref": "#/components/schemas/SyncEventSessionDeleted"
},
{
"$ref": "#/components/schemas/SyncEventMessageUpdated"
},
{
"$ref": "#/components/schemas/SyncEventMessageRemoved"
},
{
"$ref": "#/components/schemas/SyncEventMessagePartUpdated"
},
{
"$ref": "#/components/schemas/SyncEventMessagePartRemoved"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextAgentSwitched"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextModelSwitched"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextMoved"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextPrompted"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextPromptAdmitted"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextPromptPromoted"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextContextUpdated"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextSynthetic"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextShellStarted"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextShellEnded"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextStepStarted"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextStepEnded"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextStepFailed"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextTextStarted"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextTextEnded"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextReasoningStarted"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextReasoningEnded"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextToolInputStarted"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextToolInputEnded"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextToolCalled"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextToolProgress"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextToolSuccess"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextToolFailed"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextRetried"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextCompactionStarted"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextCompactionDelta"
},
{
"$ref": "#/components/schemas/SyncEventSessionNextCompactionEnded"
}
]
}
},
"required": ["directory", "payload"],
"additionalProperties": false
},
"LogLevel": {
"type": "string",
"enum": ["DEBUG", "INFO", "WARN", "ERROR"],
"description": "Log level"
},
"ServerConfig": {
"type": "object",
"properties": {
"port": {
"type": "integer",
"exclusiveMinimum": 0
},
"hostname": {
"type": "string"
},
"mdns": {
"type": "boolean"
},
"mdnsDomain": {
"type": "string"
},
"cors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"description": "Server configuration for the kilo serve command"
},
"ReferenceConfigEntry": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"repository": {
"type": "string",
"description": "Git repository URL, host/path reference, or GitHub owner/repo shorthand"
},
"branch": {
"type": "string"
}
},
"required": ["repository"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Absolute path, ~/ path, or workspace-relative path to a local reference directory"
}
},
"required": ["path"],
"additionalProperties": false
}
]
},
"ReferenceConfig": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ReferenceConfigEntry"
}
},
"IndexingConfig": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"provider": {
"type": "string",
"enum": [
"kilo",
"openai",
"ollama",
"openai-compatible",
"gemini",
"mistral",
"vercel-ai-gateway",
"bedrock",
"openrouter",
"voyage"
]
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"dimension": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"vectorStore": {
"type": "string",
"enum": ["lancedb", "qdrant"]
},
"kilo": {
"type": "object",
"properties": {
"apiKey": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"organizationId": {
"type": "string"
}
},
"additionalProperties": false
},
"openai": {
"type": "object",
"properties": {
"apiKey": {
"type": "string"
}
},
"additionalProperties": false
},
"ollama": {
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
}
},
"additionalProperties": false
},
"openai-compatible": {
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiKey": {
"type": "string"
}
},
"additionalProperties": false
},
"gemini": {
"type": "object",
"properties": {
"apiKey": {
"type": "string"
}
},
"additionalProperties": false
},
"mistral": {
"type": "object",
"properties": {
"apiKey": {
"type": "string"
}
},
"additionalProperties": false
},
"vercel-ai-gateway": {
"type": "object",
"properties": {
"apiKey": {
"type": "string"
}
},
"additionalProperties": false
},
"bedrock": {
"type": "object",
"properties": {
"region": {
"type": "string"
},
"profile": {
"type": "string"
}
},
"additionalProperties": false
},
"openrouter": {
"type": "object",
"properties": {
"apiKey": {
"type": "string"
},
"specificProvider": {
"type": "string"
}
},
"additionalProperties": false
},
"voyage": {
"type": "object",
"properties": {
"apiKey": {
"type": "string"
}
},
"additionalProperties": false
},
"qdrant": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"apiKey": {
"type": "string"
}
},
"additionalProperties": false
},
"lancedb": {
"type": "object",
"properties": {
"directory": {
"type": "string"
}
},
"additionalProperties": false
},
"searchMinScore": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"searchMaxResults": {
"type": "integer",
"exclusiveMinimum": 0
},
"embeddingBatchSize": {
"type": "integer",
"exclusiveMinimum": 0
},
"scannerMaxBatchRetries": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"PermissionActionConfig": {
"type": "string",
"enum": ["ask", "allow", "deny"]
},
"PermissionObjectConfig": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PermissionActionConfig"
}
},
"PermissionRuleConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/PermissionActionConfig"
},
{
"$ref": "#/components/schemas/PermissionObjectConfig"
}
]
},
"PermissionConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/PermissionActionConfig"
},
{
"type": "object",
"properties": {
"read": {
"$ref": "#/components/schemas/PermissionRuleConfig"
},
"edit": {
"$ref": "#/components/schemas/PermissionRuleConfig"
},
"glob": {
"$ref": "#/components/schemas/PermissionRuleConfig"
},
"grep": {
"$ref": "#/components/schemas/PermissionRuleConfig"
},
"list": {
"$ref": "#/components/schemas/PermissionRuleConfig"
},
"bash": {
"$ref": "#/components/schemas/PermissionRuleConfig"
},
"task": {
"$ref": "#/components/schemas/PermissionRuleConfig"
},
"external_directory": {
"$ref": "#/components/schemas/PermissionRuleConfig"
},
"todowrite": {
"$ref": "#/components/schemas/PermissionActionConfig"
},
"question": {
"$ref": "#/components/schemas/PermissionActionConfig"
},
"webfetch": {
"$ref": "#/components/schemas/PermissionActionConfig"
},
"websearch": {
"$ref": "#/components/schemas/PermissionActionConfig"
},
"lsp": {
"$ref": "#/components/schemas/PermissionRuleConfig"
},
"doom_loop": {
"$ref": "#/components/schemas/PermissionActionConfig"
},
"skill": {
"$ref": "#/components/schemas/PermissionRuleConfig"
},
"agent_manager": {
"$ref": "#/components/schemas/PermissionRuleConfig"
},
"notebook_read": {
"$ref": "#/components/schemas/PermissionRuleConfig"
},
"notebook_edit": {
"$ref": "#/components/schemas/PermissionRuleConfig"
},
"notebook_execute": {
"$ref": "#/components/schemas/PermissionRuleConfig"
}
},
"additionalProperties": {
"$ref": "#/components/schemas/PermissionRuleConfig"
}
}
]
},
"AgentConfig": {
"type": "object",
"properties": {
"model": {
"type": "string"
},
"variant": {
"type": "string"
},
"temperature": {
"type": "number"
},
"top_p": {
"type": "number"
},
"prompt": {
"type": "string"
},
"tools": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"disable": {
"type": "boolean"
},
"description": {
"type": "string"
},
"mode": {
"type": "string",
"enum": ["subagent", "primary", "all"]
},
"displayName": {
"type": "string"
},
"source": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"options": {
"type": "object"
},
"color": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
{
"type": "string",
"enum": ["primary", "secondary", "accent", "success", "warning", "error", "info"]
}
],
"description": "Hex color code (e.g., #FF5733) or theme color (e.g., primary)"
},
"steps": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxSteps": {
"type": "integer",
"exclusiveMinimum": 0
},
"permission": {
"$ref": "#/components/schemas/PermissionConfig"
},
"requirements": {
"type": "object",
"properties": {
"skills": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "\\S"
},
"minItems": 1,
"maxItems": 20
},
"mcps": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "\\S"
},
"minItems": 1,
"maxItems": 20
},
"vscode_extensions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "\\S"
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$"
}
},
"required": ["name", "id"],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 20
}
},
"additionalProperties": false
}
},
"additionalProperties": {}
},
"ProviderConfig": {
"type": "object",
"properties": {
"api": {
"type": "string"
},
"name": {
"type": "string"
},
"env": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"type": "string"
},
"npm": {
"type": "string"
},
"whitelist": {
"type": "array",
"items": {
"type": "string"
}
},
"blacklist": {
"type": "array",
"items": {
"type": "string"
}
},
"options": {
"type": "object",
"properties": {
"apiKey": {
"type": "string"
},
"baseURL": {
"type": "string"
},
"enterpriseUrl": {
"type": "string"
},
"setCacheKey": {
"type": "boolean"
},
"timeout": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "boolean",
"enum": [false]
}
],
"description": "Timeout in milliseconds for full requests to this provider. Set to false to disable timeout."
},
"headerTimeout": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "boolean",
"enum": [false]
}
],
"description": "Timeout in milliseconds to wait for response headers. Provider integrations may set defaults. Set to false to disable timeout."
},
"chunkTimeout": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"additionalProperties": {}
},
"models": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"family": {
"type": "string"
},
"prompt": {
"type": "string",
"enum": [
"codex",
"gemini",
"beast",
"anthropic",
"trinity",
"anthropic_without_todo",
"ling",
"gpt55"
]
},
"isFree": {
"type": "boolean"
},
"ai_sdk_provider": {
"type": "string",
"enum": ["alibaba", "anthropic", "mistral", "openai", "openai-compatible", "openrouter"]
},
"release_date": {
"type": "string"
},
"attachment": {
"type": "boolean"
},
"reasoning": {
"type": "boolean"
},
"temperature": {
"type": "boolean"
},
"tool_call": {
"type": "boolean"
},
"interleaved": {
"anyOf": [
{
"type": "boolean",
"enum": [true]
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": ["reasoning_content", "reasoning_details"]
}
},
"required": ["field"],
"additionalProperties": false
}
]
},
"cost": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"cache_read": {
"type": "number"
},
"cache_write": {
"type": "number"
},
"context_over_200k": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"cache_read": {
"type": "number"
},
"cache_write": {
"type": "number"
}
},
"required": ["input", "output"],
"additionalProperties": false
}
},
"required": ["input", "output"],
"additionalProperties": false
},
"limit": {
"type": "object",
"properties": {
"context": {
"type": "number"
},
"input": {
"type": "number"
},
"output": {
"type": "number"
}
},
"required": ["context", "output"],
"additionalProperties": false
},
"modalities": {
"type": "object",
"properties": {
"input": {
"type": "array",
"items": {
"type": "string",
"enum": ["text", "audio", "image", "video", "pdf"]
}
},
"output": {
"type": "array",
"items": {
"type": "string",
"enum": ["text", "audio", "image", "video", "pdf"]
}
}
},
"additionalProperties": false
},
"experimental": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": ["alpha", "beta", "deprecated", "active"]
},
"provider": {
"type": "object",
"properties": {
"npm": {
"type": "string"
},
"api": {
"type": "string"
}
},
"additionalProperties": false
},
"options": {
"type": "object"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"variants": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"disabled": {
"type": "boolean"
}
},
"additionalProperties": {}
},
"description": "Variant-specific configuration"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"McpLocalConfig": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["local"]
},
"command": {
"type": "array",
"items": {
"type": "string"
}
},
"environment": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"env": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"enabled": {
"type": "boolean"
},
"timeout": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"required": ["type", "command"],
"additionalProperties": false
},
"McpOAuthConfig": {
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"scope": {
"type": "string"
},
"callbackPort": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"redirectUri": {
"type": "string"
}
},
"additionalProperties": false
},
"McpRemoteConfig": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["remote"],
"description": "Type of MCP server connection"
},
"url": {
"type": "string",
"description": "URL of the remote MCP server"
},
"enabled": {
"type": "boolean"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"oauth": {
"anyOf": [
{
"$ref": "#/components/schemas/McpOAuthConfig"
},
{
"type": "boolean",
"enum": [false]
}
],
"description": "OAuth authentication configuration for the MCP server. Set to false to disable OAuth auto-detection."
},
"timeout": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"required": ["type", "url"],
"additionalProperties": false
},
"LayoutConfig": {
"type": "string",
"enum": ["auto", "stretch"],
"description": "@deprecated Always uses stretch layout."
},
"ImageAttachmentConfig": {
"type": "object",
"properties": {
"auto_resize": {
"type": "boolean"
},
"max_width": {
"type": "integer",
"exclusiveMinimum": 0
},
"max_height": {
"type": "integer",
"exclusiveMinimum": 0
},
"max_base64_bytes": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"AttachmentConfig": {
"type": "object",
"properties": {
"image": {
"$ref": "#/components/schemas/ImageAttachmentConfig"
}
},
"additionalProperties": false
},
"Config": {
"type": "object",
"properties": {
"$schema": {
"type": "string"
},
"shell": {
"type": "string"
},
"logLevel": {
"$ref": "#/components/schemas/LogLevel"
},
"server": {
"$ref": "#/components/schemas/ServerConfig"
},
"command": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"template": {
"type": "string"
},
"description": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "string"
},
"variant": {
"type": "string"
},
"subtask": {
"type": "boolean"
}
},
"required": ["template"],
"additionalProperties": false
}
},
"skills": {
"type": "object",
"properties": {
"paths": {
"type": "array",
"items": {
"type": "string"
}
},
"urls": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"reference": {
"$ref": "#/components/schemas/ReferenceConfig"
},
"watcher": {
"type": "object",
"properties": {
"ignore": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"snapshot": {
"type": "boolean"
},
"plugin": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"prefixItems": [
{
"type": "string"
},
{
"type": "object"
}
],
"maxItems": 2,
"minItems": 2
}
]
}
},
"share": {
"type": "string",
"enum": ["manual", "auto", "disabled"]
},
"autoshare": {
"type": "boolean"
},
"autoupdate": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["notify"]
}
],
"description": "Automatically update to the latest version. Set to true to auto-update, false to disable, or 'notify' to show update notifications"
},
"disabled_providers": {
"type": "array",
"items": {
"type": "string"
}
},
"enabled_providers": {
"type": "array",
"items": {
"type": "string"
}
},
"remote_control": {
"type": "boolean"
},
"auto_collapse_reasoning": {
"type": "boolean"
},
"indexing": {
"$ref": "#/components/schemas/IndexingConfig"
},
"console": {
"type": "object",
"properties": {
"context_sidebar_width": {
"type": "integer",
"minimum": 250,
"maximum": 800,
"description": "Width of the Kilo Console project context sidebar in pixels"
},
"diff_style": {
"type": "string",
"enum": ["unified", "split"]
}
},
"additionalProperties": false
},
"terminal_command_display": {
"type": "string",
"enum": ["expanded", "collapsed"]
},
"code_edit_display": {
"type": "string",
"enum": ["expanded", "collapsed"]
},
"hide_prompt_training_models": {
"type": "boolean"
},
"sandbox": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable sandbox confinement for new sessions (default: false)"
},
"network": {
"type": "string",
"enum": ["allow", "deny"],
"description": "Control outbound network access from sandboxed tools (default: deny)"
},
"writable_paths": {
"type": "array",
"items": {
"type": "string"
},
"description": "Additional filesystem paths that sandboxed tools may write to"
},
"allowed_hosts": {
"type": "array",
"items": {
"type": "string"
},
"description": "Exact network destinations sandboxed tools may access while network restriction is enabled"
}
},
"additionalProperties": false,
"description": "Sandbox configuration for agent tools"
},
"model": {
"type": "string"
},
"small_model": {
"type": "string"
},
"subagent_model": {
"type": "string"
},
"subagent_variant": {
"type": "string"
},
"subagent_variant_overrides": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"default_agent": {
"type": "string"
},
"username": {
"type": "string"
},
"mode": {
"type": "object",
"properties": {
"build": {
"$ref": "#/components/schemas/AgentConfig"
},
"plan": {
"$ref": "#/components/schemas/AgentConfig"
}
},
"additionalProperties": {
"$ref": "#/components/schemas/AgentConfig"
}
},
"agent": {
"type": "object",
"properties": {
"plan": {
"$ref": "#/components/schemas/AgentConfig"
},
"build": {
"$ref": "#/components/schemas/AgentConfig"
},
"debug": {
"$ref": "#/components/schemas/AgentConfig"
},
"orchestrator": {
"$ref": "#/components/schemas/AgentConfig"
},
"ask": {
"$ref": "#/components/schemas/AgentConfig"
},
"general": {
"$ref": "#/components/schemas/AgentConfig"
},
"explore": {
"$ref": "#/components/schemas/AgentConfig"
},
"scout": {
"$ref": "#/components/schemas/AgentConfig"
},
"title": {
"$ref": "#/components/schemas/AgentConfig"
},
"summary": {
"$ref": "#/components/schemas/AgentConfig"
},
"compaction": {
"$ref": "#/components/schemas/AgentConfig"
}
},
"additionalProperties": {
"$ref": "#/components/schemas/AgentConfig"
}
},
"provider": {
"type": "object",
"additionalProperties": {
"anyOf": [
{
"$ref": "#/components/schemas/ProviderConfig"
},
{
"type": "null"
}
]
}
},
"mcp": {
"type": "object",
"additionalProperties": {
"anyOf": [
{
"$ref": "#/components/schemas/McpLocalConfig"
},
{
"$ref": "#/components/schemas/McpRemoteConfig"
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": ["enabled"],
"additionalProperties": false
}
]
}
},
"formatter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"disabled": {
"type": "boolean"
},
"command": {
"type": "array",
"items": {
"type": "string"
}
},
"environment": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"extensions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
}
],
"description": "Enable or configure formatters. Omit or set to false to disable, true to enable built-ins, or an object to enable built-ins with overrides."
},
"lsp": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "object",
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"disabled": {
"type": "boolean",
"enum": [true]
}
},
"required": ["disabled"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"command": {
"type": "array",
"items": {
"type": "string"
}
},
"extensions": {
"type": "array",
"items": {
"type": "string"
}
},
"disabled": {
"type": "boolean"
},
"env": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"initialization": {
"type": "object"
}
},
"required": ["command"],
"additionalProperties": false
}
]
}
}
],
"description": "Enable or configure LSP servers. Omit or set to false to disable, true to enable built-ins, or an object to enable built-ins with overrides."
},
"instructions": {
"type": "array",
"items": {
"type": "string"
}
},
"layout": {
"$ref": "#/components/schemas/LayoutConfig"
},
"permission": {
"$ref": "#/components/schemas/PermissionConfig"
},
"tools": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"attachment": {
"$ref": "#/components/schemas/AttachmentConfig"
},
"enterprise": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"additionalProperties": false
},
"commit_message": {
"type": "object",
"properties": {
"prompt": {
"type": "string"
}
},
"additionalProperties": false
},
"tool_output": {
"type": "object",
"properties": {
"max_lines": {
"type": "integer",
"exclusiveMinimum": 0
},
"max_bytes": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"compaction": {
"type": "object",
"properties": {
"auto": {
"type": "boolean"
},
"threshold_percent": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
],
"description": "Percentage of the model input/context window that triggers automatic compaction. The reserved safety buffer still applies if it would compact sooner."
},
"prune": {
"type": "boolean"
},
"tail_turns": {
"type": "integer",
"minimum": 0
},
"preserve_recent_tokens": {
"type": "integer",
"minimum": 0
},
"reserved": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
"experimental": {
"type": "object",
"properties": {
"disable_paste_summary": {
"type": "boolean"
},
"batch_tool": {
"type": "boolean"
},
"codebase_search": {
"type": "boolean"
},
"image_generation": {
"type": "boolean"
},
"image_generation_model": {
"type": "string"
},
"agent_requirements": {
"type": "boolean"
},
"native_notebook_tools": {
"type": "boolean"
},
"speech_to_text_model": {
"type": "string"
},
"openTelemetry": {
"type": "boolean"
},
"primary_tools": {
"type": "array",
"items": {
"type": "string"
}
},
"continue_loop_on_deny": {
"type": "boolean"
},
"sandbox": {
"type": "boolean"
},
"sandbox_restrict_network": {
"type": "boolean"
},
"sandbox_writable_paths": {
"type": "array",
"items": {
"type": "string"
}
},
"swe_pruner": {
"type": "boolean"
},
"swe_pruner_model": {
"type": "string"
},
"mcp_timeout": {
"type": "integer",
"exclusiveMinimum": 0
},
"policies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigV2ExperimentalPolicy"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"Model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"api": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"npm": {
"type": "string"
}
},
"required": ["id", "url", "npm"],
"additionalProperties": false
},
"name": {
"type": "string"
},
"family": {
"type": "string"
},
"capabilities": {
"type": "object",
"properties": {
"temperature": {
"type": "boolean"
},
"reasoning": {
"type": "boolean"
},
"attachment": {
"type": "boolean"
},
"toolcall": {
"type": "boolean"
},
"input": {
"type": "object",
"properties": {
"text": {
"type": "boolean"
},
"audio": {
"type": "boolean"
},
"image": {
"type": "boolean"
},
"video": {
"type": "boolean"
},
"pdf": {
"type": "boolean"
}
},
"required": ["text", "audio", "image", "video", "pdf"],
"additionalProperties": false
},
"output": {
"type": "object",
"properties": {
"text": {
"type": "boolean"
},
"audio": {
"type": "boolean"
},
"image": {
"type": "boolean"
},
"video": {
"type": "boolean"
},
"pdf": {
"type": "boolean"
}
},
"required": ["text", "audio", "image", "video", "pdf"],
"additionalProperties": false
},
"interleaved": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": ["reasoning_content", "reasoning_details"]
}
},
"required": ["field"],
"additionalProperties": false
}
]
}
},
"required": ["temperature", "reasoning", "attachment", "toolcall", "input", "output", "interleaved"],
"additionalProperties": false
},
"cost": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
},
"tiers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
},
"tier": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["context"]
},
"size": {
"type": "number"
}
},
"required": ["type", "size"],
"additionalProperties": false
}
},
"required": ["input", "output", "cache", "tier"],
"additionalProperties": false
}
},
"experimentalOver200K": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "cache"],
"additionalProperties": false
}
},
"required": ["input", "output", "cache"],
"additionalProperties": false
},
"limit": {
"type": "object",
"properties": {
"context": {
"type": "number"
},
"input": {
"type": "number"
},
"output": {
"type": "number"
}
},
"required": ["context", "output"],
"additionalProperties": false
},
"status": {
"type": "string",
"enum": ["alpha", "beta", "deprecated", "active"]
},
"options": {
"type": "object"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"release_date": {
"type": "string"
},
"variants": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"recommendedIndex": {
"type": "number"
},
"prompt": {
"type": "string",
"enum": ["codex", "gemini", "beast", "anthropic", "trinity", "anthropic_without_todo", "ling", "gpt55"]
},
"isFree": {
"type": "boolean"
},
"mayTrainOnYourPrompts": {
"type": "boolean"
},
"hasUserByokAvailable": {
"type": "boolean"
},
"terminalBench": {
"type": "object",
"properties": {
"overallScore": {
"type": "number"
},
"avgAttemptCostUsd": {
"type": "number"
}
},
"required": ["overallScore", "avgAttemptCostUsd"],
"additionalProperties": false
},
"autoRouting": {
"type": "object",
"properties": {
"models": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["models"],
"additionalProperties": false
},
"ai_sdk_provider": {
"type": "string",
"enum": ["alibaba", "anthropic", "mistral", "openai", "openai-compatible", "openrouter"]
}
},
"required": [
"id",
"providerID",
"api",
"name",
"capabilities",
"cost",
"limit",
"status",
"options",
"headers",
"release_date"
],
"additionalProperties": false
},
"Provider": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"source": {
"type": "string",
"enum": ["env", "config", "custom", "api"]
},
"env": {
"type": "array",
"items": {
"type": "string"
}
},
"key": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"noteKey": {
"type": "string"
},
"icon": {
"type": "string"
},
"priority": {
"type": "integer"
}
},
"additionalProperties": false
},
"options": {
"type": "object"
},
"models": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Model"
}
}
},
"required": ["id", "name", "source", "env", "options", "models"],
"additionalProperties": false
},
"ConsoleState": {
"type": "object",
"properties": {
"consoleManagedProviders": {
"type": "array",
"items": {
"type": "string"
}
},
"activeOrgName": {
"type": "string"
},
"switchableOrgCount": {
"type": "integer",
"minimum": 0
}
},
"required": ["consoleManagedProviders", "switchableOrgCount"],
"additionalProperties": false
},
"effect_HttpApiError_InternalServerError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["InternalServerError"]
}
},
"required": ["_tag"],
"additionalProperties": false
},
"ToolListItem": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"description": {
"type": "string"
},
"parameters": {}
},
"required": ["id", "description", "parameters"],
"additionalProperties": false
},
"ToolList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ToolListItem"
}
},
"ToolIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"WorktreeListItem": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"managed": {
"type": "boolean"
}
},
"required": ["directory", "managed"],
"additionalProperties": false
},
"WorktreeError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"WorktreeNotGitError",
"WorktreeNameGenerationFailedError",
"WorktreeCreateFailedError",
"WorktreeStartCommandFailedError",
"WorktreeRemoveFailedError",
"WorktreeResetFailedError",
"WorktreeListFailedError"
]
},
"data": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": ["message"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"WorktreeCreateInput": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"startCommand": {
"type": "string",
"description": "Additional startup script to run after the project's start command"
}
},
"additionalProperties": false
},
"Worktree": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"branch": {
"type": "string"
},
"directory": {
"type": "string"
}
},
"required": ["name", "directory"],
"additionalProperties": false
},
"WorktreeRemoveInput": {
"type": "object",
"properties": {
"directory": {
"type": "string"
}
},
"required": ["directory"],
"additionalProperties": false
},
"WorktreeResetInput": {
"type": "object",
"properties": {
"directory": {
"type": "string"
}
},
"required": ["directory"],
"additionalProperties": false
},
"WorktreeDiffItem": {
"type": "object",
"properties": {
"file": {
"type": "string"
},
"patch": {
"type": "string"
},
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"status": {
"type": "string",
"enum": ["added", "deleted", "modified"]
},
"before": {
"type": "string"
},
"after": {
"type": "string"
},
"tracked": {
"type": "boolean"
},
"generatedLike": {
"type": "boolean"
},
"summarized": {
"type": "boolean"
},
"stamp": {
"type": "string"
}
},
"required": ["additions", "deletions", "before", "after", "tracked", "generatedLike", "summarized", "stamp"],
"additionalProperties": false
},
"SnapshotSummaryFileDiff": {
"type": "object",
"properties": {
"file": {
"type": "string"
},
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"status": {
"type": "string",
"enum": ["added", "deleted", "modified"]
}
},
"required": ["additions", "deletions"],
"additionalProperties": false
},
"ProjectSummary": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"worktree": {
"type": "string"
}
},
"required": ["id", "worktree"],
"additionalProperties": false
},
"GlobalSession": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^ses"
},
"slug": {
"type": "string"
},
"projectID": {
"type": "string"
},
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"directory": {
"type": "string"
},
"path": {
"type": "string"
},
"parentID": {
"type": "string",
"pattern": "^ses"
},
"summary": {
"type": "object",
"properties": {
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"files": {
"type": "number"
},
"diffs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotSummaryFileDiff"
}
}
},
"required": ["additions", "deletions", "files"],
"additionalProperties": false
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"share": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": ["url"],
"additionalProperties": false
},
"title": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"version": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"compacting": {
"type": "integer",
"minimum": 0
},
"archived": {
"type": "number"
}
},
"required": ["created", "updated"],
"additionalProperties": false
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
"revert": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
},
"snapshot": {
"type": "string"
},
"diff": {
"type": "string"
}
},
"required": ["messageID"],
"additionalProperties": false
},
"project": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectSummary"
},
{
"type": "null"
}
]
},
"worktreeName": {
"type": "string"
}
},
"required": ["id", "slug", "projectID", "directory", "title", "version", "time", "project"],
"additionalProperties": false
},
"McpResource": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"description": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"client": {
"type": "string"
}
},
"required": ["name", "uri", "client"],
"additionalProperties": false
},
"Symbol": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"kind": {
"type": "integer",
"minimum": 0
},
"location": {
"type": "object",
"properties": {
"uri": {
"type": "string"
},
"range": {
"$ref": "#/components/schemas/Range"
}
},
"required": ["uri", "range"],
"additionalProperties": false
}
},
"required": ["name", "kind", "location"],
"additionalProperties": false
},
"FileNode": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"absolute": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["file", "directory"]
},
"ignored": {
"type": "boolean"
}
},
"required": ["name", "path", "absolute", "type", "ignored"],
"additionalProperties": false
},
"FileContent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["text", "binary"]
},
"content": {
"type": "string"
},
"diff": {
"type": "string"
},
"patch": {
"type": "object",
"properties": {
"oldFileName": {
"type": "string"
},
"newFileName": {
"type": "string"
},
"oldHeader": {
"type": "string"
},
"newHeader": {
"type": "string"
},
"hunks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"oldStart": {
"type": "integer",
"minimum": 0
},
"oldLines": {
"type": "integer",
"minimum": 0
},
"newStart": {
"type": "integer",
"minimum": 0
},
"newLines": {
"type": "integer",
"minimum": 0
},
"lines": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["oldStart", "oldLines", "newStart", "newLines", "lines"],
"additionalProperties": false
}
},
"index": {
"type": "string"
}
},
"required": ["oldFileName", "newFileName", "hunks"],
"additionalProperties": false
},
"encoding": {
"type": "string",
"enum": ["base64"]
},
"mimeType": {
"type": "string"
}
},
"required": ["type", "content"],
"additionalProperties": false
},
"File": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"added": {
"type": "integer",
"minimum": 0
},
"removed": {
"type": "integer",
"minimum": 0
},
"status": {
"type": "string",
"enum": ["added", "deleted", "modified"]
}
},
"required": ["path", "added", "removed", "status"],
"additionalProperties": false
},
"Path": {
"type": "object",
"properties": {
"home": {
"type": "string"
},
"state": {
"type": "string"
},
"config": {
"type": "string"
},
"worktree": {
"type": "string"
},
"directory": {
"type": "string"
}
},
"required": ["home", "state", "config", "worktree", "directory"],
"additionalProperties": false
},
"VcsInfo": {
"type": "object",
"properties": {
"branch": {
"type": "string"
},
"default_branch": {
"type": "string"
}
},
"additionalProperties": false
},
"VcsFileStatus": {
"type": "object",
"properties": {
"file": {
"type": "string"
},
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"status": {
"type": "string",
"enum": ["added", "deleted", "modified"]
}
},
"required": ["file", "additions", "deletions", "status"],
"additionalProperties": false
},
"VcsFileDiff": {
"type": "object",
"properties": {
"file": {
"type": "string"
},
"patch": {
"type": "string"
},
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"status": {
"type": "string",
"enum": ["added", "deleted", "modified"]
}
},
"required": ["file", "additions", "deletions"],
"additionalProperties": false
},
"VcsApplyError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["VcsApplyError"]
},
"data": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"reason": {
"type": "string",
"enum": ["non-git", "not-clean"]
}
},
"required": ["message", "reason"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"Command": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "string"
},
"source": {
"type": "string",
"enum": ["command", "mcp", "skill"]
},
"template": {
"type": "string"
},
"subtask": {
"type": "boolean"
},
"hints": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["name", "template", "hints"],
"additionalProperties": false
},
"Agent": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"displayName": {
"type": "string"
},
"source": {
"type": "string"
},
"description": {
"type": "string"
},
"deprecated": {
"type": "boolean"
},
"mode": {
"type": "string",
"enum": ["subagent", "primary", "all"]
},
"native": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"topP": {
"type": "number"
},
"temperature": {
"type": "number"
},
"color": {
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
"model": {
"type": "object",
"properties": {
"modelID": {
"type": "string"
},
"providerID": {
"type": "string"
}
},
"required": ["modelID", "providerID"],
"additionalProperties": false
},
"variant": {
"type": "string"
},
"prompt": {
"type": "string"
},
"options": {
"type": "object"
},
"requirements": {
"type": "object",
"properties": {
"skills": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "\\S"
},
"minItems": 1,
"maxItems": 20
},
"mcps": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "\\S"
},
"minItems": 1,
"maxItems": 20
},
"vscode_extensions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "\\S"
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$"
}
},
"required": ["name", "id"],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 20
}
},
"additionalProperties": false
},
"steps": {
"type": "number"
}
},
"required": ["name", "mode", "permission", "options"],
"additionalProperties": false
},
"LSPStatus": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"root": {
"type": "string"
},
"status": {
"type": "string",
"enum": ["connected", "error"]
}
},
"required": ["id", "name", "root", "status"],
"additionalProperties": false
},
"FormatterStatus": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"extensions": {
"type": "array",
"items": {
"type": "string"
}
},
"enabled": {
"type": "boolean"
}
},
"required": ["name", "extensions", "enabled"],
"additionalProperties": false
},
"MCPStatusConnected": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["connected"]
}
},
"required": ["status"],
"additionalProperties": false
},
"MCPStatusDisabled": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["disabled"]
}
},
"required": ["status"],
"additionalProperties": false
},
"MCPStatusFailed": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["failed"]
},
"error": {
"type": "string"
}
},
"required": ["status", "error"],
"additionalProperties": false
},
"MCPStatusNeedsAuth": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["needs_auth"]
}
},
"required": ["status"],
"additionalProperties": false
},
"MCPStatusNeedsClientRegistration": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["needs_client_registration"]
},
"error": {
"type": "string"
}
},
"required": ["status", "error"],
"additionalProperties": false
},
"MCPStatus": {
"anyOf": [
{
"$ref": "#/components/schemas/MCPStatusConnected"
},
{
"$ref": "#/components/schemas/MCPStatusDisabled"
},
{
"$ref": "#/components/schemas/MCPStatusFailed"
},
{
"$ref": "#/components/schemas/MCPStatusNeedsAuth"
},
{
"$ref": "#/components/schemas/MCPStatusNeedsClientRegistration"
}
]
},
"McpUnsupportedOAuthError": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
},
"required": ["error"],
"additionalProperties": false
},
"McpServerNotFoundError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["McpServerNotFoundError"]
},
"name": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": ["_tag", "name", "message"],
"additionalProperties": false
},
"Project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"worktree": {
"type": "string"
},
"vcs": {
"type": "string",
"enum": ["git"]
},
"name": {
"type": "string"
},
"icon": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"override": {
"type": "string"
},
"color": {
"type": "string"
}
},
"additionalProperties": false
},
"commands": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "Startup script to run when creating a new workspace (worktree)"
}
},
"additionalProperties": false
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"initialized": {
"type": "integer",
"minimum": 0
}
},
"required": ["created", "updated"],
"additionalProperties": false
},
"sandboxes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["id", "worktree", "time", "sandboxes"],
"additionalProperties": false
},
"ProjectNotFoundError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["ProjectNotFoundError"]
},
"projectID": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": ["_tag", "projectID", "message"],
"additionalProperties": false
},
"ProjectCopyError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["ProjectCopyError"]
},
"data": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": ["message"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"PtyNotFoundError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["PtyNotFoundError"]
},
"ptyID": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": ["_tag", "ptyID", "message"],
"additionalProperties": false
},
"PtyForbiddenError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["PtyForbiddenError"]
},
"message": {
"type": "string"
}
},
"required": ["_tag", "message"],
"additionalProperties": false
},
"QuestionRequest": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^que"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionInfo"
},
"description": "Questions to ask"
},
"blocking": {
"type": "boolean"
},
"tool": {
"$ref": "#/components/schemas/QuestionTool"
}
},
"required": ["id", "sessionID", "questions"],
"additionalProperties": false
},
"QuestionNotFoundError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["QuestionNotFoundError"]
},
"requestID": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": ["_tag", "requestID", "message"],
"additionalProperties": false
},
"PermissionRequest": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^per"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"permission": {
"type": "string"
},
"patterns": {
"type": "array",
"items": {
"type": "string"
}
},
"metadata": {
"type": "object"
},
"always": {
"type": "array",
"items": {
"type": "string"
}
},
"tool": {
"type": "object",
"properties": {
"messageID": {
"type": "string"
},
"callID": {
"type": "string"
}
},
"required": ["messageID", "callID"],
"additionalProperties": false
}
},
"required": ["id", "sessionID", "permission", "patterns", "metadata", "always"],
"additionalProperties": false
},
"PermissionNotFoundError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["PermissionNotFoundError"]
},
"requestID": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": ["_tag", "requestID", "message"],
"additionalProperties": false
},
"ProviderAuthMethod": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["oauth", "api"]
},
"label": {
"type": "string"
},
"prompts": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["text"]
},
"key": {
"type": "string"
},
"message": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"when": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"op": {
"type": "string",
"enum": ["eq", "neq"]
},
"value": {
"type": "string"
}
},
"required": ["key", "op", "value"],
"additionalProperties": false
}
},
"required": ["type", "key", "message"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["select"]
},
"key": {
"type": "string"
},
"message": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "string"
},
"hint": {
"type": "string"
}
},
"required": ["label", "value"],
"additionalProperties": false
}
},
"when": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"op": {
"type": "string",
"enum": ["eq", "neq"]
},
"value": {
"type": "string"
}
},
"required": ["key", "op", "value"],
"additionalProperties": false
}
},
"required": ["type", "key", "message", "options"],
"additionalProperties": false
}
]
}
}
},
"required": ["type", "label"],
"additionalProperties": false
},
"ProviderAuthAuthorization": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"method": {
"type": "string",
"enum": ["auto", "code"]
},
"instructions": {
"type": "string"
}
},
"required": ["url", "method", "instructions"],
"additionalProperties": false
},
"ProviderAuthError1": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"BadRequest",
"ProviderAuthOauthMissing",
"ProviderAuthOauthCodeMissing",
"ProviderAuthOauthCallbackFailed",
"ProviderAuthValidationFailed"
]
},
"data": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"kind": {
"type": "string"
}
},
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"Session1": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^ses"
},
"slug": {
"type": "string"
},
"projectID": {
"type": "string"
},
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"directory": {
"type": "string"
},
"path": {
"type": "string"
},
"parentID": {
"type": "string",
"pattern": "^ses"
},
"summary": {
"type": "object",
"properties": {
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"files": {
"type": "number"
},
"diffs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotSummaryFileDiff"
}
}
},
"required": ["additions", "deletions", "files"],
"additionalProperties": false
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"share": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": ["url"],
"additionalProperties": false
},
"title": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"version": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"compacting": {
"type": "integer",
"minimum": 0
},
"archived": {
"type": "number"
}
},
"required": ["created", "updated"],
"additionalProperties": false
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
"revert": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
},
"snapshot": {
"type": "string"
},
"diff": {
"type": "string"
}
},
"required": ["messageID"],
"additionalProperties": false
}
},
"required": ["id", "slug", "projectID", "directory", "title", "version", "time"],
"additionalProperties": false
},
"Session2": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^ses"
},
"slug": {
"type": "string"
},
"projectID": {
"type": "string"
},
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"directory": {
"type": "string"
},
"path": {
"type": "string"
},
"parentID": {
"type": "string",
"pattern": "^ses"
},
"summary": {
"type": "object",
"properties": {
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"files": {
"type": "number"
},
"diffs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotSummaryFileDiff"
}
}
},
"required": ["additions", "deletions", "files"],
"additionalProperties": false
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"share": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": ["url"],
"additionalProperties": false
},
"title": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"version": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"compacting": {
"type": "integer",
"minimum": 0
},
"archived": {
"type": "number"
}
},
"required": ["created", "updated"],
"additionalProperties": false
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
"revert": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
},
"snapshot": {
"type": "string"
},
"diff": {
"type": "string"
}
},
"required": ["messageID"],
"additionalProperties": false
}
},
"required": ["id", "slug", "projectID", "directory", "title", "version", "time"],
"additionalProperties": false
},
"NotFoundError": {
"type": "object",
"required": ["name", "data"],
"properties": {
"name": {
"type": "string",
"enum": ["NotFoundError"]
},
"data": {
"type": "object",
"required": ["message"],
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"Todo": {
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "Brief description of the task"
},
"status": {
"type": "string",
"description": "Current status of the task: pending, in_progress, completed, cancelled"
},
"priority": {
"type": "string",
"description": "Priority level of the task: high, medium, low"
}
},
"required": ["content", "status", "priority"],
"additionalProperties": false
},
"Session3": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^ses"
},
"slug": {
"type": "string"
},
"projectID": {
"type": "string"
},
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"directory": {
"type": "string"
},
"path": {
"type": "string"
},
"parentID": {
"type": "string",
"pattern": "^ses"
},
"summary": {
"type": "object",
"properties": {
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"files": {
"type": "number"
},
"diffs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotSummaryFileDiff"
}
}
},
"required": ["additions", "deletions", "files"],
"additionalProperties": false
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"share": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": ["url"],
"additionalProperties": false
},
"title": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"version": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"compacting": {
"type": "integer",
"minimum": 0
},
"archived": {
"type": "number"
}
},
"required": ["created", "updated"],
"additionalProperties": false
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
"revert": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
},
"snapshot": {
"type": "string"
},
"diff": {
"type": "string"
}
},
"required": ["messageID"],
"additionalProperties": false
}
},
"required": ["id", "slug", "projectID", "directory", "title", "version", "time"],
"additionalProperties": false
},
"Session4": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^ses"
},
"slug": {
"type": "string"
},
"projectID": {
"type": "string"
},
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"directory": {
"type": "string"
},
"path": {
"type": "string"
},
"parentID": {
"type": "string",
"pattern": "^ses"
},
"summary": {
"type": "object",
"properties": {
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"files": {
"type": "number"
},
"diffs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotSummaryFileDiff"
}
}
},
"required": ["additions", "deletions", "files"],
"additionalProperties": false
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"share": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": ["url"],
"additionalProperties": false
},
"title": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"version": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"compacting": {
"type": "integer",
"minimum": 0
},
"archived": {
"type": "number"
}
},
"required": ["created", "updated"],
"additionalProperties": false
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
"revert": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
},
"snapshot": {
"type": "string"
},
"diff": {
"type": "string"
}
},
"required": ["messageID"],
"additionalProperties": false
}
},
"required": ["id", "slug", "projectID", "directory", "title", "version", "time"],
"additionalProperties": false
},
"Session5": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^ses"
},
"slug": {
"type": "string"
},
"projectID": {
"type": "string"
},
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"directory": {
"type": "string"
},
"path": {
"type": "string"
},
"parentID": {
"type": "string",
"pattern": "^ses"
},
"summary": {
"type": "object",
"properties": {
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"files": {
"type": "number"
},
"diffs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotSummaryFileDiff"
}
}
},
"required": ["additions", "deletions", "files"],
"additionalProperties": false
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"share": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": ["url"],
"additionalProperties": false
},
"title": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"version": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"compacting": {
"type": "integer",
"minimum": 0
},
"archived": {
"type": "number"
}
},
"required": ["created", "updated"],
"additionalProperties": false
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
"revert": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
},
"snapshot": {
"type": "string"
},
"diff": {
"type": "string"
}
},
"required": ["messageID"],
"additionalProperties": false
}
},
"required": ["id", "slug", "projectID", "directory", "title", "version", "time"],
"additionalProperties": false
},
"Session6": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^ses"
},
"slug": {
"type": "string"
},
"projectID": {
"type": "string"
},
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"directory": {
"type": "string"
},
"path": {
"type": "string"
},
"parentID": {
"type": "string",
"pattern": "^ses"
},
"summary": {
"type": "object",
"properties": {
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"files": {
"type": "number"
},
"diffs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotSummaryFileDiff"
}
}
},
"required": ["additions", "deletions", "files"],
"additionalProperties": false
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"share": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": ["url"],
"additionalProperties": false
},
"title": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"version": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"compacting": {
"type": "integer",
"minimum": 0
},
"archived": {
"type": "number"
}
},
"required": ["created", "updated"],
"additionalProperties": false
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
"revert": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
},
"snapshot": {
"type": "string"
},
"diff": {
"type": "string"
}
},
"required": ["messageID"],
"additionalProperties": false
}
},
"required": ["id", "slug", "projectID", "directory", "title", "version", "time"],
"additionalProperties": false
},
"Session7": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^ses"
},
"slug": {
"type": "string"
},
"projectID": {
"type": "string"
},
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"directory": {
"type": "string"
},
"path": {
"type": "string"
},
"parentID": {
"type": "string",
"pattern": "^ses"
},
"summary": {
"type": "object",
"properties": {
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"files": {
"type": "number"
},
"diffs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotSummaryFileDiff"
}
}
},
"required": ["additions", "deletions", "files"],
"additionalProperties": false
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"share": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": ["url"],
"additionalProperties": false
},
"title": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"version": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"compacting": {
"type": "integer",
"minimum": 0
},
"archived": {
"type": "number"
}
},
"required": ["created", "updated"],
"additionalProperties": false
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
"revert": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
},
"snapshot": {
"type": "string"
},
"diff": {
"type": "string"
}
},
"required": ["messageID"],
"additionalProperties": false
}
},
"required": ["id", "slug", "projectID", "directory", "title", "version", "time"],
"additionalProperties": false
},
"TextPartInput": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"type": {
"type": "string",
"enum": ["text"]
},
"text": {
"type": "string"
},
"synthetic": {
"type": "boolean"
},
"ignored": {
"type": "boolean"
},
"time": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0
},
"end": {
"type": "integer",
"minimum": 0
}
},
"required": ["start"],
"additionalProperties": false
},
"metadata": {
"type": "object"
}
},
"required": ["type", "text"],
"additionalProperties": false
},
"FilePartInput": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"type": {
"type": "string",
"enum": ["file"]
},
"mime": {
"type": "string"
},
"filename": {
"type": "string"
},
"url": {
"type": "string"
},
"source": {
"$ref": "#/components/schemas/FilePartSource"
}
},
"required": ["type", "mime", "url"],
"additionalProperties": false
},
"AgentPartInput": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"type": {
"type": "string",
"enum": ["agent"]
},
"name": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"start": {
"type": "integer",
"minimum": 0
},
"end": {
"type": "integer",
"minimum": 0
}
},
"required": ["value", "start", "end"],
"additionalProperties": false
}
},
"required": ["type", "name"],
"additionalProperties": false
},
"SubtaskPartInput": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^prt"
},
"type": {
"type": "string",
"enum": ["subtask"]
},
"prompt": {
"type": "string"
},
"description": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
}
},
"required": ["providerID", "modelID"],
"additionalProperties": false
},
"command": {
"type": "string"
}
},
"required": ["type", "prompt", "description", "agent"],
"additionalProperties": false
},
"SessionBusyError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["SessionBusyError"]
},
"sessionID": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": ["_tag", "sessionID", "message"],
"additionalProperties": false
},
"Session8": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^ses"
},
"slug": {
"type": "string"
},
"projectID": {
"type": "string"
},
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"directory": {
"type": "string"
},
"path": {
"type": "string"
},
"parentID": {
"type": "string",
"pattern": "^ses"
},
"summary": {
"type": "object",
"properties": {
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"files": {
"type": "number"
},
"diffs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotSummaryFileDiff"
}
}
},
"required": ["additions", "deletions", "files"],
"additionalProperties": false
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"share": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": ["url"],
"additionalProperties": false
},
"title": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"version": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"compacting": {
"type": "integer",
"minimum": 0
},
"archived": {
"type": "number"
}
},
"required": ["created", "updated"],
"additionalProperties": false
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
"revert": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
},
"snapshot": {
"type": "string"
},
"diff": {
"type": "string"
}
},
"required": ["messageID"],
"additionalProperties": false
}
},
"required": ["id", "slug", "projectID", "directory", "title", "version", "time"],
"additionalProperties": false
},
"Session9": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^ses"
},
"slug": {
"type": "string"
},
"projectID": {
"type": "string"
},
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"directory": {
"type": "string"
},
"path": {
"type": "string"
},
"parentID": {
"type": "string",
"pattern": "^ses"
},
"summary": {
"type": "object",
"properties": {
"additions": {
"type": "number"
},
"deletions": {
"type": "number"
},
"files": {
"type": "number"
},
"diffs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotSummaryFileDiff"
}
}
},
"required": ["additions", "deletions", "files"],
"additionalProperties": false
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"share": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": ["url"],
"additionalProperties": false
},
"title": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"version": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"compacting": {
"type": "integer",
"minimum": 0
},
"archived": {
"type": "number"
}
},
"required": ["created", "updated"],
"additionalProperties": false
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
"revert": {
"type": "object",
"properties": {
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
},
"snapshot": {
"type": "string"
},
"diff": {
"type": "string"
}
},
"required": ["messageID"],
"additionalProperties": false
}
},
"required": ["id", "slug", "projectID", "directory", "title", "version", "time"],
"additionalProperties": false
},
"EventTuiPromptAppend": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["tui.prompt.append"]
},
"properties": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"required": ["text"],
"additionalProperties": false
}
},
"required": ["type", "properties"],
"additionalProperties": false
},
"EventTuiCommandExecute": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["tui.command.execute"]
},
"properties": {
"type": "object",
"properties": {
"command": {
"anyOf": [
{
"type": "string",
"enum": [
"session.list",
"session.new",
"session.share",
"session.interrupt",
"session.compact",
"session.page.up",
"session.page.down",
"session.line.up",
"session.line.down",
"session.half.page.up",
"session.half.page.down",
"session.first",
"session.last",
"prompt.clear",
"prompt.submit",
"agent.cycle"
]
},
{
"type": "string"
}
]
}
},
"required": ["command"],
"additionalProperties": false
}
},
"required": ["type", "properties"],
"additionalProperties": false
},
"EventTuiToastShow": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["tui.toast.show"]
},
"properties": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"message": {
"type": "string"
},
"variant": {
"type": "string",
"enum": ["info", "success", "warning", "error"]
},
"duration": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"required": ["message", "variant"],
"additionalProperties": false
}
},
"required": ["type", "properties"],
"additionalProperties": false
},
"EventTuiSessionSelect": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["tui.session.select"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses",
"description": "Session ID to navigate to"
}
},
"required": ["sessionID"],
"additionalProperties": false
}
},
"required": ["type", "properties"],
"additionalProperties": false
},
"Workspace": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^wrk"
},
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"branch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"directory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"extra": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"projectID": {
"type": "string"
},
"timeUsed": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
}
},
"required": ["id", "type", "name", "projectID", "timeUsed"],
"additionalProperties": false
},
"WorkspaceCreateError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["WorkspaceCreateError"]
},
"data": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": ["message"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"WorkspaceWarpError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["WorkspaceWarpError"]
},
"data": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": ["message"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"BackgroundProcessLogs": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"output": {
"type": "string"
}
},
"required": ["id", "sessionID", "output"],
"additionalProperties": false
},
"CommitMessageNoChangesError": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": ["message"],
"additionalProperties": false
},
"ConfigOverlayResponse": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": ["global", "project"]
},
"effective": {
"$ref": "#/components/schemas/Config"
},
"global": {
"$ref": "#/components/schemas/Config"
},
"project": {
"$ref": "#/components/schemas/Config"
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"kind": {
"type": "string"
},
"scope": {
"type": "string"
},
"label": {
"type": "string"
},
"source": {
"type": "string"
},
"path": {
"type": "string"
},
"exists": {
"type": "boolean"
},
"editable": {
"type": "boolean"
},
"reason": {
"type": "string"
}
},
"required": ["order", "kind", "scope", "label", "source", "exists", "editable"],
"additionalProperties": false
}
},
"targets": {
"type": "object",
"properties": {
"global": {
"type": "string"
},
"project": {
"type": "string"
},
"active": {
"type": "string"
}
},
"additionalProperties": false
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"path": {
"type": "array",
"items": {
"type": "string"
}
},
"value": {},
"global": {},
"local": {},
"source": {
"type": "string",
"enum": ["project", "global", "system", "default"]
},
"inherited": {
"type": "boolean"
},
"overridden": {
"type": "boolean"
},
"editable": {
"type": "boolean"
},
"reason": {
"type": "string"
}
},
"required": ["key", "path", "source", "inherited", "overridden", "editable"],
"additionalProperties": false
}
},
"collections": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"path": {
"type": "array",
"items": {
"type": "string"
}
},
"value": {},
"global": {},
"local": {},
"source": {
"type": "string",
"enum": ["project", "global", "system", "default"]
},
"inherited": {
"type": "boolean"
},
"overridden": {
"type": "boolean"
},
"editable": {
"type": "boolean"
},
"reason": {
"type": "string"
}
},
"required": ["key", "path", "source", "inherited", "overridden", "editable"],
"additionalProperties": false
}
}
}
},
"required": ["scope", "effective", "global", "project", "sources", "targets", "fields", "collections"],
"additionalProperties": false
},
"ConfigSourcesResponse": {
"type": "object",
"properties": {
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"kind": {
"type": "string"
},
"scope": {
"type": "string"
},
"label": {
"type": "string"
},
"source": {
"type": "string"
},
"path": {
"type": "string"
},
"exists": {
"type": "boolean"
},
"editable": {
"type": "boolean"
},
"reason": {
"type": "string"
}
},
"required": ["order", "kind", "scope", "label", "source", "exists", "editable"],
"additionalProperties": false
}
}
},
"required": ["sources"],
"additionalProperties": false
},
"ConfigRulesResponse": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": ["project"]
},
"target": {
"type": "string"
},
"files": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"exists": {
"type": "boolean"
},
"editable": {
"type": "boolean"
},
"content": {
"type": "string"
}
},
"required": ["name", "path", "exists", "editable", "content"],
"additionalProperties": false
}
}
},
"required": ["scope", "target", "files"],
"additionalProperties": false
},
"ConfigModelStateResponse": {
"type": "object",
"properties": {
"model": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
}
},
"required": ["providerID", "modelID"],
"additionalProperties": false
}
},
"recent": {
"type": "array",
"items": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
}
},
"required": ["providerID", "modelID"],
"additionalProperties": false
}
},
"favorite": {
"type": "array",
"items": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
}
},
"required": ["providerID", "modelID"],
"additionalProperties": false
}
},
"variant": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": ["model", "recent", "favorite", "variant"],
"additionalProperties": false
},
"TuiConfigGetResponse": {
"type": "object",
"properties": {
"$schema": {
"type": "string"
},
"theme": {
"type": "string"
},
"keybinds": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"plugin": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"prefixItems": [
{
"type": "string"
},
{
"type": "object"
}
],
"maxItems": 2,
"minItems": 2
}
]
}
},
"plugin_enabled": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"title_icon": {
"type": "string",
"enum": ["none", "unicode", "emojis"],
"description": "Status icon style shown in terminal titles"
},
"scroll_speed": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"scroll_acceleration": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": ["enabled"],
"additionalProperties": false
},
"diff_style": {
"type": "string",
"enum": ["auto", "stacked"]
},
"mouse": {
"type": "boolean"
},
"attention": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"notifications": {
"type": "boolean"
},
"sound": {
"type": "boolean"
},
"volume": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"TuiKeybindInfo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"group": {
"type": "string"
},
"default": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": ["id", "label", "group", "default", "description"],
"additionalProperties": false
},
"TuiKeybindListResponse": {
"type": "object",
"properties": {
"keybinds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TuiKeybindInfo"
}
}
},
"required": ["keybinds"],
"additionalProperties": false
},
"KiloEmbeddingModelCatalog": {
"type": "object",
"properties": {
"defaultModel": {
"type": "string"
},
"models": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"dimension": {
"type": "integer",
"exclusiveMinimum": 0
},
"scoreThreshold": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"note": {
"type": "string"
}
},
"required": ["id", "name", "dimension", "scoreThreshold"],
"additionalProperties": false
}
},
"aliases": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": ["defaultModel", "models", "aliases"],
"additionalProperties": false
},
"ConflictError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["ConflictError"]
},
"message": {
"type": "string"
},
"resource": {
"type": "string"
}
},
"required": ["_tag", "message"],
"additionalProperties": false
},
"InteractiveTerminalSnapshot": {
"type": "object",
"properties": {
"info": {
"$ref": "#/components/schemas/InteractiveTerminalInfo"
},
"output": {
"type": "string"
},
"cursor": {
"type": "integer",
"minimum": 0
}
},
"required": ["info", "output", "cursor"],
"additionalProperties": false
},
"InteractiveTerminalWriteInput": {
"type": "object",
"properties": {
"data": {
"type": "string"
}
},
"required": ["data"],
"additionalProperties": false
},
"InteractiveTerminalResizeInput": {
"type": "object",
"properties": {
"cols": {
"type": "integer",
"exclusiveMinimum": 0
},
"rows": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"required": ["cols", "rows"],
"additionalProperties": false
},
"effect_HttpApiError_Unauthorized": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["Unauthorized"]
}
},
"required": ["_tag"],
"additionalProperties": false
},
"effect_HttpApiError_ServiceUnavailable": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["ServiceUnavailable"]
}
},
"required": ["_tag"],
"additionalProperties": false
},
"AgentRequirementResult": {
"type": "object",
"properties": {
"agent": {
"type": "string"
},
"directory": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": ["disabled", "ready", "blocked", "error"]
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": ["ready", "missing", "error"]
},
"message": {
"type": "string"
}
},
"required": ["name", "status"],
"additionalProperties": false
}
},
"mcps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": ["ready", "missing", "error"]
},
"message": {
"type": "string"
}
},
"required": ["name", "status"],
"additionalProperties": false
}
},
"vscode_extensions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "\\S"
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$"
}
},
"required": ["name", "id"],
"additionalProperties": false
}
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": ["unknown_agent", "malformed_declaration", "discovery_failed", "mcp_status_failed"]
},
"message": {
"type": "string"
}
},
"required": ["code", "message"],
"additionalProperties": false
}
},
"required": ["agent", "directory", "enabled", "state", "skills", "mcps", "vscode_extensions"],
"additionalProperties": false
},
"NotebookOutput": {
"type": "object",
"properties": {
"mime": {
"type": "string",
"maxLength": 200
},
"text": {
"type": "string",
"maxLength": 100000
},
"name": {
"type": "string",
"maxLength": 500
},
"message": {
"type": "string",
"maxLength": 10000
},
"stack": {
"type": "string",
"maxLength": 50000
},
"omitted": {
"type": "boolean"
},
"truncated": {
"type": "boolean"
}
},
"required": ["mime"],
"additionalProperties": false
},
"NotebookCell": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"description": "Zero-based cell index"
},
"kind": {
"type": "string",
"enum": ["code", "markdown"]
},
"language": {
"type": "string",
"maxLength": 200
},
"source": {
"type": "string",
"maxLength": 200000
},
"execution": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"minimum": 0
},
"success": {
"type": "boolean"
},
"started": {
"type": "integer",
"minimum": 0
},
"ended": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
"outputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotebookOutput"
},
"maxItems": 100
}
},
"required": ["index", "kind", "language", "source"],
"additionalProperties": false
},
"NotebookReadResult": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": ["read"]
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"requestPath": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"revision": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Opaque notebook content revision; pass it back unchanged and do not parse or increment it"
},
"cells": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotebookCell"
},
"maxItems": 2000
},
"truncated": {
"type": "boolean"
}
},
"required": ["operation", "path", "requestPath", "revision", "cells"],
"additionalProperties": false
},
"NotebookEditResult": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": ["edit"]
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"requestPath": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"revision": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Opaque notebook content revision; pass it back unchanged and do not parse or increment it"
},
"index": {
"type": "integer",
"minimum": 0,
"description": "Zero-based cell index"
},
"action": {
"type": "string",
"enum": ["insert", "replace", "delete", "create"]
},
"cell": {
"$ref": "#/components/schemas/NotebookCell"
}
},
"required": ["operation", "path", "requestPath", "revision", "index", "action"],
"additionalProperties": false
},
"NotebookExecuteResult": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": ["execute"]
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"requestPath": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"revision": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Opaque notebook content revision; pass it back unchanged and do not parse or increment it"
},
"index": {
"type": "integer",
"minimum": 0,
"description": "Zero-based cell index"
},
"status": {
"type": "string",
"enum": ["success", "error"]
},
"outputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotebookOutput"
},
"maxItems": 100
},
"truncated": {
"type": "boolean"
}
},
"required": ["operation", "path", "requestPath", "revision", "index", "status", "outputs"],
"additionalProperties": false
},
"NotebookResult": {
"anyOf": [
{
"$ref": "#/components/schemas/NotebookReadResult"
},
{
"$ref": "#/components/schemas/NotebookEditResult"
},
{
"$ref": "#/components/schemas/NotebookExecuteResult"
}
]
},
"NotebookFailure": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"already_exists",
"cancelled",
"closed",
"disconnected",
"execution_failed",
"invalid_cell",
"invalid_path",
"no_kernel",
"not_found",
"stale_revision",
"timeout",
"unsupported"
]
},
"message": {
"type": "string",
"minLength": 1,
"maxLength": 10000
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"index": {
"type": "integer",
"minimum": 0,
"description": "Zero-based cell index"
},
"currentRevision": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Opaque notebook content revision; pass it back unchanged and do not parse or increment it"
}
},
"required": ["code", "message"],
"additionalProperties": false
},
"AgentManagerActivity": {
"type": "string",
"enum": ["idle", "busy", "retry", "offline"]
},
"AgentManagerAttention": {
"type": "array",
"items": {
"type": "string",
"enum": ["permission", "question"]
},
"maxItems": 2
},
"AgentManagerSessionSummary": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^ses"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"activity": {
"$ref": "#/components/schemas/AgentManagerActivity"
},
"attention": {
"$ref": "#/components/schemas/AgentManagerAttention"
}
},
"required": ["id", "name", "activity"],
"additionalProperties": false
},
"AgentManagerGitSummary": {
"type": "object",
"properties": {
"additions": {
"type": "integer",
"minimum": 0
},
"deletions": {
"type": "integer",
"minimum": 0
},
"ahead": {
"type": "integer",
"minimum": 0
},
"behind": {
"type": "integer",
"minimum": 0
}
},
"required": ["additions", "deletions", "ahead", "behind"],
"additionalProperties": false
},
"AgentManagerPullRequestSummary": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"minimum": 0
},
"state": {
"type": "string",
"enum": ["open", "draft", "merged", "closed"]
},
"checks": {
"type": "string",
"enum": ["success", "failure", "pending", "none"]
},
"review": {
"type": "string",
"enum": ["approved", "changes_requested", "pending"]
},
"unresolvedComments": {
"type": "integer",
"minimum": 0
}
},
"required": ["number", "state", "checks"],
"additionalProperties": false
},
"AgentManagerWorktreeSummary": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"branch": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"session": {
"$ref": "#/components/schemas/AgentManagerSessionSummary"
},
"sessions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentManagerSessionSummary"
},
"minItems": 2,
"maxItems": 100
},
"git": {
"$ref": "#/components/schemas/AgentManagerGitSummary"
},
"pullRequest": {
"$ref": "#/components/schemas/AgentManagerPullRequestSummary"
}
},
"required": ["id", "name", "branch"],
"additionalProperties": false
},
"AgentManagerSectionSummary": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"worktrees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentManagerWorktreeSummary"
},
"maxItems": 100
}
},
"required": ["id", "name", "worktrees"],
"additionalProperties": false
},
"AgentManagerLocalSummary": {
"type": "object",
"properties": {
"branch": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"sessions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentManagerSessionSummary"
},
"maxItems": 100
},
"git": {
"$ref": "#/components/schemas/AgentManagerGitSummary"
}
},
"required": ["sessions"],
"additionalProperties": false
},
"AgentManagerOverview": {
"type": "object",
"properties": {
"sections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentManagerSectionSummary"
},
"maxItems": 100
},
"ungrouped": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentManagerWorktreeSummary"
},
"maxItems": 100
},
"local": {
"$ref": "#/components/schemas/AgentManagerLocalSummary"
}
},
"required": ["sections", "ungrouped"],
"additionalProperties": false
},
"AgentManagerOverviewResult": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": ["overview"]
},
"overview": {
"$ref": "#/components/schemas/AgentManagerOverview"
}
},
"required": ["operation", "overview"],
"additionalProperties": false
},
"AgentManagerPromptResult": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": ["prompt"]
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"delivered": {
"type": "boolean",
"enum": [true]
}
},
"required": ["operation", "sessionID", "delivered"],
"additionalProperties": false
},
"AgentManagerResult": {
"anyOf": [
{
"$ref": "#/components/schemas/AgentManagerOverviewResult"
},
{
"$ref": "#/components/schemas/AgentManagerPromptResult"
}
]
},
"AgentManagerFailure": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"cancelled",
"cross_workspace",
"disconnected",
"host_error",
"stale_session",
"timeout",
"unavailable_session",
"unknown_session",
"workspace_unavailable"
]
},
"message": {
"type": "string",
"minLength": 1,
"maxLength": 10000
}
},
"required": ["code", "message"],
"additionalProperties": false
},
"AnacondaDesktopStatus": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["unsupported-platform"]
},
"platform": {
"type": "string"
}
},
"required": ["type", "platform"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["not-installed"]
},
"downloadURL": {
"type": "string"
}
},
"required": ["type", "downloadURL"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["not-running"]
}
},
"required": ["type"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["invalid-config"]
},
"reason": {
"type": "string",
"enum": ["missing", "malformed", "missing-key", "invalid-port"]
}
},
"required": ["type", "reason"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["signed-out"]
}
},
"required": ["type"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["management-unauthorized"]
}
},
"required": ["type"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["management-unavailable"]
},
"reason": {
"type": "string",
"enum": ["timeout", "unexpected-response"]
}
},
"required": ["type", "reason"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["no-downloaded-model"]
}
},
"required": ["type"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["no-running-server"]
},
"downloadedModels": {
"type": "integer"
}
},
"required": ["type", "downloadedModels"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["inference-unhealthy"]
},
"serverID": {
"type": "string",
"minLength": 1
}
},
"required": ["type", "serverID"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["ready"]
},
"serverID": {
"type": "string",
"minLength": 1
},
"serverName": {
"type": "string",
"minLength": 1
},
"models": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
}
},
"required": ["id", "name"],
"additionalProperties": false
},
"minItems": 1
},
"context": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"toolcall": {
"type": "string",
"enum": ["supported", "unsupported", "unknown"]
}
},
"required": ["type", "serverID", "models", "context", "toolcall"],
"additionalProperties": false
}
]
},
"AnacondaDesktopConflictError": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": ["unsupported-platform", "not-installed", "not-ready", "acknowledgement-required"]
},
"message": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/AnacondaDesktopStatus"
}
},
"required": ["code", "message"],
"additionalProperties": false
},
"AnacondaDesktopOperationError": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": ["open", "sync"]
},
"message": {
"type": "string"
}
},
"required": ["operation", "message"],
"additionalProperties": false
},
"KilocodeSessionImportResult": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"id": {
"type": "string"
},
"skipped": {
"type": "boolean"
}
},
"required": ["ok", "id"],
"additionalProperties": false
},
"MemoryApiClientError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["MemoryApiClientError"]
},
"data": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": ["code", "message"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"MemoryApiServerError": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": ["MemoryApiServerError"]
},
"data": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": ["code", "message"],
"additionalProperties": false
}
},
"required": ["name", "data"],
"additionalProperties": false
},
"UnauthorizedError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["UnauthorizedError"]
},
"message": {
"type": "string"
}
},
"required": ["_tag", "message"],
"additionalProperties": false
},
"V2SessionsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionV2Info"
}
},
"cursor": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"additionalProperties": false
}
},
"required": ["data", "cursor"],
"additionalProperties": false
},
"InvalidCursorError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["InvalidCursorError"]
},
"message": {
"type": "string"
}
},
"required": ["_tag", "message"],
"additionalProperties": false
},
"SessionNotFoundError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["SessionNotFoundError"]
},
"sessionID": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": ["_tag", "sessionID", "message"],
"additionalProperties": false
},
"ServiceUnavailableError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["ServiceUnavailableError"]
},
"message": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": ["_tag", "message"],
"additionalProperties": false
},
"UnknownError1": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["UnknownError"]
},
"message": {
"type": "string"
},
"ref": {
"type": "string"
}
},
"required": ["_tag", "message"],
"additionalProperties": false
},
"V2SessionMessagesResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionMessage"
}
},
"cursor": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"additionalProperties": false
}
},
"required": ["data", "cursor"],
"additionalProperties": false
},
"ProviderNotFoundError": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["ProviderNotFoundError"]
},
"providerID": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": ["_tag", "providerID", "message"],
"additionalProperties": false
},
"effect_HttpApiError_Forbidden": {
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": ["Forbidden"]
}
},
"required": ["_tag"],
"additionalProperties": false
},
"InteractiveTerminalInfo1": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"pid": {
"type": "integer",
"exclusiveMinimum": 0
},
"command": {
"type": "string"
},
"cwd": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"type": "string",
"enum": ["running", "closed"]
},
"cols": {
"type": "integer",
"exclusiveMinimum": 0
},
"rows": {
"type": "integer",
"exclusiveMinimum": 0
},
"exitCode": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"signal": {
"type": "string"
},
"closedBy": {
"type": "string",
"enum": ["exit", "user", "abort"]
},
"time": {
"type": "object",
"properties": {
"started": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"ended": {
"type": "integer",
"minimum": 0
}
},
"required": ["started", "updated"],
"additionalProperties": false
}
},
"required": ["id", "sessionID", "pid", "command", "cwd", "status", "cols", "rows", "time"],
"additionalProperties": false
},
"MoveSessionDestination": {
"type": "object",
"properties": {
"directory": {
"type": "string"
}
},
"required": ["directory"],
"additionalProperties": false
},
"EventServerInstanceDisposed": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["server.instance.disposed"]
},
"properties": {
"type": "object",
"properties": {
"directory": {
"type": "string"
}
},
"required": ["directory"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNetworkAsked": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.network.asked"]
},
"properties": {
"$ref": "#/components/schemas/SessionNetworkWait"
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNetworkReplied": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.network.replied"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"requestID": {
"type": "string",
"pattern": "^que"
}
},
"required": ["sessionID", "requestID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNetworkRejected": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.network.rejected"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"requestID": {
"type": "string",
"pattern": "^que"
}
},
"required": ["sessionID", "requestID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNetworkRestored": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.network.restored"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"requestID": {
"type": "string",
"pattern": "^que"
},
"time": {
"type": "number"
}
},
"required": ["sessionID", "requestID", "time"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventBackground_processUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["background_process.updated"]
},
"properties": {
"type": "object",
"properties": {
"info": {
"$ref": "#/components/schemas/BackgroundProcessInfo"
},
"scope": {
"type": "string"
}
},
"required": ["info", "scope"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventBackground_processDeleted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["background_process.deleted"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"processID": {
"type": "string"
},
"scope": {
"type": "string"
}
},
"required": ["sessionID", "processID", "scope"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventInteractive_terminalUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["interactive_terminal.updated"]
},
"properties": {
"type": "object",
"properties": {
"info": {
"$ref": "#/components/schemas/InteractiveTerminalInfo"
}
},
"required": ["info"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventInteractive_terminalData": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["interactive_terminal.data"]
},
"properties": {
"type": "object",
"properties": {
"terminalID": {
"type": "string"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"data": {
"type": "string"
},
"cursor": {
"type": "integer",
"minimum": 0
}
},
"required": ["terminalID", "sessionID", "data", "cursor"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventInteractive_terminalDeleted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["interactive_terminal.deleted"]
},
"properties": {
"type": "object",
"properties": {
"terminalID": {
"type": "string"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
}
},
"required": ["terminalID", "sessionID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionTurnOpen": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.turn.open"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
}
},
"required": ["sessionID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionTurnClose": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.turn.close"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"parentID": {
"type": "string",
"pattern": "^ses"
},
"reason": {
"type": "string",
"enum": ["completed", "error", "interrupted"]
}
},
"required": ["sessionID", "reason"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSandboxStatusChanged": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["sandbox.status.changed"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"directory": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"available": {
"type": "boolean"
},
"reason": {
"type": "string"
},
"version": {
"type": "integer"
}
},
"required": ["sessionID", "directory", "enabled", "available", "version"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSuggestionShown": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["suggestion.shown"]
},
"properties": {
"$ref": "#/components/schemas/SuggestionRequest"
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSuggestionAccepted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["suggestion.accepted"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"requestID": {
"type": "string",
"pattern": "^sug"
},
"index": {
"type": "integer",
"minimum": 0
},
"action": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Button or option label (1-5 words)"
},
"description": {
"type": "string"
},
"prompt": {
"type": "string",
"description": "Synthetic user prompt to inject when this action is accepted"
}
},
"required": ["label", "prompt"],
"additionalProperties": false
}
},
"required": ["sessionID", "requestID", "index", "action"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSuggestionDismissed": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["suggestion.dismissed"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"requestID": {
"type": "string",
"pattern": "^sug"
}
},
"required": ["sessionID", "requestID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventKilocodeAgent_managerStart": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["kilocode.agent_manager.start"]
},
"properties": {
"type": "object",
"properties": {
"requestID": {
"type": "string"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"sandboxInheritanceToken": {
"type": "string"
},
"mode": {
"type": "string",
"enum": ["worktree", "local"]
},
"versions": {
"type": "boolean"
},
"tasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prompt": {
"type": "string"
},
"name": {
"type": "string"
},
"branchName": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"providerID": {
"type": "string"
},
"modelID": {
"type": "string"
}
},
"required": ["providerID", "modelID"],
"additionalProperties": false
},
"variant": {
"type": "string"
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 20
}
},
"required": ["requestID", "sessionID", "mode", "tasks"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventKilocodeAgent_managerRequested": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["kilocode.agent_manager.requested"]
},
"properties": {
"$ref": "#/components/schemas/AgentManagerRequest"
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventKilocodeAgent_managerCancelled": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["kilocode.agent_manager.cancelled"]
},
"properties": {
"type": "object",
"properties": {
"requestID": {
"$ref": "#/components/schemas/AgentManagerRequestID"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"reason": {
"type": "string",
"enum": ["cancelled", "disposed", "timeout"]
}
},
"required": ["requestID", "sessionID", "reason"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventKilocodeNotebookRequested": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["kilocode.notebook.requested"]
},
"properties": {
"$ref": "#/components/schemas/NotebookRequest"
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventKilocodeNotebookCancelled": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["kilocode.notebook.cancelled"]
},
"properties": {
"type": "object",
"properties": {
"requestID": {
"$ref": "#/components/schemas/NotebookRequestID"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"reason": {
"type": "string",
"enum": ["cancelled", "disposed", "timeout"]
}
},
"required": ["requestID", "sessionID", "reason"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventLspClientDiagnostics": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["lsp.client.diagnostics"]
},
"properties": {
"type": "object",
"properties": {
"serverID": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": ["serverID", "path"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventKilo-sessionsRemote-status-changed": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["kilo-sessions.remote-status-changed"]
},
"properties": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"connected": {
"type": "boolean"
}
},
"required": ["enabled", "connected"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventMemoryStatus": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["memory.status"]
},
"properties": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"sessionID": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": ["idle", "checking", "injecting", "updating", "skipped", "error"]
},
"reason": {
"type": "string"
},
"project": {
"type": "object",
"properties": {
"bytes": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"estimatedTokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"truncated": {
"type": "boolean"
},
"updatedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
}
},
"required": ["bytes", "estimatedTokens", "truncated"],
"additionalProperties": false
},
"consolidation": {
"type": "object",
"properties": {
"trigger": {
"type": "string",
"enum": ["explicit", "turn-close", "rebuild"]
},
"operationCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"cost": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"tokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
}
},
"required": ["trigger", "operationCount", "cost", "tokens"],
"additionalProperties": false
},
"detail": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["saved", "skipped", "recalled"]
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
},
"duplicateOf": {
"type": "string"
},
"tokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"operationCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"skippedCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"sources": {
"type": "array",
"items": {
"type": "string"
}
},
"files": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["type", "message"],
"additionalProperties": false
}
},
"required": ["directory", "enabled", "state", "project"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventMemoryUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["memory.updated"]
},
"properties": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"sessionID": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": ["idle", "checking", "injecting", "updating", "skipped", "error"]
},
"reason": {
"type": "string"
},
"project": {
"type": "object",
"properties": {
"bytes": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"estimatedTokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"truncated": {
"type": "boolean"
},
"updatedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
}
},
"required": ["bytes", "estimatedTokens", "truncated"],
"additionalProperties": false
},
"consolidation": {
"type": "object",
"properties": {
"trigger": {
"type": "string",
"enum": ["explicit", "turn-close", "rebuild"]
},
"operationCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"cost": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"tokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
}
},
"required": ["trigger", "operationCount", "cost", "tokens"],
"additionalProperties": false
},
"detail": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["saved", "skipped", "recalled"]
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
},
"duplicateOf": {
"type": "string"
},
"tokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"operationCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"skippedCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"sources": {
"type": "array",
"items": {
"type": "string"
}
},
"files": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["type", "message"],
"additionalProperties": false
}
},
"required": ["directory", "enabled", "state", "project"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventMemoryError": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["memory.error"]
},
"properties": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"sessionID": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": ["idle", "checking", "injecting", "updating", "skipped", "error"]
},
"reason": {
"type": "string"
},
"project": {
"type": "object",
"properties": {
"bytes": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"estimatedTokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"truncated": {
"type": "boolean"
},
"updatedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
}
},
"required": ["bytes", "estimatedTokens", "truncated"],
"additionalProperties": false
},
"consolidation": {
"type": "object",
"properties": {
"trigger": {
"type": "string",
"enum": ["explicit", "turn-close", "rebuild"]
},
"operationCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"cost": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"tokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
}
},
"required": ["trigger", "operationCount", "cost", "tokens"],
"additionalProperties": false
},
"detail": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["saved", "skipped", "recalled"]
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
},
"duplicateOf": {
"type": "string"
},
"tokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"operationCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"skippedCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
},
"sources": {
"type": "array",
"items": {
"type": "string"
}
},
"files": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["type", "message"],
"additionalProperties": false
}
},
"required": ["directory", "enabled", "state", "project"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventIndexingStatus": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["indexing.status"]
},
"properties": {
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/IndexingStatus"
}
},
"required": ["status"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventIndexingWarning": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["indexing.warning"]
},
"properties": {
"$ref": "#/components/schemas/IndexingWarning"
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventServerConnected": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["server.connected"]
},
"properties": {
"type": "object",
"properties": {}
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventGlobalDisposed": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["global.disposed"]
},
"properties": {
"type": "object",
"properties": {}
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventGlobalConfigUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["global.config.updated"]
},
"properties": {
"type": "object",
"properties": {}
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventPluginAdded": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["plugin.added"]
},
"properties": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": ["id"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"ModelV2Info": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"family": {
"type": "string"
},
"name": {
"type": "string"
},
"api": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["aisdk"]
},
"package": {
"type": "string"
},
"url": {
"type": "string"
},
"settings": {
"type": "object"
}
},
"required": ["id", "type", "package"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["native"]
},
"url": {
"type": "string"
},
"settings": {
"type": "object"
}
},
"required": ["id", "type", "settings"],
"additionalProperties": false
}
]
},
"capabilities": {
"type": "object",
"properties": {
"tools": {
"type": "boolean"
},
"input": {
"type": "array",
"items": {
"type": "string"
}
},
"output": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["tools", "input", "output"],
"additionalProperties": false
},
"request": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"body": {
"type": "object"
},
"variant": {
"type": "string"
}
},
"required": ["headers", "body"],
"additionalProperties": false
},
"variants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"body": {
"type": "object"
}
},
"required": ["id", "headers", "body"],
"additionalProperties": false
}
},
"time": {
"type": "object",
"properties": {
"released": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
},
{
"type": "string",
"enum": ["Infinity", "-Infinity", "NaN"]
}
]
}
},
"required": ["released"],
"additionalProperties": false
},
"cost": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tier": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["context"]
},
"size": {
"type": "integer"
}
},
"required": ["type", "size"],
"additionalProperties": false
},
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "cache"],
"additionalProperties": false
}
},
"status": {
"type": "string",
"enum": ["alpha", "beta", "deprecated", "active"]
},
"enabled": {
"type": "boolean"
},
"limit": {
"type": "object",
"properties": {
"context": {
"type": "integer"
},
"input": {
"type": "integer"
},
"output": {
"type": "integer"
}
},
"required": ["context", "output"],
"additionalProperties": false
}
},
"required": [
"id",
"providerID",
"name",
"api",
"capabilities",
"request",
"variants",
"time",
"cost",
"status",
"enabled",
"limit"
],
"additionalProperties": false
},
"EventCatalogModelUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["catalog.model.updated"]
},
"properties": {
"type": "object",
"properties": {
"model": {
"$ref": "#/components/schemas/ModelV2Info"
}
},
"required": ["model"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionCreated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.created"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"info": {
"$ref": "#/components/schemas/Session"
}
},
"required": ["sessionID", "info"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.updated"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"info": {
"$ref": "#/components/schemas/Session"
}
},
"required": ["sessionID", "info"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionDeleted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.deleted"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"info": {
"$ref": "#/components/schemas/Session"
}
},
"required": ["sessionID", "info"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventMessageUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["message.updated"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"info": {
"$ref": "#/components/schemas/Message"
}
},
"required": ["sessionID", "info"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventMessageRemoved": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["message.removed"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
}
},
"required": ["sessionID", "messageID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventMessagePartUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["message.part.updated"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"part": {
"$ref": "#/components/schemas/Part"
},
"time": {
"type": "number"
}
},
"required": ["sessionID", "part", "time"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventMessagePartRemoved": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["message.part.removed"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
}
},
"required": ["sessionID", "messageID", "partID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextAgentSwitched": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.agent.switched"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"agent": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "messageID", "agent"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextModelSwitched": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.model.switched"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
}
},
"required": ["timestamp", "sessionID", "messageID", "model"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"LocationRef": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"workspaceID": {
"type": "string",
"pattern": "^wrk"
}
},
"required": ["directory"],
"additionalProperties": false
},
"EventSessionNextMoved": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.moved"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"location": {
"$ref": "#/components/schemas/LocationRef"
},
"subdirectory": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "location"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"PromptSource": {
"type": "object",
"properties": {
"start": {
"type": "number"
},
"end": {
"type": "number"
},
"text": {
"type": "string"
}
},
"required": ["start", "end", "text"],
"additionalProperties": false
},
"PromptFileAttachment": {
"type": "object",
"properties": {
"uri": {
"type": "string"
},
"mime": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"source": {
"$ref": "#/components/schemas/PromptSource"
}
},
"required": ["uri", "mime"],
"additionalProperties": false
},
"PromptAgentAttachment": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"source": {
"$ref": "#/components/schemas/PromptSource"
}
},
"required": ["name"],
"additionalProperties": false
},
"PromptReferenceAttachment": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": ["local", "git", "invalid"]
},
"uri": {
"type": "string"
},
"repository": {
"type": "string"
},
"branch": {
"type": "string"
},
"target": {
"type": "string"
},
"targetUri": {
"type": "string"
},
"problem": {
"type": "string"
},
"source": {
"$ref": "#/components/schemas/PromptSource"
}
},
"required": ["name", "kind"],
"additionalProperties": false
},
"EventSessionNextPrompted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.prompted"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"prompt": {
"$ref": "#/components/schemas/Prompt"
},
"delivery": {
"type": "string",
"enum": ["steer", "queue"]
}
},
"required": ["timestamp", "sessionID", "messageID", "prompt", "delivery"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextPromptAdmitted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.prompt.admitted"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"prompt": {
"$ref": "#/components/schemas/Prompt"
},
"delivery": {
"type": "string",
"enum": ["steer", "queue"]
}
},
"required": ["timestamp", "sessionID", "messageID", "prompt", "delivery"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextPromptPromoted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.prompt.promoted"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"prompt": {
"$ref": "#/components/schemas/Prompt"
},
"timeCreated": {
"type": "number"
}
},
"required": ["timestamp", "sessionID", "messageID", "prompt", "timeCreated"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextContextUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.context.updated"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"text": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "messageID", "text"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextSynthetic": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.synthetic"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"text": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "messageID", "text"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextShellStarted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.shell.started"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"command": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "messageID", "callID", "command"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextShellEnded": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.shell.ended"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"callID": {
"type": "string"
},
"output": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "callID", "output"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextStepStarted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.step.started"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"snapshot": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "agent", "model"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextStepEnded": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.step.ended"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"finish": {
"type": "string"
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"snapshot": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "finish", "cost", "tokens"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"SessionErrorUnknown": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["unknown"]
},
"message": {
"type": "string"
}
},
"required": ["type", "message"],
"additionalProperties": false
},
"EventSessionNextStepFailed": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.step.failed"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"error": {
"$ref": "#/components/schemas/SessionErrorUnknown"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "error"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextTextStarted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.text.started"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"textID": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "textID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextTextDelta": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.text.delta"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"textID": {
"type": "string"
},
"delta": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "textID", "delta"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextTextEnded": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.text.ended"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"textID": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "textID", "text"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextReasoningStarted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.reasoning.started"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"reasoningID": {
"type": "string"
},
"providerMetadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "reasoningID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextReasoningDelta": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.reasoning.delta"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"reasoningID": {
"type": "string"
},
"delta": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "reasoningID", "delta"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextReasoningEnded": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.reasoning.ended"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"reasoningID": {
"type": "string"
},
"text": {
"type": "string"
},
"providerMetadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "reasoningID", "text"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextToolInputStarted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.tool.input.started"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "callID", "name"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextToolInputDelta": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.tool.input.delta"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"delta": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "callID", "delta"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextToolInputEnded": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.tool.input.ended"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "callID", "text"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextToolCalled": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.tool.called"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"tool": {
"type": "string"
},
"input": {
"type": "object"
},
"provider": {
"type": "object",
"properties": {
"executed": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": ["executed"],
"additionalProperties": false
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "callID", "tool", "input", "provider"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"ToolTextContent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["text"]
},
"text": {
"type": "string"
}
},
"required": ["type", "text"],
"additionalProperties": false
},
"ToolFileContent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["file"]
},
"source": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["data"]
},
"data": {
"type": "string"
}
},
"required": ["type", "data"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["url"]
},
"url": {
"type": "string"
}
},
"required": ["type", "url"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["file"]
},
"uri": {
"type": "string"
}
},
"required": ["type", "uri"],
"additionalProperties": false
}
]
},
"mime": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": ["type", "source", "mime"],
"additionalProperties": false
},
"EventSessionNextToolProgress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.tool.progress"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"structured": {
"type": "object"
},
"content": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ToolTextContent"
},
{
"$ref": "#/components/schemas/ToolFileContent"
}
]
}
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "callID", "structured", "content"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextToolSuccess": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.tool.success"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"structured": {
"type": "object"
},
"content": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ToolTextContent"
},
{
"$ref": "#/components/schemas/ToolFileContent"
}
]
}
},
"result": {},
"provider": {
"type": "object",
"properties": {
"executed": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": ["executed"],
"additionalProperties": false
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "callID", "structured", "content", "provider"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextToolFailed": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.tool.failed"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"error": {
"$ref": "#/components/schemas/SessionErrorUnknown"
},
"result": {},
"provider": {
"type": "object",
"properties": {
"executed": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": ["executed"],
"additionalProperties": false
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "callID", "error", "provider"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"SessionNextRetry_error": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"statusCode": {
"type": "number"
},
"isRetryable": {
"type": "boolean"
},
"responseHeaders": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"responseBody": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": ["message", "isRetryable"],
"additionalProperties": false
},
"EventSessionNextRetried": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.retried"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"attempt": {
"type": "number"
},
"error": {
"$ref": "#/components/schemas/SessionNextRetry_error"
}
},
"required": ["timestamp", "sessionID", "attempt", "error"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextCompactionStarted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.compaction.started"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"reason": {
"type": "string",
"enum": ["auto", "manual"]
}
},
"required": ["timestamp", "sessionID", "messageID", "reason"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextCompactionDelta": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.compaction.delta"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"text": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "text"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionNextCompactionEnded": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.next.compaction.ended"]
},
"properties": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"text": {
"type": "string"
},
"include": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "text"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventQuestionAsked": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["question.asked"]
},
"properties": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^que"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionInfo"
},
"description": "Questions to ask"
},
"blocking": {
"type": "boolean"
},
"tool": {
"$ref": "#/components/schemas/QuestionTool"
}
},
"required": ["id", "sessionID", "questions"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventQuestionReplied": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["question.replied"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"requestID": {
"type": "string",
"pattern": "^que"
},
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionAnswer"
}
}
},
"required": ["sessionID", "requestID", "answers"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventQuestionRejected": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["question.rejected"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"requestID": {
"type": "string",
"pattern": "^que"
}
},
"required": ["sessionID", "requestID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventMcpToolsChanged": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["mcp.tools.changed"]
},
"properties": {
"type": "object",
"properties": {
"server": {
"type": "string"
}
},
"required": ["server"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventMcpBrowserOpenFailed": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["mcp.browser.open.failed"]
},
"properties": {
"type": "object",
"properties": {
"mcpName": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": ["mcpName", "url"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventMessagePartDelta": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["message.part.delta"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
},
"field": {
"type": "string"
},
"delta": {
"type": "string"
}
},
"required": ["sessionID", "messageID", "partID", "field", "delta"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionDiff": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.diff"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"diff": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotFileDiff"
}
}
},
"required": ["sessionID", "diff"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionError": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.error"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/ProviderAuthError"
},
{
"$ref": "#/components/schemas/UnknownError"
},
{
"$ref": "#/components/schemas/MessageOutputLengthError"
},
{
"$ref": "#/components/schemas/MessageAbortedError"
},
{
"$ref": "#/components/schemas/StructuredOutputError"
},
{
"$ref": "#/components/schemas/ContextOverflowError"
},
{
"$ref": "#/components/schemas/APIError"
},
{
"$ref": "#/components/schemas/AgentRequirementError"
}
]
}
},
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventModels-devRefreshed": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["models-dev.refreshed"]
},
"properties": {
"type": "object",
"properties": {}
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventInstallationUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["installation.updated"]
},
"properties": {
"type": "object",
"properties": {
"version": {
"type": "string"
}
},
"required": ["version"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventInstallationUpdate-available": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["installation.update-available"]
},
"properties": {
"type": "object",
"properties": {
"version": {
"type": "string"
}
},
"required": ["version"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventPermissionAsked": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["permission.asked"]
},
"properties": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^per"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"permission": {
"type": "string"
},
"patterns": {
"type": "array",
"items": {
"type": "string"
}
},
"metadata": {
"type": "object"
},
"always": {
"type": "array",
"items": {
"type": "string"
}
},
"tool": {
"type": "object",
"properties": {
"messageID": {
"type": "string"
},
"callID": {
"type": "string"
}
},
"required": ["messageID", "callID"],
"additionalProperties": false
}
},
"required": ["id", "sessionID", "permission", "patterns", "metadata", "always"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventPermissionReplied": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["permission.replied"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"requestID": {
"type": "string",
"pattern": "^per"
},
"reply": {
"type": "string",
"enum": ["once", "always", "reject"]
}
},
"required": ["sessionID", "requestID", "reply"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"SessionTodoInfo": {
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "Brief description of the task"
},
"status": {
"type": "string",
"description": "Current status of the task: pending, in_progress, completed, cancelled"
},
"priority": {
"type": "string",
"description": "Priority level of the task: high, medium, low"
}
},
"required": ["content", "status", "priority"],
"additionalProperties": false
},
"EventTodoUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["todo.updated"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"todos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionTodoInfo"
}
}
},
"required": ["sessionID", "todos"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionStatus": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.status"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"status": {
"$ref": "#/components/schemas/SessionStatus"
}
},
"required": ["sessionID", "status"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionIdle": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.idle"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
}
},
"required": ["sessionID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventSessionCompacted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["session.compacted"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
}
},
"required": ["sessionID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventCommandExecuted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["command.executed"]
},
"properties": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"arguments": {
"type": "string"
},
"messageID": {
"type": "string",
"pattern": "^msg"
}
},
"required": ["name", "sessionID", "arguments", "messageID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventProjectDirectoriesUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["project.directories.updated"]
},
"properties": {
"type": "object",
"properties": {
"projectID": {
"type": "string"
}
},
"required": ["projectID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventProjectUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["project.updated"]
},
"properties": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"worktree": {
"type": "string"
},
"vcs": {
"type": "string",
"enum": ["git"]
},
"name": {
"type": "string"
},
"icon": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"override": {
"type": "string"
},
"color": {
"type": "string"
}
},
"additionalProperties": false
},
"commands": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "Startup script to run when creating a new workspace (worktree)"
}
},
"additionalProperties": false
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"minimum": 0
},
"updated": {
"type": "integer",
"minimum": 0
},
"initialized": {
"type": "integer",
"minimum": 0
}
},
"required": ["created", "updated"],
"additionalProperties": false
},
"sandboxes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["id", "worktree", "time", "sandboxes"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventLspUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["lsp.updated"]
},
"properties": {
"type": "object",
"properties": {}
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventFileEdited": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["file.edited"]
},
"properties": {
"type": "object",
"properties": {
"file": {
"type": "string"
}
},
"required": ["file"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventFileWatcherUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["file.watcher.updated"]
},
"properties": {
"type": "object",
"properties": {
"file": {
"type": "string"
},
"event": {
"type": "string",
"enum": ["add", "change", "unlink"]
}
},
"required": ["file", "event"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventVcsBranchUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["vcs.branch.updated"]
},
"properties": {
"type": "object",
"properties": {
"branch": {
"type": "string"
}
},
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventWorkspaceReady": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["workspace.ready"]
},
"properties": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": ["name"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventWorkspaceFailed": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["workspace.failed"]
},
"properties": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": ["message"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventWorkspaceStatus": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["workspace.status"]
},
"properties": {
"type": "object",
"properties": {
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"status": {
"type": "string",
"enum": ["connected", "connecting", "disconnected", "error"]
}
},
"required": ["workspaceID", "status"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventWorktreeReady": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["worktree.ready"]
},
"properties": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"branch": {
"type": "string"
}
},
"required": ["name"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventWorktreeFailed": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["worktree.failed"]
},
"properties": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": ["message"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"AuthOAuthCredential": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["oauth"]
},
"refresh": {
"type": "string"
},
"access": {
"type": "string"
},
"expires": {
"type": "integer",
"minimum": 0
},
"accountId": {
"type": "string"
}
},
"required": ["type", "refresh", "access", "expires"],
"additionalProperties": false
},
"AuthApiKeyCredential": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["api"]
},
"key": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": ["type", "key"],
"additionalProperties": false
},
"AuthCredential": {
"anyOf": [
{
"$ref": "#/components/schemas/AuthOAuthCredential"
},
{
"$ref": "#/components/schemas/AuthApiKeyCredential"
}
]
},
"AuthInfo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"serviceID": {
"type": "string"
},
"description": {
"type": "string"
},
"credential": {
"$ref": "#/components/schemas/AuthCredential"
}
},
"required": ["id", "serviceID", "description", "credential"],
"additionalProperties": false
},
"EventAccountAdded": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["account.added"]
},
"properties": {
"type": "object",
"properties": {
"account": {
"$ref": "#/components/schemas/AuthInfo"
}
},
"required": ["account"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventAccountRemoved": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["account.removed"]
},
"properties": {
"type": "object",
"properties": {
"account": {
"$ref": "#/components/schemas/AuthInfo"
}
},
"required": ["account"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventAccountSwitched": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["account.switched"]
},
"properties": {
"type": "object",
"properties": {
"serviceID": {
"type": "string"
},
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"required": ["serviceID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"PermissionV2Source": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["tool"]
},
"messageID": {
"type": "string"
},
"callID": {
"type": "string"
}
},
"required": ["type", "messageID", "callID"],
"additionalProperties": false
},
"EventPermissionV2Asked": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["permission.v2.asked"]
},
"properties": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^per"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"action": {
"type": "string"
},
"resources": {
"type": "array",
"items": {
"type": "string"
}
},
"save": {
"type": "array",
"items": {
"type": "string"
}
},
"metadata": {
"type": "object"
},
"source": {
"$ref": "#/components/schemas/PermissionV2Source"
}
},
"required": ["id", "sessionID", "action", "resources"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"PermissionV2Reply": {
"type": "string",
"enum": ["once", "always", "reject"]
},
"EventPermissionV2Replied": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["permission.v2.replied"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"requestID": {
"type": "string",
"pattern": "^per"
},
"reply": {
"$ref": "#/components/schemas/PermissionV2Reply"
}
},
"required": ["sessionID", "requestID", "reply"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventPtyCreated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["pty.created"]
},
"properties": {
"type": "object",
"properties": {
"info": {
"$ref": "#/components/schemas/Pty"
}
},
"required": ["info"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventPtyUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["pty.updated"]
},
"properties": {
"type": "object",
"properties": {
"info": {
"$ref": "#/components/schemas/Pty"
}
},
"required": ["info"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventPtyExited": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["pty.exited"]
},
"properties": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^pty"
},
"exitCode": {
"type": "integer",
"minimum": 0
}
},
"required": ["id", "exitCode"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventPtyDeleted": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["pty.deleted"]
},
"properties": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^pty"
}
},
"required": ["id"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"QuestionV2Option": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Display text (1-5 words, concise)"
},
"description": {
"type": "string",
"description": "Explanation of choice"
}
},
"required": ["label", "description"],
"additionalProperties": false
},
"QuestionV2Info": {
"type": "object",
"properties": {
"question": {
"type": "string",
"description": "Complete question"
},
"header": {
"type": "string",
"description": "Very short label (max 30 chars)"
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionV2Option"
},
"description": "Available choices"
},
"multiple": {
"type": "boolean"
},
"custom": {
"type": "boolean"
}
},
"required": ["question", "header", "options"],
"additionalProperties": false
},
"QuestionV2Tool": {
"type": "object",
"properties": {
"messageID": {
"type": "string"
},
"callID": {
"type": "string"
}
},
"required": ["messageID", "callID"],
"additionalProperties": false
},
"EventQuestionV2Asked": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["question.v2.asked"]
},
"properties": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^que"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionV2Info"
},
"description": "Questions to ask"
},
"tool": {
"$ref": "#/components/schemas/QuestionV2Tool"
}
},
"required": ["id", "sessionID", "questions"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"QuestionV2Answer": {
"type": "array",
"items": {
"type": "string"
}
},
"EventQuestionV2Replied": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["question.v2.replied"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"requestID": {
"type": "string",
"pattern": "^que"
},
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionV2Answer"
}
}
},
"required": ["sessionID", "requestID", "answers"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventQuestionV2Rejected": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["question.v2.rejected"]
},
"properties": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"requestID": {
"type": "string",
"pattern": "^que"
}
},
"required": ["sessionID", "requestID"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"SyncEventSessionCreated": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.created.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"info": {
"$ref": "#/components/schemas/Session"
}
},
"required": ["sessionID", "info"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionUpdated": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.updated.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"info": {
"$ref": "#/components/schemas/Session"
}
},
"required": ["sessionID", "info"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionDeleted": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.deleted.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"info": {
"$ref": "#/components/schemas/Session"
}
},
"required": ["sessionID", "info"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventMessageUpdated": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["message.updated.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"info": {
"$ref": "#/components/schemas/Message"
}
},
"required": ["sessionID", "info"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventMessageRemoved": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["message.removed.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
}
},
"required": ["sessionID", "messageID"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventMessagePartUpdated": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["message.part.updated.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"part": {
"$ref": "#/components/schemas/Part"
},
"time": {
"type": "number"
}
},
"required": ["sessionID", "part", "time"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventMessagePartRemoved": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["message.part.removed.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg"
},
"partID": {
"type": "string",
"pattern": "^prt"
}
},
"required": ["sessionID", "messageID", "partID"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextAgentSwitched": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.agent.switched.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"agent": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "messageID", "agent"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextModelSwitched": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.model.switched.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
}
},
"required": ["timestamp", "sessionID", "messageID", "model"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextMoved": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.moved.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"location": {
"$ref": "#/components/schemas/LocationRef"
},
"subdirectory": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "location"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextPrompted": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.prompted.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"prompt": {
"$ref": "#/components/schemas/Prompt"
},
"delivery": {
"type": "string",
"enum": ["steer", "queue"]
}
},
"required": ["timestamp", "sessionID", "messageID", "prompt", "delivery"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextPromptAdmitted": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.prompt.admitted.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"prompt": {
"$ref": "#/components/schemas/Prompt"
},
"delivery": {
"type": "string",
"enum": ["steer", "queue"]
}
},
"required": ["timestamp", "sessionID", "messageID", "prompt", "delivery"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextPromptPromoted": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.prompt.promoted.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"prompt": {
"$ref": "#/components/schemas/Prompt"
},
"timeCreated": {
"type": "number"
}
},
"required": ["timestamp", "sessionID", "messageID", "prompt", "timeCreated"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextContextUpdated": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.context.updated.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"text": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "messageID", "text"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextSynthetic": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.synthetic.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"text": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "messageID", "text"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextShellStarted": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.shell.started.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"command": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "messageID", "callID", "command"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextShellEnded": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.shell.ended.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"callID": {
"type": "string"
},
"output": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "callID", "output"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextStepStarted": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.step.started.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"snapshot": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "agent", "model"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextStepEnded": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.step.ended.2"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"finish": {
"type": "string"
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"snapshot": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "finish", "cost", "tokens"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextStepFailed": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.step.failed.2"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"error": {
"$ref": "#/components/schemas/SessionErrorUnknown"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "error"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextTextStarted": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.text.started.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"textID": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "textID"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextTextEnded": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.text.ended.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"textID": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "textID", "text"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextReasoningStarted": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.reasoning.started.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"reasoningID": {
"type": "string"
},
"providerMetadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "reasoningID"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextReasoningEnded": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.reasoning.ended.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"reasoningID": {
"type": "string"
},
"text": {
"type": "string"
},
"providerMetadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "reasoningID", "text"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextToolInputStarted": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.tool.input.started.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "callID", "name"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextToolInputEnded": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.tool.input.ended.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "callID", "text"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextToolCalled": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.tool.called.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"tool": {
"type": "string"
},
"input": {
"type": "object"
},
"provider": {
"type": "object",
"properties": {
"executed": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": ["executed"],
"additionalProperties": false
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "callID", "tool", "input", "provider"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextToolProgress": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.tool.progress.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"structured": {
"type": "object"
},
"content": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ToolTextContent"
},
{
"$ref": "#/components/schemas/ToolFileContent"
}
]
}
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "callID", "structured", "content"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextToolSuccess": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.tool.success.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"structured": {
"type": "object"
},
"content": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ToolTextContent"
},
{
"$ref": "#/components/schemas/ToolFileContent"
}
]
}
},
"result": {},
"provider": {
"type": "object",
"properties": {
"executed": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": ["executed"],
"additionalProperties": false
}
},
"required": [
"timestamp",
"sessionID",
"assistantMessageID",
"callID",
"structured",
"content",
"provider"
],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextToolFailed": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.tool.failed.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"assistantMessageID": {
"type": "string",
"pattern": "^msg_"
},
"callID": {
"type": "string"
},
"error": {
"$ref": "#/components/schemas/SessionErrorUnknown"
},
"result": {},
"provider": {
"type": "object",
"properties": {
"executed": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": ["executed"],
"additionalProperties": false
}
},
"required": ["timestamp", "sessionID", "assistantMessageID", "callID", "error", "provider"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextRetried": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.retried.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"attempt": {
"type": "number"
},
"error": {
"$ref": "#/components/schemas/SessionNextRetry_error"
}
},
"required": ["timestamp", "sessionID", "attempt", "error"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextCompactionStarted": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.compaction.started.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"messageID": {
"type": "string",
"pattern": "^msg_"
},
"reason": {
"type": "string",
"enum": ["auto", "manual"]
}
},
"required": ["timestamp", "sessionID", "messageID", "reason"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextCompactionDelta": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.compaction.delta.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"text": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "text"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"SyncEventSessionNextCompactionEnded": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["sync"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"syncEvent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["session.next.compaction.ended.1"]
},
"id": {
"type": "string",
"pattern": "^evt_"
},
"seq": {
"type": "number"
},
"aggregateID": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"text": {
"type": "string"
},
"include": {
"type": "string"
}
},
"required": ["timestamp", "sessionID", "text"],
"additionalProperties": false
}
},
"required": ["type", "id", "seq", "aggregateID", "data"],
"additionalProperties": false
}
},
"required": ["type", "id", "syncEvent"],
"additionalProperties": false
},
"PolicyEffect": {
"type": "string",
"enum": ["allow", "deny"]
},
"ConfigV2ExperimentalPolicy": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": ["provider.use"]
},
"effect": {
"$ref": "#/components/schemas/PolicyEffect"
},
"resource": {
"type": "string"
}
},
"required": ["action", "effect", "resource"],
"additionalProperties": false
},
"ProjectDirectories": {
"type": "array",
"items": {
"type": "string"
}
},
"ProjectCopyCopy": {
"type": "object",
"properties": {
"directory": {
"type": "string"
}
},
"required": ["directory"],
"additionalProperties": false
},
"LocationInfo": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"workspaceID": {
"type": "string",
"pattern": "^wrk"
},
"project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"directory": {
"type": "string"
}
},
"required": ["id", "directory"],
"additionalProperties": false
}
},
"required": ["directory", "project"],
"additionalProperties": false
},
"PermissionV2Effect": {
"type": "string",
"enum": ["allow", "deny", "ask"]
},
"PermissionV2Rule": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"resource": {
"type": "string"
},
"effect": {
"$ref": "#/components/schemas/PermissionV2Effect"
}
},
"required": ["action", "resource", "effect"],
"additionalProperties": false
},
"PermissionV2Ruleset": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionV2Rule"
}
},
"AgentV2Info": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"request": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"body": {
"type": "object"
}
},
"required": ["headers", "body"],
"additionalProperties": false
},
"system": {
"type": "string"
},
"description": {
"type": "string"
},
"mode": {
"type": "string",
"enum": ["subagent", "primary", "all"]
},
"hidden": {
"type": "boolean"
},
"color": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
{
"type": "string",
"enum": ["primary", "secondary", "accent", "success", "warning", "error", "info"]
}
]
},
"steps": {
"type": "integer",
"exclusiveMinimum": 0
},
"permissions": {
"$ref": "#/components/schemas/PermissionV2Ruleset"
}
},
"required": ["id", "request", "mode", "hidden", "permissions"],
"additionalProperties": false
},
"SessionV2Info": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^ses"
},
"parentID": {
"type": "string",
"pattern": "^ses"
},
"projectID": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
},
"updated": {
"type": "number"
},
"archived": {
"type": "number"
}
},
"required": ["created", "updated"],
"additionalProperties": false
},
"title": {
"type": "string"
},
"location": {
"$ref": "#/components/schemas/LocationRef"
},
"subpath": {
"type": "string"
}
},
"required": ["id", "projectID", "cost", "tokens", "time", "title", "location"],
"additionalProperties": false
},
"SessionInputAdmitted": {
"type": "object",
"properties": {
"admittedSeq": {
"type": "integer",
"minimum": 0
},
"id": {
"type": "string",
"pattern": "^msg_"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"prompt": {
"$ref": "#/components/schemas/Prompt"
},
"delivery": {
"type": "string",
"enum": ["steer", "queue"]
},
"timeCreated": {
"type": "number"
},
"promotedSeq": {
"type": "integer",
"minimum": 0
}
},
"required": ["admittedSeq", "id", "sessionID", "prompt", "delivery", "timeCreated"],
"additionalProperties": false
},
"SessionMessageAgentSwitched": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^msg_"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
}
},
"required": ["created"],
"additionalProperties": false
},
"type": {
"type": "string",
"enum": ["agent-switched"]
},
"agent": {
"type": "string"
}
},
"required": ["id", "time", "type", "agent"],
"additionalProperties": false
},
"SessionMessageModelSwitched": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^msg_"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
}
},
"required": ["created"],
"additionalProperties": false
},
"type": {
"type": "string",
"enum": ["model-switched"]
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
}
},
"required": ["id", "time", "type", "model"],
"additionalProperties": false
},
"SessionMessageUser": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^msg_"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
}
},
"required": ["created"],
"additionalProperties": false
},
"text": {
"type": "string"
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PromptFileAttachment"
}
},
"agents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PromptAgentAttachment"
}
},
"references": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PromptReferenceAttachment"
}
},
"type": {
"type": "string",
"enum": ["user"]
}
},
"required": ["id", "time", "text", "type"],
"additionalProperties": false
},
"SessionMessageSynthetic": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^msg_"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
}
},
"required": ["created"],
"additionalProperties": false
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"text": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["synthetic"]
}
},
"required": ["id", "time", "sessionID", "text", "type"],
"additionalProperties": false
},
"SessionMessageSystem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^msg_"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
}
},
"required": ["created"],
"additionalProperties": false
},
"type": {
"type": "string",
"enum": ["system"]
},
"text": {
"type": "string"
}
},
"required": ["id", "time", "type", "text"],
"additionalProperties": false
},
"SessionMessageShell": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^msg_"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
},
"completed": {
"type": "number"
}
},
"required": ["created"],
"additionalProperties": false
},
"type": {
"type": "string",
"enum": ["shell"]
},
"callID": {
"type": "string"
},
"command": {
"type": "string"
},
"output": {
"type": "string"
}
},
"required": ["id", "time", "type", "callID", "command", "output"],
"additionalProperties": false
},
"SessionMessageAssistantText": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["text"]
},
"id": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": ["type", "id", "text"],
"additionalProperties": false
},
"SessionMessageAssistantReasoning": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["reasoning"]
},
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"providerMetadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": ["type", "id", "text"],
"additionalProperties": false
},
"SessionMessageToolStatePending": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["pending"]
},
"input": {
"type": "string"
}
},
"required": ["status", "input"],
"additionalProperties": false
},
"SessionMessageToolStateRunning": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["running"]
},
"input": {
"type": "object"
},
"structured": {
"type": "object"
},
"content": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ToolTextContent"
},
{
"$ref": "#/components/schemas/ToolFileContent"
}
]
}
}
},
"required": ["status", "input", "structured", "content"],
"additionalProperties": false
},
"SessionMessageToolStateCompleted": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["completed"]
},
"input": {
"type": "object"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PromptFileAttachment"
}
},
"content": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ToolTextContent"
},
{
"$ref": "#/components/schemas/ToolFileContent"
}
]
}
},
"structured": {
"type": "object"
},
"result": {}
},
"required": ["status", "input", "content", "structured"],
"additionalProperties": false
},
"SessionMessageToolStateError": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["error"]
},
"input": {
"type": "object"
},
"content": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ToolTextContent"
},
{
"$ref": "#/components/schemas/ToolFileContent"
}
]
}
},
"structured": {
"type": "object"
},
"error": {
"$ref": "#/components/schemas/SessionErrorUnknown"
},
"result": {}
},
"required": ["status", "input", "content", "structured", "error"],
"additionalProperties": false
},
"SessionMessageAssistantTool": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["tool"]
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"provider": {
"type": "object",
"properties": {
"executed": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"resultMetadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": ["executed"],
"additionalProperties": false
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/SessionMessageToolStatePending"
},
{
"$ref": "#/components/schemas/SessionMessageToolStateRunning"
},
{
"$ref": "#/components/schemas/SessionMessageToolStateCompleted"
},
{
"$ref": "#/components/schemas/SessionMessageToolStateError"
}
]
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
},
"ran": {
"type": "number"
},
"completed": {
"type": "number"
},
"pruned": {
"type": "number"
}
},
"required": ["created"],
"additionalProperties": false
}
},
"required": ["type", "id", "name", "state", "time"],
"additionalProperties": false
},
"SessionMessageAssistant": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^msg_"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
},
"completed": {
"type": "number"
}
},
"required": ["created"],
"additionalProperties": false
},
"type": {
"type": "string",
"enum": ["assistant"]
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"content": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/SessionMessageAssistantText"
},
{
"$ref": "#/components/schemas/SessionMessageAssistantReasoning"
},
{
"$ref": "#/components/schemas/SessionMessageAssistantTool"
}
]
}
},
"snapshot": {
"type": "object",
"properties": {
"start": {
"type": "string"
},
"end": {
"type": "string"
}
},
"additionalProperties": false
},
"finish": {
"type": "string"
},
"cost": {
"type": "number"
},
"tokens": {
"type": "object",
"properties": {
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"reasoning": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "reasoning", "cache"],
"additionalProperties": false
},
"error": {
"$ref": "#/components/schemas/SessionErrorUnknown"
}
},
"required": ["id", "time", "type", "agent", "model", "content"],
"additionalProperties": false
},
"SessionMessageCompaction": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["compaction"]
},
"reason": {
"type": "string",
"enum": ["auto", "manual"]
},
"summary": {
"type": "string"
},
"include": {
"type": "string"
},
"id": {
"type": "string",
"pattern": "^msg_"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
"created": {
"type": "number"
}
},
"required": ["created"],
"additionalProperties": false
}
},
"required": ["type", "reason", "summary", "id", "time"],
"additionalProperties": false
},
"SessionMessage": {
"anyOf": [
{
"$ref": "#/components/schemas/SessionMessageAgentSwitched"
},
{
"$ref": "#/components/schemas/SessionMessageModelSwitched"
},
{
"$ref": "#/components/schemas/SessionMessageUser"
},
{
"$ref": "#/components/schemas/SessionMessageSynthetic"
},
{
"$ref": "#/components/schemas/SessionMessageSystem"
},
{
"$ref": "#/components/schemas/SessionMessageShell"
},
{
"$ref": "#/components/schemas/SessionMessageAssistant"
},
{
"$ref": "#/components/schemas/SessionMessageCompaction"
}
]
},
"ProviderV2Info": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"enabled": {
"anyOf": [
{
"type": "boolean",
"enum": [false]
},
{
"type": "object",
"properties": {
"via": {
"type": "string",
"enum": ["env"]
},
"name": {
"type": "string"
}
},
"required": ["via", "name"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"via": {
"type": "string",
"enum": ["account"]
},
"service": {
"type": "string"
}
},
"required": ["via", "service"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"via": {
"type": "string",
"enum": ["custom"]
},
"data": {
"type": "object"
}
},
"required": ["via", "data"],
"additionalProperties": false
}
]
},
"env": {
"type": "array",
"items": {
"type": "string"
}
},
"api": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["aisdk"]
},
"package": {
"type": "string"
},
"url": {
"type": "string"
},
"settings": {
"type": "object"
}
},
"required": ["type", "package"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["native"]
},
"url": {
"type": "string"
},
"settings": {
"type": "object"
}
},
"required": ["type", "settings"],
"additionalProperties": false
}
]
},
"request": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"body": {
"type": "object"
}
},
"required": ["headers", "body"],
"additionalProperties": false
}
},
"required": ["id", "name", "enabled", "env", "api", "request"],
"additionalProperties": false
},
"PermissionV2Request": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^per"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"action": {
"type": "string"
},
"resources": {
"type": "array",
"items": {
"type": "string"
}
},
"save": {
"type": "array",
"items": {
"type": "string"
}
},
"metadata": {
"type": "object"
},
"source": {
"$ref": "#/components/schemas/PermissionV2Source"
}
},
"required": ["id", "sessionID", "action", "resources"],
"additionalProperties": false
},
"PermissionSavedInfo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"projectID": {
"type": "string"
},
"action": {
"type": "string"
},
"resource": {
"type": "string"
}
},
"required": ["id", "projectID", "action", "resource"],
"additionalProperties": false
},
"FileSystemTextContent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["text"]
},
"content": {
"type": "string"
},
"mime": {
"type": "string"
}
},
"required": ["type", "content", "mime"],
"additionalProperties": false
},
"FileSystemBinaryContent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["binary"]
},
"content": {
"type": "string"
},
"encoding": {
"type": "string",
"enum": ["base64"]
},
"mime": {
"type": "string"
}
},
"required": ["type", "content", "encoding", "mime"],
"additionalProperties": false
},
"FileSystemEntry": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"uri": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["file", "directory"]
},
"mime": {
"type": "string"
}
},
"required": ["path", "uri", "type", "mime"],
"additionalProperties": false
},
"CommandV2Info": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"template": {
"type": "string"
},
"description": {
"type": "string"
},
"agent": {
"type": "string"
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": ["id", "providerID"],
"additionalProperties": false
},
"subtask": {
"type": "boolean"
}
},
"required": ["name", "template"],
"additionalProperties": false
},
"SkillV2Info": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"slash": {
"type": "boolean"
},
"location": {
"type": "string"
},
"content": {
"type": "string"
}
},
"required": ["name", "location", "content"],
"additionalProperties": false
},
"QuestionV2Request": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^que"
},
"sessionID": {
"type": "string",
"pattern": "^ses"
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionV2Info"
},
"description": "Questions to ask"
},
"tool": {
"$ref": "#/components/schemas/QuestionV2Tool"
}
},
"required": ["id", "sessionID", "questions"],
"additionalProperties": false
},
"QuestionV2Reply": {
"type": "object",
"properties": {
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionV2Answer"
},
"description": "User answers in order of questions (each answer is an array of selected labels)"
}
},
"required": ["answers"],
"additionalProperties": false
},
"EventMemoryStatus1": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["memory.status"]
},
"properties": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"sessionID": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": ["idle", "checking", "injecting", "updating", "skipped", "error"]
},
"reason": {
"type": "string"
},
"project": {
"type": "object",
"properties": {
"bytes": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"estimatedTokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"truncated": {
"type": "boolean"
},
"updatedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
}
},
"required": ["bytes", "estimatedTokens", "truncated"],
"additionalProperties": false
},
"consolidation": {
"type": "object",
"properties": {
"trigger": {
"type": "string",
"enum": ["explicit", "turn-close", "rebuild"]
},
"operationCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"cost": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"tokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
}
},
"required": ["trigger", "operationCount", "cost", "tokens"],
"additionalProperties": false
},
"detail": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["saved", "skipped", "recalled"]
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
},
"duplicateOf": {
"type": "string"
},
"tokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"operationCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"skippedCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"sources": {
"type": "array",
"items": {
"type": "string"
}
},
"files": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["type", "message"],
"additionalProperties": false
}
},
"required": ["directory", "enabled", "state", "project"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventMemoryUpdated1": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["memory.updated"]
},
"properties": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"sessionID": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": ["idle", "checking", "injecting", "updating", "skipped", "error"]
},
"reason": {
"type": "string"
},
"project": {
"type": "object",
"properties": {
"bytes": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"estimatedTokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"truncated": {
"type": "boolean"
},
"updatedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
}
},
"required": ["bytes", "estimatedTokens", "truncated"],
"additionalProperties": false
},
"consolidation": {
"type": "object",
"properties": {
"trigger": {
"type": "string",
"enum": ["explicit", "turn-close", "rebuild"]
},
"operationCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"cost": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"tokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
}
},
"required": ["trigger", "operationCount", "cost", "tokens"],
"additionalProperties": false
},
"detail": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["saved", "skipped", "recalled"]
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
},
"duplicateOf": {
"type": "string"
},
"tokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"operationCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"skippedCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"sources": {
"type": "array",
"items": {
"type": "string"
}
},
"files": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["type", "message"],
"additionalProperties": false
}
},
"required": ["directory", "enabled", "state", "project"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"EventMemoryError1": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["memory.error"]
},
"properties": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"sessionID": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": ["idle", "checking", "injecting", "updating", "skipped", "error"]
},
"reason": {
"type": "string"
},
"project": {
"type": "object",
"properties": {
"bytes": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"estimatedTokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"truncated": {
"type": "boolean"
},
"updatedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
}
},
"required": ["bytes", "estimatedTokens", "truncated"],
"additionalProperties": false
},
"consolidation": {
"type": "object",
"properties": {
"trigger": {
"type": "string",
"enum": ["explicit", "turn-close", "rebuild"]
},
"operationCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"cost": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"tokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
}
},
"required": ["trigger", "operationCount", "cost", "tokens"],
"additionalProperties": false
},
"detail": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["saved", "skipped", "recalled"]
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
},
"duplicateOf": {
"type": "string"
},
"tokens": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"operationCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"skippedCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
},
"sources": {
"type": "array",
"items": {
"type": "string"
}
},
"files": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["type", "message"],
"additionalProperties": false
}
},
"required": ["directory", "enabled", "state", "project"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"ModelV2Info1": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"providerID": {
"type": "string"
},
"family": {
"type": "string"
},
"name": {
"type": "string"
},
"api": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["aisdk"]
},
"package": {
"type": "string"
},
"url": {
"type": "string"
},
"settings": {
"type": "object"
}
},
"required": ["id", "type", "package"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["native"]
},
"url": {
"type": "string"
},
"settings": {
"type": "object"
}
},
"required": ["id", "type", "settings"],
"additionalProperties": false
}
]
},
"capabilities": {
"type": "object",
"properties": {
"tools": {
"type": "boolean"
},
"input": {
"type": "array",
"items": {
"type": "string"
}
},
"output": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["tools", "input", "output"],
"additionalProperties": false
},
"request": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"body": {
"type": "object"
},
"variant": {
"type": "string"
}
},
"required": ["headers", "body"],
"additionalProperties": false
},
"variants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"body": {
"type": "object"
}
},
"required": ["id", "headers", "body"],
"additionalProperties": false
}
},
"time": {
"type": "object",
"properties": {
"released": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": ["NaN"]
},
{
"type": "string",
"enum": ["Infinity"]
},
{
"type": "string",
"enum": ["-Infinity"]
}
]
}
},
"required": ["released"],
"additionalProperties": false
},
"cost": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tier": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["context"]
},
"size": {
"type": "integer"
}
},
"required": ["type", "size"],
"additionalProperties": false
},
"input": {
"type": "number"
},
"output": {
"type": "number"
},
"cache": {
"type": "object",
"properties": {
"read": {
"type": "number"
},
"write": {
"type": "number"
}
},
"required": ["read", "write"],
"additionalProperties": false
}
},
"required": ["input", "output", "cache"],
"additionalProperties": false
}
},
"status": {
"type": "string",
"enum": ["alpha", "beta", "deprecated", "active"]
},
"enabled": {
"type": "boolean"
},
"limit": {
"type": "object",
"properties": {
"context": {
"type": "integer"
},
"input": {
"type": "integer"
},
"output": {
"type": "integer"
}
},
"required": ["context", "output"],
"additionalProperties": false
}
},
"required": [
"id",
"providerID",
"name",
"api",
"capabilities",
"request",
"variants",
"time",
"cost",
"status",
"enabled",
"limit"
],
"additionalProperties": false
},
"EventTuiToastShow1": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["tui.toast.show"]
},
"properties": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"message": {
"type": "string"
},
"variant": {
"type": "string",
"enum": ["info", "success", "warning", "error"]
},
"duration": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"required": ["message", "variant"],
"additionalProperties": false
}
},
"required": ["id", "type", "properties"],
"additionalProperties": false
},
"BadRequestError": {
"type": "object",
"required": ["name", "data"],
"properties": {
"name": {
"type": "string",
"enum": ["BadRequest"]
},
"data": {
"type": "object",
"required": ["message"],
"properties": {
"message": {
"type": "string"
},
"kind": {
"type": "string",
"enum": ["Params", "Headers", "Query", "Body", "Payload"]
}
}
}
}
}
}
},
"security": [],
"tags": [
{
"name": "control",
"description": "Control plane routes."
},
{
"name": "controlPlane",
"description": "Control-plane orchestration routes."
},
{
"name": "global",
"description": "Global server routes."
},
{
"name": "event",
"description": "Instance event stream route."
},
{
"name": "config",
"description": "Experimental HttpApi config routes."
},
{
"name": "experimental",
"description": "Experimental HttpApi read-only routes."
},
{
"name": "file",
"description": "Experimental HttpApi file routes."
},
{
"name": "instance",
"description": "Experimental HttpApi instance read routes."
},
{
"name": "mcp",
"description": "Experimental HttpApi MCP routes."
},
{
"name": "project",
"description": "Experimental HttpApi project routes."
},
{
"name": "projectCopy",
"description": "Project copy management routes."
},
{
"name": "pty",
"description": "Experimental HttpApi PTY routes."
},
{
"name": "question",
"description": "Question routes."
},
{
"name": "permission",
"description": "Experimental HttpApi permission routes."
},
{
"name": "provider",
"description": "Experimental HttpApi provider routes."
},
{
"name": "session",
"description": "Experimental HttpApi session routes."
},
{
"name": "sync",
"description": "Experimental HttpApi sync routes."
},
{
"name": "tui",
"description": "Experimental HttpApi TUI routes."
},
{
"name": "workspace",
"description": "Experimental HttpApi workspace routes."
},
{
"name": "agent-builder",
"description": "Kilo agent builder routes."
},
{
"name": "background-process",
"description": "Kilo background process routes."
},
{
"name": "branch-name",
"description": "Kilo branch name routes."
},
{
"name": "commit-message",
"description": "Kilo commit message routes."
},
{
"name": "config-console",
"description": "Kilo Console config routes."
},
{
"name": "enhance-prompt",
"description": "Kilo enhance prompt routes."
},
{
"name": "indexing",
"description": "Kilo indexing routes."
},
{
"name": "instance-reload",
"description": "Kilo instance reload route."
},
{
"name": "interactive-terminal",
"description": "Kilo human-driven interactive terminal routes."
},
{
"name": "kilo",
"description": "Kilo Gateway routes."
},
{
"name": "kilocode",
"description": "Kilo-specific routes."
},
{
"name": "anaconda-desktop",
"description": "Local Anaconda Desktop provider setup routes."
},
{
"name": "network",
"description": "Kilo network routes."
},
{
"name": "remote",
"description": "Kilo remote connection routes."
},
{
"name": "sandbox",
"description": "Kilo session sandbox routes."
},
{
"name": "session-import",
"description": "Kilo legacy session import routes."
},
{
"name": "suggestion",
"description": "Kilo suggestion routes."
},
{
"name": "telemetry",
"description": "Kilo telemetry routes."
},
{
"name": "memory",
"description": "Kilo memory routes."
},
{
"name": "kilo experimental HttpApi",
"description": "Experimental HttpApi surface for selected instance routes."
},
{
"name": "kilo experimental HttpApi",
"description": "Experimental HttpApi surface for selected instance routes."
},
{
"name": "v2",
"description": "Experimental v2 routes."
},
{
"name": "v2 messages",
"description": "Experimental v2 message routes."
},
{
"name": "v2 models",
"description": "Experimental v2 model routes."
},
{
"name": "v2 providers",
"description": "Experimental v2 provider routes."
},
{
"name": "v2 permissions",
"description": "Experimental v2 permission routes."
},
{
"name": "v2 session permissions",
"description": "Experimental v2 session permission routes."
},
{
"name": "v2 saved permissions",
"description": "Experimental v2 saved permission routes."
},
{
"name": "v2 filesystem",
"description": "Experimental v2 location-scoped filesystem routes."
},
{
"name": "v2 commands",
"description": "Experimental v2 command routes."
},
{
"name": "v2 skills",
"description": "Experimental v2 skill routes."
},
{
"name": "v2 events",
"description": "Experimental v2 event stream route."
},
{
"name": "v2 questions",
"description": "Experimental v2 question routes."
},
{
"name": "v2 session questions",
"description": "Experimental v2 session question routes."
},
{
"name": "pty",
"description": "PTY websocket route."
}
]
}
Reference in New Issue View Git Blame Copy Permalink