{ "openapi": "3.1.0", "info": { "title": "Querio API", "version": "0.0.1", "description": "API for Querio, the data platform that lets teams and customers explore data directly with agentic notebooks for instant insights.\n\nSelected resource operations with bearer authentication. Request and response extraction is partial; omitted schemas do not mean empty payloads. Exact success statuses and error contracts are not fully exported.", "contact": { "name": "Querio", "url": "https://querio.ai/support", "email": "hello@querio.ai" }, "termsOfService": "https://querio.ai/security/terms-of-service" }, "servers": [ { "url": "https://app.querio.ai" } ], "externalDocs": { "url": "https://docs.querio.ai", "description": "Querio documentation" }, "x-querio-contract-status": "partial", "x-querio-selection-status": "reviewed", "paths": { "/api/v2/me": { "get": { "operationId": "get__api_v2_me", "tags": [ "Identity and sessions" ], "summary": "Get the authenticated identity", "description": "Read the authenticated Querio identity.", "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "email": { "anyOf": [ { "type": "null", "enum": [ null ] }, { "type": "string" } ] } }, "required": [ "userId", "email" ], "additionalProperties": true } } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": false, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v2/workspaces": { "get": { "operationId": "get__api_v2_workspaces", "tags": [ "Workspaces" ], "summary": "List available workspaces", "description": "List workspaces available to the authenticated identity.", "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": { "type": "array", "items": {} } } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": false, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/gated/workspace": { "get": { "operationId": "get__api_gated_workspace", "tags": [ "Workspaces" ], "summary": "Get workspace details", "description": "Read details of the selected workspace.", "deprecated": true, "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": {} } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/workspaces": { "post": { "operationId": "post__api_v3_workspaces", "tags": [ "Workspaces" ], "summary": "Provision a workspace", "description": "Provision a workspace. Reuse the same request ID and name after a failed attempt rather than creating a duplicate. Creation does not change the caller's local workspace selection.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The API trims leading and trailing whitespace before subsequent validation.", "allOf": [ { "pattern": "^\\s*(?:\\S|\\S[\\s\\S]{0,118}\\S)\\s*$(?![\\s\\S])" } ] }, "requestId": { "type": "string", "pattern": "^[A-Za-z0-9_-]+$", "minLength": 1, "maxLength": 128 }, "fileMode": { "type": "string", "enum": [ "canonical", "changeset" ] }, "git": { "type": "boolean" }, "context": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1 }, "exclude": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "include", "exclude" ], "additionalProperties": false } }, "required": [ "name", "requestId" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": false, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/datasource-connections/schema": { "get": { "operationId": "get__api_v3_datasource_connections_schema", "tags": [ "Datasource credentials" ], "summary": "Get the connection configuration schema", "description": "Return the canonical JSON Schema for supported datasource connection configurations.", "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": {} } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/datasources/{slug}/setup": { "get": { "operationId": "get__api_v3_datasources_by_slug_setup", "tags": [ "Datasource metadata" ], "summary": "Get a datasource setup link", "description": "Return a browser setup link for a new datasource slug. Does not create a datasource or accept credentials. Ask the user to complete the browser form and confirm completion, then read datasource metadata and introspect. Do not poll setup. Returns 409 if the slug already exists.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "next": { "type": "string" } }, "required": [ "url", "next" ], "additionalProperties": true } } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/datasources/{slug}": { "get": { "operationId": "get__api_v3_datasources_by_slug", "tags": [ "Datasource metadata" ], "summary": "Get datasource metadata", "description": "Read datasource metadata by slug. Does not return connection credentials.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "kind": { "type": "string" }, "name": { "anyOf": [ { "type": "null", "enum": [ null ] }, { "type": "string" } ] }, "revision": { "type": "number" }, "configured": { "type": "boolean" }, "embedded": { "type": "boolean" } }, "required": [ "id", "slug", "kind", "name", "revision", "configured", "embedded" ], "additionalProperties": true } } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] }, "put": { "operationId": "put__api_v3_datasources_by_slug", "tags": [ "Datasource credentials" ], "summary": "Replace a datasource connection", "description": "Deprecated single-connection editing endpoint retained for the connection form used by callers who cannot manage credentials. Use PUT /api/v3/datasources/{slug}/credentials/{credentialId} to replace a specific credential using its expected revision, and PATCH /api/v3/datasources/{slug} to rename the datasource. This endpoint edits the stable Default credential and can also update datasource metadata; it is not a drop-in equivalent to credential replacement.", "deprecated": true, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "connection": { "$ref": "#/components/schemas/cee.DatasourceConfig", "x-querio-validation-rules": [ "Connection must not exceed 1 MiB" ], "description": "Server-validated rule: Connection must not exceed 1 MiB" }, "name": { "anyOf": [ { "type": "string", "description": "The API trims leading and trailing whitespace before subsequent validation.", "allOf": [ { "pattern": "^\\s*(?:\\S|\\S[\\s\\S]{0,118}\\S)\\s*$(?![\\s\\S])" } ] }, { "type": "null", "enum": [ null ] } ] }, "testConnection": { "type": "boolean", "default": false } }, "required": [ "connection" ], "additionalProperties": false } } } }, "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "kind": { "type": "string" }, "name": { "anyOf": [ { "type": "null", "enum": [ null ] }, { "type": "string" } ] }, "revision": { "type": "number" }, "configured": { "type": "boolean" }, "embedded": { "type": "boolean" } }, "required": [ "id", "slug", "kind", "name", "revision", "configured", "embedded" ], "additionalProperties": true } } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] }, "delete": { "operationId": "delete__api_v3_datasources_by_slug", "tags": [ "Datasource metadata" ], "summary": "Remove a datasource", "description": "Remove a datasource from the workspace.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string" }, "deleted": { "type": "boolean" } }, "required": [ "slug", "deleted" ], "additionalProperties": true } } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/datasources": { "post": { "operationId": "post__api_v3_datasources", "tags": [ "Datasource metadata" ], "summary": "Create a datasource", "description": "Create a datasource and connection credential, optionally testing the connection before saving.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,119}$" }, "connection": { "$ref": "#/components/schemas/cee.DatasourceConfig", "x-querio-validation-rules": [ "Connection must not exceed 1 MiB" ], "description": "Server-validated rule: Connection must not exceed 1 MiB" }, "name": { "anyOf": [ { "type": "string", "description": "The API trims leading and trailing whitespace before subsequent validation.", "allOf": [ { "pattern": "^\\s*(?:\\S|\\S[\\s\\S]{0,118}\\S)\\s*$(?![\\s\\S])" } ] }, { "type": "null", "enum": [ null ] } ] }, "testConnection": { "type": "boolean", "default": false }, "kind": { "type": "string", "enum": [ "postgres", "mysql2", "mssql", "hana", "bigquery", "ssh", "snowflake", "redshift", "clickhouse", "duckdb", "files", "databricks", "mongodb" ] } }, "required": [ "slug" ], "additionalProperties": false, "x-querio-validation-rules": [ "Datasource kind is required", "Credential backend type must match the datasource", "A connection is required for testing" ], "description": "Server-validated rule: Datasource kind is required\n\nServer-validated rule: Credential backend type must match the datasource\n\nServer-validated rule: A connection is required for testing" } } } }, "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "kind": { "type": "string" }, "name": { "anyOf": [ { "type": "null", "enum": [ null ] }, { "type": "string" } ] }, "revision": { "type": "number" }, "configured": { "type": "boolean" }, "embedded": { "type": "boolean" } }, "required": [ "id", "slug", "kind", "name", "revision", "configured", "embedded" ], "additionalProperties": true } } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] }, "get": { "operationId": "get__api_v3_datasources", "tags": [ "Datasource metadata" ], "summary": "List datasources", "description": "List datasource metadata visible to the caller in the current workspace.", "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": {} }, "required": [ "items" ], "additionalProperties": true } } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/cee/workspace/catalog/available-schemas": { "get": { "operationId": "get__api_cee_workspace_catalog_available_schemas", "tags": [ "Datasource metadata" ], "summary": "List live datasource schemas", "description": "List live datasource schemas and whether each is represented in the workspace catalog. This endpoint remains supported and needs to move into the v3 API namespace; its current path is unchanged.", "parameters": [ { "in": "query", "name": "slug", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/cee/workspace/catalog/available-tables": { "get": { "operationId": "get__api_cee_workspace_catalog_available_tables", "tags": [ "Datasource metadata" ], "summary": "List live datasource tables", "description": "List live tables in a datasource schema and whether each is represented in the workspace catalog. This endpoint remains supported and needs to move into the v3 API namespace; its current path is unchanged.", "parameters": [ { "in": "query", "name": "slug", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "schema", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/cee/workspace/catalog/pull": { "post": { "operationId": "post__api_cee_workspace_catalog_pull", "tags": [ "Datasource metadata" ], "summary": "Introspect and save the datasource catalog", "description": "Introspect a datasource synchronously and save its workspace catalog. This endpoint remains supported and needs to move into the v3 API namespace; its current path is unchanged. Prefer explicit schema or table targets; refresh updates already-catalogued tables rather than discovering new ones. Returns a catalog path, not a job. Cancellation does not roll back catalog writes.", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to pull schemas/tables into catalog.\n\nTargets can be schema names or schema.table specifiers.\n\n``refresh`` re-pulls what is already catalogued instead of pulling new\nobjects: bare-schema and empty targets expand to the tables currently in\nthe catalog rather than the whole live schema. This is what the Refresh\nbutton sends -- on a huge schema (e.g. SAP, 150k+ tables) an unscoped\nwhole-schema pull is unusable, and \"refresh\" should mean \"update what I\ncurated,\" not \"ingest the entire database.\"", "properties": { "all": { "default": false, "type": "boolean" }, "refresh": { "default": false, "type": "boolean" }, "slug": { "type": "string" }, "targets": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null } }, "required": [ "slug" ], "type": "object" } } }, "required": true }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/notebooks": { "post": { "operationId": "post__api_v3_notebooks", "tags": [ "Notebook documents" ], "summary": "Create a saved notebook", "description": "Create a saved notebook. Opening a session and executing its cells are separate operations.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "The API trims leading and trailing whitespace before subsequent validation.", "allOf": [ { "pattern": "^\\s*(?:\\S|\\S[\\s\\S]{0,}\\S)\\s*$(?![\\s\\S])" } ] }, "serialization": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "1.0.0" ] }, "app": { "type": "object", "properties": { "options": { "type": "object", "additionalProperties": {}, "default": {} } }, "additionalProperties": false }, "cells": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "_" }, "code": { "type": "string", "default": "" }, "cell_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null", "enum": [ null ] } ], "default": null }, "options": { "type": "object", "additionalProperties": {}, "default": {} } }, "additionalProperties": false }, "default": [] }, "valid": { "type": "boolean", "default": true }, "ui_values": { "type": "object", "additionalProperties": {}, "default": {} } }, "required": [ "version", "app" ], "additionalProperties": false } }, "additionalProperties": false } } } }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/notebooks/{id}": { "get": { "operationId": "get__api_v3_notebooks_by_id", "tags": [ "Notebook documents" ], "summary": "Get a saved notebook", "description": "Read a saved notebook, including its cells and concurrency timestamp. This is persisted state, not the live runtime.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] }, "patch": { "operationId": "patch__api_v3_notebooks_by_id", "tags": [ "Notebook documents" ], "summary": "Update a saved notebook", "description": "Update a saved notebook using the last-read updatedAt timestamp. Title-only updates are allowed during an open session; replacing cells requires closing the session. Do not retry conflicts blindly.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedUpdatedAt": { "type": "string", "pattern": "^((\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-((0[13578]|1[02])-(0[1-9]|[12]\\d|3[01])|(0[469]|11)-(0[1-9]|[12]\\d|30)|(02)-(0[1-9]|1\\d|2[0-8])))T([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d(\\.\\d+)?)?(Z|([+-]\\d{2}:?\\d{2}))$" }, "title": { "type": "string", "description": "The API trims leading and trailing whitespace before subsequent validation.", "allOf": [ { "pattern": "^\\s*(?:\\S|\\S[\\s\\S]{0,}\\S)\\s*$(?![\\s\\S])" } ] }, "serialization": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "1.0.0" ] }, "app": { "type": "object", "properties": { "options": { "type": "object", "additionalProperties": {}, "default": {} } }, "additionalProperties": false }, "cells": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "_" }, "code": { "type": "string", "default": "" }, "cell_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null", "enum": [ null ] } ], "default": null }, "options": { "type": "object", "additionalProperties": {}, "default": {} } }, "additionalProperties": false }, "default": [] }, "valid": { "type": "boolean", "default": true }, "ui_values": { "type": "object", "additionalProperties": {}, "default": {} } }, "required": [ "version", "app" ], "additionalProperties": false } }, "required": [ "expectedUpdatedAt" ], "additionalProperties": false, "x-querio-validation-rules": [ "Supply title or serialization" ], "description": "Server-validated rule: Supply title or serialization" } } } }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/execution-environments": { "post": { "operationId": "post__api_v3_execution_environments", "tags": [ "Execution environments" ], "summary": "Create an execution environment", "description": "Create an execution environment without opening a notebook. An environment hosts one active notebook session at a time; use separate environments for concurrent notebooks.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cee.CreateEnvironmentRequest" } } } }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/execution-environments/{environmentId}": { "get": { "operationId": "get__api_v3_execution_environments_by_environmentId", "tags": [ "Execution environments" ], "summary": "Get an execution environment", "description": "Read an execution environment's state.", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] }, "delete": { "operationId": "delete__api_v3_execution_environments_by_environmentId", "tags": [ "Execution environments" ], "summary": "Close an execution environment", "description": "Close an execution environment. Close its attached sessions first; saved notebooks remain.", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/notebook-sessions": { "post": { "operationId": "post__api_v3_notebook_sessions", "tags": [ "Notebook sessions" ], "summary": "Open a notebook session", "description": "Open a saved notebook in an execution environment with session-specific datasources and variables. Each notebook and environment can have only one active notebook session. Creation does not execute cells; use separate environments for concurrent notebooks.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "notebookId": { "type": "string", "pattern": "^[A-Za-z0-9_-]+$" }, "environmentId": { "type": "string", "pattern": "^[A-Za-z0-9_-]+$" }, "mode": { "type": "string", "enum": [ "edit", "run" ], "default": "edit" }, "config": { "type": "object", "properties": { "datasourceSlugs": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [] }, "variables": { "type": "object", "additionalProperties": { "type": "string" }, "default": {} } }, "additionalProperties": false, "default": {} } }, "required": [ "notebookId", "environmentId" ], "additionalProperties": false }, { "$ref": "#/components/schemas/cee.CreateNotebookSessionRequest" } ] } } } }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/notebook-sessions/{id}": { "get": { "operationId": "get__api_v3_notebook_sessions_by_id", "tags": [ "Notebook sessions" ], "summary": "Inspect or restore a notebook session", "description": "Inspect or restore a notebook session. Reading a saved session may restart its runtime, so this is not a side-effect-free read.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] }, "delete": { "operationId": "delete__api_v3_notebook_sessions_by_id", "tags": [ "Notebook sessions" ], "summary": "Save and close a notebook session", "description": "Close a notebook session, saving its current notebook before releasing it. A failed save leaves the session open. Close only sessions you own or were asked to close; saved notebooks remain.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/notebook-sessions/{id}/executions": { "get": { "operationId": "get__api_v3_notebook_sessions_by_id_executions", "tags": [ "Notebook sessions" ], "summary": "List historical notebook executions", "description": "List historical and in-progress executions for a notebook session. Set order=desc for newest first; default order=asc is oldest first. After sessions_execute, use order=desc and match item.id to its returned runId. Pending and running executions are included; check that same ID until terminal, then inspect status, errors, and results. Paginate using nextCursor as after while keeping the same order.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-query-schema": { "type": "object", "properties": { "order": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "after": { "type": "string", "minLength": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "additionalProperties": true }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/notebook-sessions/{id}/events": { "post": { "operationId": "post__api_v3_notebook_sessions_by_id_events", "tags": [ "Notebook sessions" ], "summary": "Submit a notebook-session event", "description": "Submit a run-all request and inspect the resulting run for execution outcomes. This export documents only run-all; other runtime event variants are outside this reference.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/cee.ManagedNotebookEvent" }, "type": { "const": "run-all", "type": "string" } }, "required": [ "type", "data" ], "type": "object" } ] } } } }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-request-subset": "run-all", "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/runs/{id}": { "get": { "operationId": "get__api_v3_runs_by_id", "tags": [ "Runs" ], "summary": "Get run status and results", "description": "Deprecated shared agent/notebook run endpoint. Run inspection needs to be split into separate agent and notebook APIs; replacement endpoints are not yet defined. This endpoint reads a run's status and structured results. Inspect execution errors separately from HTTP success.", "deprecated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/runs/{id}/cancel": { "post": { "operationId": "post__api_v3_runs_by_id_cancel", "tags": [ "Runs" ], "summary": "Request run cancellation", "description": "Deprecated shared agent/notebook run endpoint. Run cancellation needs to be split into separate agent and notebook APIs; replacement endpoints are not yet defined. This endpoint requests cancellation of a run. Read its status to observe completion. Cancellation is not rollback and does not guarantee that a remote warehouse query has stopped.", "deprecated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/cee/kernel/execute": { "post": { "operationId": "post__api_cee_kernel_execute", "tags": [ "Code execution" ], "summary": "Execute Python in a notebook session", "description": "Execute Python in the selected live notebook session. This endpoint remains supported; it is intended to move into the v3 API namespace. Its current path is /api/cee/kernel/execute. In an editable session, wait for the resulting notebook save before reporting success. A save failure does not undo execution: keep the session open and resolve the error rather than replaying authoring code. Inspect execution errors separately from HTTP success.", "parameters": [ { "in": "header", "name": "Querio-Session-Id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cee.ExecuteCodeRequest" } } }, "required": true }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/files/stat": { "get": { "operationId": "get__api_v3_files_stat", "tags": [ "Workspace files" ], "summary": "Stat a workspace path", "description": "Read file or directory metadata in the selected workspace filesystem.", "parameters": [ { "in": "query", "name": "path", "required": true, "schema": { "description": "Workspace-relative path; the server rejects paths that escape the workspace.", "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-query-schema": { "$ref": "#/components/schemas/cee.FilePathQuery" }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/files/list": { "get": { "operationId": "get__api_v3_files_list", "tags": [ "Workspace files" ], "summary": "List workspace files", "description": "List a page of files and directories in the selected workspace filesystem.", "parameters": [ { "in": "query", "name": "path", "required": false, "schema": { "default": ".", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 200, "maximum": 1000, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-query-schema": { "$ref": "#/components/schemas/cee.FileListQuery" }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/files/read": { "get": { "operationId": "get__api_v3_files_read", "tags": [ "Workspace files" ], "summary": "Read a workspace file", "description": "Read file contents from the selected workspace filesystem.", "parameters": [ { "in": "query", "name": "path", "required": true, "schema": { "description": "Workspace-relative path; the server rejects paths that escape the workspace.", "type": "string" } }, { "in": "header", "name": "If-Match", "required": false, "schema": { "description": "Either * (no revision comparison) or one quoted, lowercase, 64-character revision.", "pattern": "^(?:\\*|\"[0-9a-f]{64}\")(?![\\s\\S])", "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-query-schema": { "$ref": "#/components/schemas/cee.FilePathQuery" }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/files/write": { "put": { "operationId": "put__api_v3_files_write", "tags": [ "Workspace files" ], "summary": "Write a workspace file", "description": "Writes directly to shared canonical workspace files, bypassing changesets. A session ID does not change the destination. Do not use this tool for isolated changeset edits. Write complete file contents as JSON {content, encoding} (utf8 or canonical padded base64) or raw application/octet-stream bytes. Supply create/overwrite query flags or revision headers, never both. To create without replacing existing files, set create=true and overwrite=false. Parent directories must exist; create them with the mkdir endpoint. Request and decoded file size limits apply. Do not blindly retry an uncertain write.", "parameters": [ { "in": "query", "name": "path", "required": true, "schema": { "description": "Workspace-relative path; the server rejects paths that escape the workspace.", "type": "string" } }, { "in": "query", "name": "create", "required": false, "schema": { "enum": [ "false", "true" ] } }, { "in": "query", "name": "overwrite", "required": false, "schema": { "enum": [ "false", "true" ] } }, { "in": "header", "name": "If-Match", "required": false, "schema": { "description": "Either * (no revision comparison) or one quoted, lowercase, 64-character revision.", "pattern": "^(?:\\*|\"[0-9a-f]{64}\")(?![\\s\\S])", "type": "string" } }, { "in": "header", "name": "If-None-Match", "required": false, "schema": { "enum": [ "*" ] } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cee.FileWriteBody" } }, "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "required": true }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-query-schema": { "$ref": "#/components/schemas/cee.FileWriteQuery" }, "x-querio-validation-rules": [ "Use either create/overwrite query flags or revision headers, never both. In flag mode, each absent flag defaults to false.", "Without query flags, supply either If-None-Match: * to create a file or If-Match to overwrite it. Do not supply both headers.", "The server rejects request bodies and decoded files larger than 104857600 bytes.", "JSON bodies contain content and encoding (utf8 or canonical padded base64). Use application/octet-stream for raw bytes, including raw JSON file contents." ], "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/files/mkdir": { "post": { "operationId": "post__api_v3_files_mkdir", "tags": [ "Workspace files" ], "summary": "Create a workspace directory", "description": "Creates a directory directly in shared canonical workspace files, bypassing changesets. A session ID does not change the destination. Do not use this tool for isolated changeset edits.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cee.WorkspaceFsCreateDirectoryRequest" } } } }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/changesets/current": { "get": { "operationId": "get__api_v3_changesets_current", "tags": [ "Changesets" ], "summary": "Inspect current changeset status", "description": "Inspect working filesystem changes and canonical divergence for the changeset attached to an open session's environment. Requires Querio-Session-Id using changeset-backed files. Works after the idle runtime unloads without restarting it. Notebook edits are stored separately. Status currently scans the working tree and, when mounted, canonical files; cost scales with total file count even with no edits. Avoid tight polling on large workspaces.", "parameters": [ { "in": "header", "name": "Querio-Session-Id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-validation-rules": [ "Querio-Session-Id must identify an open session in the current workspace whose environment uses changeset-backed files. An idle-unloaded runtime is not required or restarted." ], "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/changesets/current/diff": { "get": { "operationId": "get__api_v3_changesets_current_diff", "tags": [ "Changesets" ], "summary": "Get the current changeset diff", "description": "Read working filesystem changes against the current changeset's base. Requires an open Querio-Session-Id using changeset-backed files, not a resident runtime. Review this diff before publication. Notebook edits are stored separately. This uses the same full-tree status scans plus inline diff formatting; it is not a cheap changed-file-only read. Binary or oversized changes do not include inline text diffs.", "parameters": [ { "in": "header", "name": "Querio-Session-Id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-validation-rules": [ "Querio-Session-Id must identify an open session in the current workspace whose environment uses changeset-backed files. An idle-unloaded runtime is not required or restarted." ], "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/changesets": { "get": { "operationId": "get__api_v3_changesets", "tags": [ "Changesets" ], "summary": "List changesets", "description": "List durable workspace working copies and their provenance.", "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] }, "post": { "operationId": "post__api_v3_changesets", "tags": [ "Changesets" ], "summary": "Create a changeset", "description": "Create a durable working copy, optionally from an uploaded source version. Does not promote it to canonical.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cee.CreateChangeset" } } } }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/changesets/{changesetId}": { "get": { "operationId": "get__api_v3_changesets_by_changesetId", "tags": [ "Changesets" ], "summary": "Get a changeset", "description": "Inspect a durable working copy and its state. Currently scans the full working tree and, when mounted, canonical files to detect changes and divergence. This is not a cheap metadata-only lookup; avoid tight polling on large workspaces.", "parameters": [ { "name": "changesetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/changesets/git/import": { "post": { "operationId": "post__api_v3_changesets_git_import", "tags": [ "Git context" ], "summary": "Import a Git source version", "description": "Import selected committed files as an immutable source version without changing canonical. The caller supplies the selection and commit metadata; the server does not evaluate local TOML globs.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "source": { "type": "object", "properties": { "repository": { "type": "string", "minLength": 1, "maxLength": 2048 }, "commit": { "type": "string", "pattern": "^(?:[0-9a-f]{40}|[0-9a-f]{64})$" }, "config_path": { "type": "string", "minLength": 1 }, "config_sha256": { "type": "string", "pattern": "^[0-9a-f]{64}$" } }, "required": [ "repository", "commit", "config_path", "config_sha256" ], "additionalProperties": false }, "files": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1 }, "content": { "type": "string", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" }, "kind": { "type": "string", "enum": [ "file", "executable", "symlink" ], "default": "file" } }, "required": [ "path", "content" ], "additionalProperties": false } } }, "required": [ "source", "files" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/changesets/git/patch": { "post": { "operationId": "post__api_v3_changesets_git_patch", "tags": [ "Git context" ], "summary": "Export a Git patch", "description": "Export a binary-safe Git patch for explicitly selected changed files in a working copy, intended for local/manual workflows using git apply against the source commit. Pause writers first. This checkpoints the working copy and currently rebuilds both full snapshot trees in a temporary Git store, so cost scales with total files and content, not only selected edits. Avoid using patch export as a hosted-provider upload format: GitHub does not accept patch bytes in its create-PR API. Provider adapters should instead use checkpoint-pinned structured changes and changed-file contents; no public structured-export route exists yet. Export does not approve or promote changes.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "changesetId": { "type": "string", "pattern": "^[A-Za-z0-9_-]+$" }, "paths": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1 } }, "required": [ "changesetId", "paths" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/changesets/git/promote": { "post": { "operationId": "post__api_v3_changesets_git_promote", "tags": [ "Git context" ], "summary": "Promote Git context", "description": "Publish reviewed filesystem changes. Supply changesetId, the previously inspected expectedCanonicalVersion, and changed-file paths. Without GitHub, publish the entire changeset; paths do not limit local publication. With GitHub, open a pull request for those paths instead. Pause writers before publishing. Notebook edits are not filesystem changes. Alternatively, supply version and expectedCanonicalVersion to promote an imported Git version. Publication is not filesystem-atomic. Do not automatically retry mutations. The GitHub handler exports selected checkpoint-pinned file contents and uses GitHub HTTP APIs to create the commit, branch and PR, preserving source parentage and unselected files. It does not generate a patch or fetch a local Git repository. Status and checkpoint work still scale with workspace size. A failed or lost response can leave a remote branch or PR; inspect before retrying.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "string", "pattern": "^[A-Za-z0-9_-]+$" }, "expectedCanonicalVersion": { "type": "string", "pattern": "^[A-Za-z0-9_-]+$" } }, "required": [ "version", "expectedCanonicalVersion" ], "additionalProperties": false }, { "type": "object", "properties": { "changesetId": { "type": "string", "pattern": "^[A-Za-z0-9_-]+$", "minLength": 1, "maxLength": 128 }, "expectedCanonicalVersion": { "type": "string", "pattern": "^[A-Za-z0-9_-]+$" }, "paths": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1 } }, "required": [ "changesetId", "expectedCanonicalVersion", "paths" ], "additionalProperties": false } ] } } } }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/datasource-connections/test": { "post": { "operationId": "post__api_v3_datasource_connections_test", "tags": [ "Datasource credentials" ], "summary": "Test an unsaved connection", "description": "Test a supplied datasource connection through the query gateway without saving it.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "connection": { "$ref": "#/components/schemas/cee.DatasourceConfig", "x-querio-validation-rules": [ "Connection must not exceed 1 MiB" ], "description": "Server-validated rule: Connection must not exceed 1 MiB" } }, "required": [ "connection" ], "additionalProperties": false } } } }, "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "ok": { "type": "boolean" }, "elapsedMs": { "type": "number" } }, "required": [ "message", "ok", "elapsedMs" ], "additionalProperties": true } } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/datasources/{slug}/test": { "post": { "operationId": "post__api_v3_datasources_by_slug_test", "tags": [ "Datasource credentials" ], "summary": "Test a saved datasource connection", "description": "Test the stored connection for a datasource.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "ok": { "type": "boolean" }, "elapsedMs": { "type": "number" } }, "required": [ "message", "ok", "elapsedMs" ], "additionalProperties": true } } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/datasources/{slug}/credentials": { "get": { "operationId": "get__api_v3_datasources_by_slug_credentials", "tags": [ "Datasource credentials" ], "summary": "List datasource credentials", "description": "List credential records associated with a datasource.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": {} }, "required": [ "items" ], "additionalProperties": true } } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] }, "post": { "operationId": "post__api_v3_datasources_by_slug_credentials", "tags": [ "Datasource credentials" ], "summary": "Create a datasource credential", "description": "Create a named credential for a datasource, optionally testing the connection before saving. Its backend type must match the datasource.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The API trims leading and trailing whitespace before subsequent validation.", "allOf": [ { "pattern": "^\\s*(?:\\S|\\S[\\s\\S]{0,118}\\S)\\s*$(?![\\s\\S])" } ] }, "connection": { "$ref": "#/components/schemas/cee.DatasourceConfig", "x-querio-validation-rules": [ "Connection must not exceed 1 MiB" ], "description": "Server-validated rule: Connection must not exceed 1 MiB" }, "testConnection": { "type": "boolean", "default": false } }, "required": [ "name", "connection" ], "additionalProperties": false } } } }, "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": {} } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/datasources/{slug}/credentials/{credentialId}": { "get": { "operationId": "get__api_v3_datasources_by_slug_credentials_by_credentialId", "tags": [ "Datasource credentials" ], "summary": "Get a datasource credential", "description": "Read a credential record for a datasource by credential ID.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "credentialId", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": {}, "name": {}, "revision": {}, "default": { "type": "boolean" }, "createdAt": {}, "updatedAt": {} }, "required": [ "id", "name", "revision", "default", "createdAt", "updatedAt" ], "additionalProperties": true } } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] }, "put": { "operationId": "put__api_v3_datasources_by_slug_credentials_by_credentialId", "tags": [ "Datasource credentials" ], "summary": "Replace a datasource credential", "description": "Replace a datasource credential using an expected revision, optionally testing before saving. The backend type must match the datasource.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "credentialId", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The API trims leading and trailing whitespace before subsequent validation.", "allOf": [ { "pattern": "^\\s*(?:\\S|\\S[\\s\\S]{0,118}\\S)\\s*$(?![\\s\\S])" } ] }, "connection": { "$ref": "#/components/schemas/cee.DatasourceConfig", "x-querio-validation-rules": [ "Connection must not exceed 1 MiB" ], "description": "Server-validated rule: Connection must not exceed 1 MiB" }, "testConnection": { "type": "boolean", "default": false }, "expectedRevision": { "type": "integer", "minimum": 1 } }, "additionalProperties": false, "required": [ "connection", "expectedRevision" ] } } } }, "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": {} } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] }, "delete": { "operationId": "delete__api_v3_datasources_by_slug_credentials_by_credentialId", "tags": [ "Datasource credentials" ], "summary": "Delete a datasource credential", "description": "Delete a datasource credential only if its revision matches the expected revision.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "credentialId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expectedRevision", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Inferred success response; exact status is not specified.", "content": { "application/json": { "schema": {} } } }, "default": { "description": "Response contract is not available in this export." } }, "x-querio-query-schema": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 1 } }, "required": [ "expectedRevision" ], "additionalProperties": false }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/secrets": { "get": { "operationId": "get__api_v3_secrets", "tags": [ "Secrets" ], "summary": "List workspace secrets", "description": "List workspace secrets using the supplied filters and pagination.", "parameters": [ { "name": "kind", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-query-schema": { "type": "object", "properties": { "kind": { "type": "string", "maxLength": 64 }, "after": { "type": "string", "maxLength": 128 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "additionalProperties": false }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/secrets/{id}": { "get": { "operationId": "get__api_v3_secrets_by_id", "tags": [ "Secrets" ], "summary": "Get a workspace secret", "description": "Read a workspace secret by ID.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/files/remove": { "post": { "operationId": "post__api_v3_files_remove", "tags": [ "Workspace files" ], "summary": "Remove a workspace path", "description": "Remove a file or directory from the selected workspace filesystem.", "parameters": [ { "in": "header", "name": "If-Match", "required": true, "schema": { "description": "Either * (no revision comparison) or one quoted, lowercase, 64-character revision.", "pattern": "^(?:\\*|\"[0-9a-f]{64}\")(?![\\s\\S])", "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cee.WorkspaceFsDeleteRequest" } } }, "required": true }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/files/rename": { "post": { "operationId": "post__api_v3_files_rename", "tags": [ "Workspace files" ], "summary": "Rename a workspace path", "description": "Rename or move a file or directory in the selected workspace filesystem.", "parameters": [ { "in": "header", "name": "If-Match", "required": true, "schema": { "description": "Either * (no revision comparison) or one quoted, lowercase, 64-character revision.", "pattern": "^(?:\\*|\"[0-9a-f]{64}\")(?![\\s\\S])", "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cee.WorkspaceFsRenameRequest" } } }, "required": true }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/environments/{environmentId}/files/stat": { "get": { "operationId": "get__api_v3_environments_by_environmentId_files_stat", "tags": [ "Environment files" ], "summary": "Stat an environment path", "description": "Read file or directory metadata in an execution environment's filesystem.", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "path", "required": true, "schema": { "description": "Workspace-relative path; the server rejects paths that escape the workspace.", "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Session-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-query-schema": { "$ref": "#/components/schemas/cee.FilePathQuery" }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/environments/{environmentId}/files/list": { "get": { "operationId": "get__api_v3_environments_by_environmentId_files_list", "tags": [ "Environment files" ], "summary": "List environment files", "description": "List a page of files and directories in an execution environment's filesystem.", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "path", "required": false, "schema": { "default": ".", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 200, "maximum": 1000, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Session-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-query-schema": { "$ref": "#/components/schemas/cee.FileListQuery" }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/environments/{environmentId}/files/read": { "get": { "operationId": "get__api_v3_environments_by_environmentId_files_read", "tags": [ "Environment files" ], "summary": "Read an environment file", "description": "Read file contents from an execution environment's filesystem.", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "path", "required": true, "schema": { "description": "Workspace-relative path; the server rejects paths that escape the workspace.", "type": "string" } }, { "in": "header", "name": "If-Match", "required": false, "schema": { "description": "Either * (no revision comparison) or one quoted, lowercase, 64-character revision.", "pattern": "^(?:\\*|\"[0-9a-f]{64}\")(?![\\s\\S])", "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Session-Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-query-schema": { "$ref": "#/components/schemas/cee.FilePathQuery" }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/environments/{environmentId}/files/write": { "put": { "operationId": "put__api_v3_environments_by_environmentId_files_write", "tags": [ "Environment files" ], "summary": "Write an environment file", "description": "Write complete file contents in an execution environment, respecting create and overwrite flags. Parent directories must exist.", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "path", "required": true, "schema": { "description": "Workspace-relative path; the server rejects paths that escape the workspace.", "type": "string" } }, { "in": "query", "name": "create", "required": false, "schema": { "enum": [ "false", "true" ] } }, { "in": "query", "name": "overwrite", "required": false, "schema": { "enum": [ "false", "true" ] } }, { "in": "header", "name": "If-Match", "required": false, "schema": { "description": "Either * (no revision comparison) or one quoted, lowercase, 64-character revision.", "pattern": "^(?:\\*|\"[0-9a-f]{64}\")(?![\\s\\S])", "type": "string" } }, { "in": "header", "name": "If-None-Match", "required": false, "schema": { "enum": [ "*" ] } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Session-Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cee.FileWriteBody" } }, "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "required": true }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-query-schema": { "$ref": "#/components/schemas/cee.FileWriteQuery" }, "x-querio-validation-rules": [ "Use either create/overwrite query flags or revision headers, never both. In flag mode, each absent flag defaults to false.", "Without query flags, supply either If-None-Match: * to create a file or If-Match to overwrite it. Do not supply both headers.", "The server rejects request bodies and decoded files larger than 104857600 bytes.", "JSON bodies contain content and encoding (utf8 or canonical padded base64). Use application/octet-stream for raw bytes, including raw JSON file contents." ], "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/environments/{environmentId}/files/mkdir": { "post": { "operationId": "post__api_v3_environments_by_environmentId_files_mkdir", "tags": [ "Environment files" ], "summary": "Create an environment directory", "description": "Create a directory in an execution environment's filesystem.", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Session-Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cee.WorkspaceFsCreateDirectoryRequest" } } } }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/environments/{environmentId}/files/remove": { "post": { "operationId": "post__api_v3_environments_by_environmentId_files_remove", "tags": [ "Environment files" ], "summary": "Remove an environment path", "description": "Remove a file or directory from an execution environment's filesystem.", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "description": "Either * (no revision comparison) or one quoted, lowercase, 64-character revision.", "pattern": "^(?:\\*|\"[0-9a-f]{64}\")(?![\\s\\S])", "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Session-Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cee.WorkspaceFsDeleteRequest" } } }, "required": true }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } }, "/api/v3/environments/{environmentId}/files/rename": { "post": { "operationId": "post__api_v3_environments_by_environmentId_files_rename", "tags": [ "Environment files" ], "summary": "Rename an environment path", "description": "Rename or move a file or directory within an execution environment's filesystem.", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "description": "Either * (no revision comparison) or one quoted, lowercase, 64-character revision.", "pattern": "^(?:\\*|\"[0-9a-f]{64}\")(?![\\s\\S])", "type": "string" } }, { "in": "header", "name": "Querio-Workspace-Id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Querio-Session-Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cee.WorkspaceFsRenameRequest" } } }, "required": true }, "responses": { "default": { "description": "Response contract is not available in this export." } }, "x-querio-workspace-required": true, "security": [ { "bearer": [] } ], "x-querio-contract-status": "partial", "x-querio-contract-gaps": [ "response: Response contract is not fully exported.", "response: Exact success statuses and error responses are not fully exported." ] } } }, "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "description": "OAuth access tokens, programmatic access tokens, embedded credentials, and execution credentials accepted by the existing authenticator. An explicit Authorization header takes precedence over cookies; invalid tokens never fall back to a cookie." } }, "schemas": { "cee.DatasourceConfig": { "anyOf": [ { "$ref": "#/components/schemas/cee.PostgresDatasource" }, { "$ref": "#/components/schemas/cee.Mysql2Datasource" }, { "$ref": "#/components/schemas/cee.MssqlDatasource" }, { "$ref": "#/components/schemas/cee.HanaDatasource" }, { "$ref": "#/components/schemas/cee.BigQueryDatasource" }, { "$ref": "#/components/schemas/cee.SshDatasource" }, { "$ref": "#/components/schemas/cee.SnowflakeDatasource" }, { "$ref": "#/components/schemas/cee.RedshiftDatasource" }, { "$ref": "#/components/schemas/cee.ClickHouseDatasource" }, { "$ref": "#/components/schemas/cee.DuckDBDatasource" }, { "$ref": "#/components/schemas/cee.FilesDatasource" }, { "$ref": "#/components/schemas/cee.DatabricksDatasource" }, { "$ref": "#/components/schemas/cee.MongodbDatasource" } ], "discriminator": { "mapping": { "bigquery": "#/components/schemas/cee.BigQueryDatasource", "clickhouse": "#/components/schemas/cee.ClickHouseDatasource", "databricks": "#/components/schemas/cee.DatabricksDatasource", "duckdb": "#/components/schemas/cee.DuckDBDatasource", "files": "#/components/schemas/cee.FilesDatasource", "hana": "#/components/schemas/cee.HanaDatasource", "mongodb": "#/components/schemas/cee.MongodbDatasource", "mssql": "#/components/schemas/cee.MssqlDatasource", "mysql2": "#/components/schemas/cee.Mysql2Datasource", "postgres": "#/components/schemas/cee.PostgresDatasource", "redshift": "#/components/schemas/cee.RedshiftDatasource", "snowflake": "#/components/schemas/cee.SnowflakeDatasource", "ssh": "#/components/schemas/cee.SshDatasource" }, "propertyName": "kind" } }, "cee.PostgresDatasource": { "additionalProperties": false, "properties": { "connection_string": { "type": "string" }, "embedded": { "default": false, "type": "boolean" }, "kind": { "enum": [ "postgres" ] }, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "required": [ "kind", "connection_string" ], "title": "PostgresDatasource", "type": "object" }, "cee.Mysql2Datasource": { "additionalProperties": false, "properties": { "connection_string": { "type": "string" }, "embedded": { "default": false, "type": "boolean" }, "kind": { "enum": [ "mysql2" ] } }, "required": [ "kind", "connection_string" ], "title": "Mysql2Datasource", "type": "object" }, "cee.MssqlDatasource": { "additionalProperties": false, "properties": { "authentication": { "anyOf": [ { "$ref": "#/components/schemas/cee.MssqlConnectionStringAuth" }, { "$ref": "#/components/schemas/cee.MssqlActiveDirectoryServicePrincipalAuth" } ], "discriminator": { "mapping": { "active_directory_service_principal": "#/components/schemas/cee.MssqlActiveDirectoryServicePrincipalAuth", "connection_string": "#/components/schemas/cee.MssqlConnectionStringAuth" }, "propertyName": "type" } }, "embedded": { "default": false, "type": "boolean" }, "kind": { "enum": [ "mssql" ] } }, "required": [ "kind", "authentication" ], "title": "MssqlDatasource", "type": "object" }, "cee.MssqlConnectionStringAuth": { "additionalProperties": false, "properties": { "connection_string": { "type": "string" }, "type": { "enum": [ "connection_string" ] } }, "required": [ "type", "connection_string" ], "title": "MssqlConnectionStringAuth", "type": "object" }, "cee.MssqlActiveDirectoryServicePrincipalAuth": { "additionalProperties": false, "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "database": { "type": "string" }, "port": { "default": 1433, "type": "integer" }, "server": { "type": "string" }, "tenant_id": { "type": "string" }, "type": { "enum": [ "active_directory_service_principal" ] } }, "required": [ "type", "server", "database", "client_id", "tenant_id", "client_secret" ], "title": "MssqlActiveDirectoryServicePrincipalAuth", "type": "object" }, "cee.HanaDatasource": { "additionalProperties": false, "properties": { "connection_string": { "type": "string" }, "embedded": { "default": false, "type": "boolean" }, "kind": { "enum": [ "hana" ] }, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "required": [ "kind", "connection_string" ], "title": "HanaDatasource", "type": "object" }, "cee.BigQueryDatasource": { "additionalProperties": false, "properties": { "embedded": { "default": false, "type": "boolean" }, "kind": { "enum": [ "bigquery" ] }, "service_account_key": { "anyOf": [ { "type": "object" }, { "type": "string" } ] } }, "required": [ "kind", "service_account_key" ], "title": "BigQueryDatasource", "type": "object" }, "cee.SshDatasource": { "additionalProperties": false, "properties": { "db": { "$ref": "#/components/schemas/cee.SshDbConfig" }, "dst_addr": { "type": "string" }, "dst_port": { "type": "integer" }, "embedded": { "default": false, "type": "boolean" }, "host": { "type": "string" }, "kind": { "enum": [ "ssh" ] }, "port": { "default": 22, "type": "integer" }, "private_key": { "type": "string" }, "username": { "type": "string" } }, "required": [ "kind", "host", "username", "private_key", "dst_addr", "dst_port", "db" ], "title": "SshDatasource", "type": "object" }, "cee.SshDbConfig": { "additionalProperties": false, "properties": { "client": { "type": "string" }, "db_schema": { "default": "public", "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "user": { "type": "string" } }, "required": [ "client", "name", "user", "password" ], "title": "SshDbConfig", "type": "object" }, "cee.SnowflakeDatasource": { "additionalProperties": false, "properties": { "account": { "type": "string" }, "database": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "database_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "embedded": { "default": false, "type": "boolean" }, "kind": { "enum": [ "snowflake" ] }, "user": { "type": "string" }, "warehouse": { "type": "string" } }, "required": [ "kind", "user", "warehouse", "account" ], "title": "SnowflakeDatasource", "type": "object" }, "cee.RedshiftDatasource": { "additionalProperties": false, "properties": { "database": { "type": "string" }, "embedded": { "default": false, "type": "boolean" }, "host": { "type": "string" }, "kind": { "enum": [ "redshift" ] }, "password": { "type": "string" }, "port": { "default": 5439, "type": "integer" }, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "ssl": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "username": { "type": "string" } }, "required": [ "kind", "host", "database", "username", "password" ], "title": "RedshiftDatasource", "type": "object" }, "cee.ClickHouseDatasource": { "additionalProperties": false, "properties": { "embedded": { "default": false, "type": "boolean" }, "host": { "type": "string" }, "kind": { "enum": [ "clickhouse" ] }, "password": { "type": "string" }, "secure": { "default": true, "type": "boolean" }, "user": { "type": "string" }, "verify": { "default": true, "type": "boolean" } }, "required": [ "kind", "host", "user", "password" ], "title": "ClickHouseDatasource", "type": "object" }, "cee.DuckDBDatasource": { "additionalProperties": false, "properties": { "connection_string": { "type": "string" }, "embedded": { "default": false, "type": "boolean" }, "kind": { "enum": [ "duckdb" ] } }, "required": [ "kind", "connection_string" ], "title": "DuckDBDatasource", "type": "object" }, "cee.FilesDatasource": { "additionalProperties": false, "properties": { "embedded": { "default": false, "type": "boolean" }, "kind": { "enum": [ "files" ] }, "path": { "default": "files", "type": "string" } }, "required": [ "kind" ], "title": "FilesDatasource", "type": "object" }, "cee.DatabricksDatasource": { "additionalProperties": false, "properties": { "access_token": { "type": "string" }, "catalog": { "type": "string" }, "embedded": { "default": false, "type": "boolean" }, "host": { "type": "string" }, "http_path": { "type": "string" }, "kind": { "enum": [ "databricks" ] }, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "required": [ "kind", "host", "http_path", "access_token", "catalog" ], "title": "DatabricksDatasource", "type": "object" }, "cee.MongodbDatasource": { "additionalProperties": false, "properties": { "database": { "type": "string" }, "embedded": { "default": false, "type": "boolean" }, "kind": { "enum": [ "mongodb" ] }, "password": { "type": "string" }, "uri": { "type": "string" }, "user": { "type": "string" } }, "required": [ "kind", "uri", "database", "user", "password" ], "title": "MongodbDatasource", "type": "object" }, "cee.CreateEnvironmentRequest": { "additionalProperties": false, "properties": { "changesetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "required": [], "title": "CreateEnvironmentRequest", "type": "object" }, "cee.CreateNotebookSessionRequest": { "additionalProperties": false, "properties": { "config": { "$ref": "#/components/schemas/cee.NotebookConfiguration" }, "environmentId": { "pattern": "^[A-Za-z0-9_-]+$", "type": "string" }, "mode": { "$ref": "#/components/schemas/cee.SessionMode", "default": "edit" }, "notebookId": { "pattern": "^[A-Za-z0-9_-]+$", "type": "string" } }, "required": [ "notebookId", "environmentId" ], "title": "CreateNotebookSessionRequest", "type": "object" }, "cee.NotebookConfiguration": { "additionalProperties": false, "properties": { "datasourceSlugs": { "default": [], "items": { "type": "string" }, "type": "array" }, "variables": { "additionalProperties": { "type": "string" }, "default": {}, "type": "object" } }, "required": [], "title": "NotebookConfiguration", "type": "object" }, "cee.SessionMode": { "enum": [ "edit", "run" ], "title": "SessionMode" }, "cee.ManagedNotebookEvent": { "additionalProperties": false, "properties": { "cacheMode": { "enum": [ "default", "no-cache", "no-store" ] }, "runId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "required": [ "cacheMode" ], "title": "ManagedNotebookEvent", "type": "object" }, "cee.ExecuteCodeRequest": { "description": "ExecuteCodeRequest(code: 'str', tool_call_id: 'str | None' = None)", "properties": { "code": { "type": "string" }, "toolCallId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "required": [ "code" ], "type": "object" }, "cee.FilePathQuery": { "properties": { "path": { "description": "Workspace-relative path; the server rejects paths that escape the workspace.", "type": "string" } }, "required": [ "path" ], "title": "FilePathQuery", "type": "object" }, "cee.FileListQuery": { "properties": { "cursor": { "type": "string" }, "limit": { "default": 200, "maximum": 1000, "minimum": 1, "type": "integer" }, "path": { "default": ".", "type": "string" } }, "required": [], "title": "FileListQuery", "type": "object" }, "cee.FileWriteBody": { "additionalProperties": false, "properties": { "content": { "type": "string" }, "encoding": { "enum": [ "base64", "utf8" ] } }, "required": [ "content", "encoding" ], "title": "FileWriteBody", "type": "object" }, "cee.FileWriteQuery": { "properties": { "create": { "enum": [ "false", "true" ] }, "overwrite": { "enum": [ "false", "true" ] }, "path": { "description": "Workspace-relative path; the server rejects paths that escape the workspace.", "type": "string" } }, "required": [ "path" ], "title": "FileWriteQuery", "type": "object" }, "cee.WorkspaceFsCreateDirectoryRequest": { "description": "WorkspaceFsCreateDirectoryRequest(path: 'str')", "properties": { "path": { "type": "string" } }, "required": [ "path" ], "type": "object" }, "cee.CreateChangeset": { "additionalProperties": false, "properties": { "baseVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "required": [], "title": "CreateChangeset", "type": "object" }, "cee.WorkspaceFsDeleteRequest": { "description": "WorkspaceFsDeleteRequest(path: 'str', recursive: 'bool')", "properties": { "path": { "type": "string" }, "recursive": { "type": "boolean" } }, "required": [ "path", "recursive" ], "type": "object" }, "cee.WorkspaceFsRenameRequest": { "description": "WorkspaceFsRenameRequest(old_path: 'str', new_path: 'str', overwrite: 'bool')", "properties": { "newPath": { "type": "string" }, "oldPath": { "type": "string" }, "overwrite": { "type": "boolean" } }, "required": [ "oldPath", "newPath", "overwrite" ], "type": "object" } } }, "tags": [ { "name": "Notebook sessions" }, { "name": "Secrets" }, { "name": "Datasource credentials" }, { "name": "Datasource metadata" }, { "name": "Notebook documents" }, { "name": "Runs" }, { "name": "Execution environments" }, { "name": "Identity and sessions" }, { "name": "Workspaces" }, { "name": "Changesets" }, { "name": "Workspace files" }, { "name": "Code execution" }, { "name": "Git context" }, { "name": "Environment files" } ] }