diff --git a/bun.lock b/bun.lock index 4246f95a..028448b9 100644 --- a/bun.lock +++ b/bun.lock @@ -1,5 +1,6 @@ { "lockfileVersion": 1, + "configVersion": 0, "workspaces": { "": { "name": "sf-cli", @@ -8,7 +9,7 @@ "@formatjs/intl-segmenter": "^12.1.0", "@inkjs/ui": "^1.0.0", "@inquirer/prompts": "^8.2.0", - "@sfcompute/nodes-sdk-alpha": "0.1.0-alpha.27", + "@sfcompute/nodes-sdk-alpha": "0.1.0-alpha.31", "@types/ms": "^0.7.34", "async-retry": "^1.3.3", "axios": "^1.8.4", @@ -258,7 +259,7 @@ "@rollup/rollup-win32-x64-msvc": ["@rollup/rollup-win32-x64-msvc@4.55.2", "", { "os": "win32", "cpu": "x64" }, "sha512-xNO+fksQhsAckRtDSPWaMeT1uIM+JrDRXlerpnWNXhn1TdB3YZ6uKBMBTKP0eX9XtYEP978hHk1f8332i2AW8Q=="], - "@sfcompute/nodes-sdk-alpha": ["@sfcompute/nodes-sdk-alpha@0.1.0-alpha.27", "", {}, "sha512-IcnuTpfZszCLpBtEOFCas0fhc0yAgCvGZ8JvN9DdM1zWMUswHyuumYKDEVt6ZUXjJVnMt09Uhqh2sWHOEer+rQ=="], + "@sfcompute/nodes-sdk-alpha": ["@sfcompute/nodes-sdk-alpha@0.1.0-alpha.31", "", {}, "sha512-pdomgDeEvMQjo/F+GlmgMdN1l9eyICi8tlQlDLQ3xTIQ2D/++RK/WH2q153/xofOnwl/56P0IFYk9xl1Z7qx8w=="], "@types/async-retry": ["@types/async-retry@1.4.9", "", { "dependencies": { "@types/retry": "*" } }, "sha512-s1ciZQJzRh3708X/m3vPExr5KJlzlZJvXsKpbtE2luqNcbROr64qU+3KpJsYHqWMeaxI839OvXf9PrUSw1Xtyg=="], diff --git a/package.json b/package.json index 20375bde..bcb8119f 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,7 @@ "@formatjs/intl-segmenter": "^12.1.0", "@inkjs/ui": "^1.0.0", "@inquirer/prompts": "^8.2.0", - "@sfcompute/nodes-sdk-alpha": "0.1.0-alpha.27", + "@sfcompute/nodes-sdk-alpha": "0.1.0-alpha.31", "@types/ms": "^0.7.34", "async-retry": "^1.3.3", "axios": "^1.8.4", diff --git a/src/index.ts b/src/index.ts index dec9f514..a33d266a 100644 --- a/src/index.ts +++ b/src/index.ts @@ -89,7 +89,7 @@ async function main() { if (!exchangeAccountId) { const client = await apiClient(config.auth_token); - const { data } = await client.GET("/v0/me"); + const { data } = await client.GET("/v1/account/me", {}); if (data?.id) { exchangeAccountId = data.id; saveConfig({ ...config, account_id: data.id }); diff --git a/src/lib/contracts/index.tsx b/src/lib/contracts/index.tsx index 11d62b68..e2fc7e09 100644 --- a/src/lib/contracts/index.tsx +++ b/src/lib/contracts/index.tsx @@ -78,7 +78,7 @@ async function listContracts( if (!response.ok) { switch (response.status) { case 400: - return logAndQuit(`Bad Request: ${error?.message}`); + return logAndQuit(`Bad Request: ${error?.error?.message}`); case 401: return await logSessionTokenExpiredAndQuit(); default: diff --git a/src/lib/images/get.tsx b/src/lib/images/get.tsx index 854981a2..e4bb876b 100644 --- a/src/lib/images/get.tsx +++ b/src/lib/images/get.tsx @@ -10,27 +10,24 @@ import Link from "ink-link"; import { apiClient } from "../../apiClient.ts"; import { logAndQuit } from "../../helpers/errors.ts"; import { formatDate } from "../../helpers/format-time.ts"; +import type { components } from "../../schema.ts"; import { Row } from "../Row.tsx"; dayjs.extend(utc); dayjs.extend(advanced); dayjs.extend(timezone); +type Image = components["schemas"]["sfc-api_ImageListEntry"]; +type Download = components["schemas"]["sfc-api_ImageDownloadResponse"]; + function ImageDisplay({ image, download, }: { - image: { - name: string; - id: string; - upload_status: string; - sha256_hash: string | null; - }; - download: { url: string; expires_at: number } | null; + image: Image; + download: Download | null; }) { - const expiresAt = download?.expires_at - ? new Date(download.expires_at * 1000) - : null; + const expiresAt = download ? new Date(download.expires_at * 1000) : null; const isExpired = expiresAt ? expiresAt < new Date() : false; return ( @@ -43,7 +40,7 @@ function ImageDisplay({ - {image.sha256_hash && } + {image.sha256 && } {download && ( <> Completed; case "failed": return Failed; + case "revoked": + return Revoked; default: return Unknown; } } -const get = new Command("get") - .description("Get image details and download URL") - .argument("", "Image ID or name") - .option("--json", "Output JSON") - .action(async (id, opts) => { - const client = await apiClient(); +export function createGet() { + return new Command("get") + .alias("show") + .description("Get image details and download URL") + .argument("", "Image ID or name") + .option("--json", "Output JSON") + .action(async (id, opts) => { + const client = await apiClient(); - const { data: image, response } = await client.GET("/v2/images/{id}", { - params: { path: { id } }, - }); - if (!response.ok || !image) { - logAndQuit( - `Failed to get image: ${response.status} ${response.statusText}`, + const { data: image, response } = await client.GET( + "/preview/v2/images/{id}", + { params: { path: { id } } }, ); - } - - // Fetch download URL if image is completed - let download = null; - if (image.upload_status === "completed") { - const { data: downloadData, response: downloadResponse } = - await client.GET("/v2/images/{id}/download", { - params: { path: { id } }, - }); - if (downloadResponse.ok && downloadData) { - download = downloadData; + if (!response.ok || !image) { + logAndQuit( + `Failed to get image: ${response.status} ${response.statusText}`, + ); } - } - if (opts.json) { - console.log(JSON.stringify({ ...image, download }, null, 2)); - return; - } + let download: Download | null = null; + if (image.upload_status === "completed") { + const { data: downloadData } = await client.GET( + "/preview/v2/images/{id}/download", + { params: { path: { id } } }, + ); + if (downloadData) { + download = downloadData; + } + } - render( - , - ); - }); + if (opts.json) { + console.log(JSON.stringify({ ...image, download }, null, 2)); + return; + } -export default get; + render(); + }); +} diff --git a/src/lib/images/index.ts b/src/lib/images/index.ts index e845f79e..0517c037 100644 --- a/src/lib/images/index.ts +++ b/src/lib/images/index.ts @@ -1,12 +1,12 @@ -import type { Command } from "@commander-js/extra-typings"; -import get from "./get.tsx"; -import list from "./list.ts"; -import upload from "./upload.ts"; +import { Command } from "@commander-js/extra-typings"; +import { createGet } from "./get.tsx"; +import { createList } from "./list.ts"; +import { createUpload } from "./upload.ts"; -export function registerImages(program: Command) { - const images = program - .command("images") +export function createImagesCommand() { + const images = new Command("images") .alias("image") + .alias("os") .description("Manage images") .showHelpAfterError() .addHelpText( @@ -23,10 +23,15 @@ Examples:\n $ sf images get `, ) - .addCommand(list) - .addCommand(upload) - .addCommand(get) + .addCommand(createList()) + .addCommand(createUpload()) + .addCommand(createGet()) .action(() => { images.help(); }); + return images; +} + +export function registerImages(program: Command) { + program.addCommand(createImagesCommand()); } diff --git a/src/lib/images/list.ts b/src/lib/images/list.ts index c6c2113d..0189d61a 100644 --- a/src/lib/images/list.ts +++ b/src/lib/images/list.ts @@ -8,14 +8,15 @@ import { logAndQuit } from "../../helpers/errors.ts"; import { formatDate } from "../../helpers/format-time.ts"; import { getDefaultWorkspace } from "./utils.ts"; -const list = new Command("list") - .alias("ls") - .description("List images") - .showHelpAfterError() - .option("--json", "Output in JSON format") - .addHelpText( - "after", - ` +export function createList() { + return new Command("list") + .alias("ls") + .description("List images") + .showHelpAfterError() + .option("--json", "Output in JSON format") + .addHelpText( + "after", + ` Examples:\n \x1b[2m# List all images\x1b[0m $ sf images list @@ -26,87 +27,96 @@ Examples:\n \x1b[2m# List images in JSON format\x1b[0m $ sf images list --json `, - ) - .action(async (options) => { - const client = await apiClient(); - const workspace = await getDefaultWorkspace(); - - const spinner = ora("Fetching images...").start(); - const { data: result, response } = await client.GET("/v2/images", { - params: { query: { workspace } }, - }); - spinner.stop(); - - if (!response.ok || !result) { - logAndQuit( - `Failed to list images: ${response.status} ${response.statusText}`, + ) + .action(async (options) => { + const client = await apiClient(); + const workspace = await getDefaultWorkspace(); + + const spinner = ora("Fetching images...").start(); + const { data, response } = await client.GET("/preview/v2/images", { + params: { query: { workspace } }, + }); + spinner.stop(); + + if (!response.ok || !data) { + logAndQuit( + `Failed to list images: ${response.status} ${response.statusText}`, + ); + } + + if (options.json) { + console.log(JSON.stringify(data, null, 2)); + return; + } + + const images = data.data; + + if (images.length === 0) { + console.log("No images found."); + console.log(chalk.gray("\nUpload your first image:")); + console.log(" sf images upload -f ./my-image.img -n my-image"); + return; + } + + const sortedImages = [...images].sort( + (a, b) => (b.created_at || 0) - (a.created_at || 0), ); - } - - if (options.json) { - console.log(JSON.stringify(result, null, 2)); - return; - } - - const images = result.data; - - if (images.length === 0) { - console.log("No images found."); - console.log(chalk.gray("\nUpload your first image:")); - console.log(" sf images upload -f ./my-image.img -n my-image"); - return; - } - - // Sort images by created_at (newest first) - const sortedImages = [...images].sort((a, b) => { - return (b.created_at || 0) - (a.created_at || 0); - }); - const imagesToShow = sortedImages.slice(0, 5); - - const table = new Table({ - head: [ - chalk.cyan("NAME"), - chalk.cyan("ID"), - chalk.cyan("STATUS"), - chalk.cyan("CREATED"), - ], - style: { - head: [], - border: ["gray"], - }, + const imagesToShow = sortedImages.slice(0, 5); + + const table = new Table({ + head: [ + chalk.cyan("NAME"), + chalk.cyan("ID"), + chalk.cyan("STATUS"), + chalk.cyan("CREATED"), + ], + style: { head: [], border: ["gray"] }, + }); + + for (const image of imagesToShow) { + const createdAt = image.created_at + ? formatDate(new Date(image.created_at * 1000)) + : "Unknown"; + table.push([ + image.name, + image.id, + formatStatus(image.upload_status), + createdAt, + ]); + } + + if (images.length > 5) { + table.push([ + { + colSpan: 4, + content: chalk.blackBright( + `${images.length - 5} older ${ + images.length - 5 === 1 ? "image" : "images" + } not shown. Use sf images list --json to list all images.`, + ), + }, + ]); + } + + console.log(table.toString()); + + console.log(chalk.gray("\nNext steps:")); + const firstImage = sortedImages[0]; + if (firstImage) { + console.log(` sf images get ${chalk.cyan(firstImage.id)}`); + } + const firstCompletedImage = sortedImages.find( + (image) => image.upload_status === "completed", + ); + if (firstCompletedImage) { + console.log( + ` sf nodes create -z hayesvalley -d 2h -p 13.50 --image ${chalk.cyan( + firstCompletedImage.id, + )}`, + ); + } }); - - for (const image of imagesToShow) { - const createdAt = image.created_at - ? formatDate(new Date(image.created_at * 1000)) - : "Unknown"; - - const status = formatStatus(image.upload_status); - - table.push([image.name, image.id, status, createdAt]); - } - - if (images.length > 5) { - table.push([ - { - colSpan: 4, - content: chalk.blackBright( - `${images.length - 5} older ${ - images.length - 5 === 1 ? "image" : "images" - } not shown. Use sf images list --json to list all images.`, - ), - }, - ]); - } - - console.log(table.toString()); - - console.log(chalk.gray("\nNext steps:")); - const firstImage = sortedImages[0]; - if (firstImage) { - console.log(` sf images get ${chalk.cyan(firstImage.id)}`); - } - }); +} function formatStatus(status: string): string { switch (status) { @@ -118,9 +128,9 @@ function formatStatus(status: string): string { return chalk.cyan("Completed"); case "failed": return chalk.red("Failed"); + case "revoked": + return chalk.red("Revoked"); default: return chalk.gray("Unknown"); } } - -export default list; diff --git a/src/lib/images/upload.ts b/src/lib/images/upload.ts index 36f17e26..4e5be067 100644 --- a/src/lib/images/upload.ts +++ b/src/lib/images/upload.ts @@ -10,7 +10,7 @@ import chalk from "chalk"; import cliProgress from "cli-progress"; import cliSpinners from "cli-spinners"; import ora, { type Ora } from "ora"; -import { getAuthToken, loadConfig } from "../../helpers/config.ts"; +import { apiClient } from "../../apiClient.ts"; import { logAndQuit } from "../../helpers/errors.ts"; import { getDefaultWorkspace } from "./utils.ts"; @@ -53,378 +53,355 @@ async function readChunk( } } -const upload = new Command("upload") - .description("Upload an image file (multipart)") - .requiredOption("-f, --file ", "Path to the image file") - .requiredOption("-n, --name ", "Image name") - .option( - "-c, --concurrency ", - "Number of parts to upload concurrently", - (value) => { - const parsed = Number.parseInt(value, 10); - if (Number.isNaN(parsed) || parsed < 1) { - throw new Error("Concurrency must be a positive integer"); - } - return parsed; - }, - 1, - ) - .action(async ({ name, file: filePath, concurrency: concurrencyLimit }) => { - let preparingSpinner: Ora | undefined; - let finalizingSpinner: Ora | undefined; - let spinnerTimer: NodeJS.Timeout | undefined; - let progressBar: cliProgress.SingleBar | undefined; - - try { - const config = await loadConfig(); - const token = await getAuthToken(); - const apiHeaders = { - Authorization: `Bearer ${token}`, - "Content-Type": "application/json", - }; - - preparingSpinner = ora(`Preparing upload for ${name}...`).start(); - - const workspace = await getDefaultWorkspace(); - - // Create image via v2 API - const startResponse = await fetch(`${config.api_url}/v2/images`, { - method: "POST", - headers: apiHeaders, - body: JSON.stringify({ name, workspace }), - }); - - if (!startResponse.ok) { - throw new Error( - `Failed to start upload: ${startResponse.status} ${startResponse.statusText}`, - ); - } +export function createUpload() { + return new Command("upload") + .description("Upload an image file (multipart)") + .requiredOption("-f, --file ", "Path to the image file") + .requiredOption("-n, --name ", "Image name") + .option( + "-c, --concurrency ", + "Number of parts to upload concurrently", + (value) => { + const parsed = Number.parseInt(value, 10); + if (Number.isNaN(parsed) || parsed < 1) { + throw new Error("Concurrency must be a positive integer"); + } + return parsed; + }, + 1, + ) + .action(async ({ name, file: filePath, concurrency: concurrencyLimit }) => { + let preparingSpinner: Ora | undefined; + let finalizingSpinner: Ora | undefined; + let spinnerTimer: NodeJS.Timeout | undefined; + let progressBar: cliProgress.SingleBar | undefined; - const startData: { object: "image"; id: string; upload_status: string } = - await startResponse.json(); - const imageId = startData.id; + try { + const client = await apiClient(); - preparingSpinner.succeed( - `Started upload for image ${chalk.cyan(name)} (${chalk.blackBright( - imageId, - )})`, - ); + preparingSpinner = ora(`Preparing upload for ${name}...`).start(); + + const workspace = await getDefaultWorkspace(); - // Get file info - const fileInfo = await stat(filePath); - const fileSize = fileInfo.size; - - // Check file size limit (128 GiB) - const maxFileSize = 128 * 1024 * 1024 * 1024; - if (fileSize > maxFileSize) { - logAndQuit( - `File size exceeds maximum allowed size of 128 GiB. File size: ${( - fileSize / (1024 * 1024 * 1024) - ).toFixed(2)} GiB`, + const { data: startData, response: startResponse } = await client.POST( + "/preview/v2/images", + { body: { name, workspace } }, ); - } - // Calculate parts - const minChunk = 5 * 1024 * 1024; // 5 MiB - const defaultChunk = 64 * 1024 * 1024; // 64 MiB - const maxParts = 10000; - - const chunkSize = - fileSize <= defaultChunk - ? Math.max(fileSize, minChunk) - : Math.max(minChunk, Math.ceil(fileSize / maxParts), defaultChunk); - - const totalParts = Math.ceil(fileSize / chunkSize); - - const uploadParts: Array<{ - part: number; - start: number; - end: number; - }> = []; - - for (let idx = 0; idx < totalParts; idx++) { - const part = idx + 1; - const start = idx * chunkSize; - const end = Math.min(start + chunkSize, fileSize); - uploadParts.push({ part, start, end }); - } + if (!startResponse.ok || !startData) { + throw new Error( + `Failed to start upload: ${startResponse.status} ${startResponse.statusText}`, + ); + } + + const imageId = startData.id; - // Progress tracking - const startTime = Date.now(); - const partProgress = new Map(); + preparingSpinner.succeed( + `Started upload for image ${chalk.cyan(name)} (${chalk.blackBright( + imageId, + )})`, + ); - const getTotalBytesUploaded = () => { - let total = 0; - for (const bytes of partProgress.values()) { - total += bytes; + // Get file info + const fileInfo = await stat(filePath); + const fileSize = fileInfo.size; + + // Check file size limit (128 GiB) + const maxFileSize = 128 * 1024 * 1024 * 1024; + if (fileSize > maxFileSize) { + logAndQuit( + `File size exceeds maximum allowed size of 128 GiB. File size: ${( + fileSize / (1024 * 1024 * 1024) + ).toFixed(2)} GiB`, + ); } - return total; - }; - - const spinner = cliSpinners.dots; - let spinnerIndex = 0; - - progressBar = new cliProgress.SingleBar({ - format: - "{spinner} Uploading [{bar}] {percentage}% | {uploadedMB}/{totalMB} MB | {speed}", - barCompleteChar: "\u2588", - barIncompleteChar: "\u2591", - hideCursor: true, - forceRedraw: false, - }); - - progressBar.start(fileSize, 0, { - spinner: spinner.frames[0], - speed: "0 B/s", - uploadedMB: "0.0", - totalMB: (fileSize / (1024 * 1024)).toFixed(1), - }); - - const UI_UPDATE_INTERVAL_MS = 200; - let lastUIUpdate = 0; - - const renderProgress = () => { - const totalBytesUploaded = getTotalBytesUploaded(); - const elapsedTime = (Date.now() - startTime) / 1000; - const speed = totalBytesUploaded / elapsedTime; - - let speedStr: string; - if (speed > 1024 * 1024) { - speedStr = `${(speed / (1024 * 1024)).toFixed(1)} MB/s`; - } else if (speed > 1024) { - speedStr = `${(speed / 1024).toFixed(1)} KB/s`; - } else { - speedStr = `${speed.toFixed(0)} B/s`; + + // Calculate parts + const minChunk = 5 * 1024 * 1024; // 5 MiB + const defaultChunk = 64 * 1024 * 1024; // 64 MiB + const maxParts = 10000; + + const chunkSize = + fileSize <= defaultChunk + ? Math.max(fileSize, minChunk) + : Math.max(minChunk, Math.ceil(fileSize / maxParts), defaultChunk); + + const totalParts = Math.ceil(fileSize / chunkSize); + + const uploadParts: Array<{ + part: number; + start: number; + end: number; + }> = []; + + for (let idx = 0; idx < totalParts; idx++) { + const part = idx + 1; + const start = idx * chunkSize; + const end = Math.min(start + chunkSize, fileSize); + uploadParts.push({ part, start, end }); } - progressBar?.update(totalBytesUploaded, { - spinner: spinner.frames[spinnerIndex % spinner.frames.length], - speed: speedStr, - uploadedMB: (totalBytesUploaded / (1024 * 1024)).toFixed(1), + // Progress tracking + const startTime = Date.now(); + const partProgress = new Map(); + + const getTotalBytesUploaded = () => { + let total = 0; + for (const bytes of partProgress.values()) { + total += bytes; + } + return total; + }; + + const spinner = cliSpinners.dots; + let spinnerIndex = 0; + + progressBar = new cliProgress.SingleBar({ + format: + "{spinner} Uploading [{bar}] {percentage}% | {uploadedMB}/{totalMB} MB | {speed}", + barCompleteChar: "\u2588", + barIncompleteChar: "\u2591", + hideCursor: true, + forceRedraw: false, + }); + + progressBar.start(fileSize, 0, { + spinner: spinner.frames[0], + speed: "0 B/s", + uploadedMB: "0.0", totalMB: (fileSize / (1024 * 1024)).toFixed(1), }); - }; - - spinnerTimer = setInterval(() => { - spinnerIndex++; - const now = Date.now(); - if (now - lastUIUpdate >= UI_UPDATE_INTERVAL_MS) { - renderProgress(); - lastUIUpdate = now; - } - }, spinner.interval); - - const updateProgress = (part: number, bytesUploaded: number) => { - const previousBytes = partProgress.get(part) || 0; - partProgress.set(part, previousBytes + bytesUploaded); - }; - - const resetPartProgress = (part: number) => { - partProgress.set(part, 0); - }; - - // Upload parts - const uploadPart = async ({ - part, - start, - end, - }: { - part: number; - start: number; - end: number; - }) => { - const partSize = end - start; - - await retry( - async (bail: (e: Error) => void, attemptNumber: number) => { - if (attemptNumber > 1) { - resetPartProgress(part); - } - // Get presigned URL via v2 API - const partResponse = await fetch( - `${config.api_url}/v2/images/${imageId}/parts`, - { - method: "POST", - headers: apiHeaders, - body: JSON.stringify({ part_id: part }), - }, - ); + const UI_UPDATE_INTERVAL_MS = 200; + let lastUIUpdate = 0; + + const renderProgress = () => { + const totalBytesUploaded = getTotalBytesUploaded(); + const elapsedTime = (Date.now() - startTime) / 1000; + const speed = totalBytesUploaded / elapsedTime; + + let speedStr: string; + if (speed > 1024 * 1024) { + speedStr = `${(speed / (1024 * 1024)).toFixed(1)} MB/s`; + } else if (speed > 1024) { + speedStr = `${(speed / 1024).toFixed(1)} KB/s`; + } else { + speedStr = `${speed.toFixed(0)} B/s`; + } - if (!partResponse.ok) { - const status = partResponse.status; - - if ( - status >= 400 && - status < 500 && - status !== 408 && - status !== 429 - ) { - bail( - new Error( - `Failed to get upload URL for part ${part}: ${status} ${partResponse.statusText}`, - ), - ); - return; + progressBar?.update(totalBytesUploaded, { + spinner: spinner.frames[spinnerIndex % spinner.frames.length], + speed: speedStr, + uploadedMB: (totalBytesUploaded / (1024 * 1024)).toFixed(1), + totalMB: (fileSize / (1024 * 1024)).toFixed(1), + }); + }; + + spinnerTimer = setInterval(() => { + spinnerIndex++; + const now = Date.now(); + if (now - lastUIUpdate >= UI_UPDATE_INTERVAL_MS) { + renderProgress(); + lastUIUpdate = now; + } + }, spinner.interval); + + const updateProgress = (part: number, bytesUploaded: number) => { + const previousBytes = partProgress.get(part) || 0; + partProgress.set(part, previousBytes + bytesUploaded); + }; + + const resetPartProgress = (part: number) => { + partProgress.set(part, 0); + }; + + // Upload parts + const uploadPart = async ({ + part, + start, + end, + }: { + part: number; + start: number; + end: number; + }) => { + const partSize = end - start; + + await retry( + async (bail: (e: Error) => void, attemptNumber: number) => { + if (attemptNumber > 1) { + resetPartProgress(part); } - throw new Error( - `Failed to get upload URL for part ${part}: ${status} ${partResponse.statusText}`, - ); - } - - const partData: { url: string; expires_at: string } = - await partResponse.json(); - const url = partData.url; - - // Read chunk from disk with progress tracking - const payload = await readChunk( - filePath, - start, - partSize, - (bytesRead) => { - updateProgress(part, bytesRead); - }, - ); - - const res = await fetch(url, { - method: "PUT", - headers: { - "Content-Type": "application/octet-stream", - }, - body: payload as BodyInit, - }); - - if (!res.ok) { - if ( - res.status >= 400 && - res.status < 500 && - res.status !== 408 && - res.status !== 429 - ) { - bail( - new Error( - `Part ${part} upload failed: ${res.status} ${res.statusText}`, - ), + const { data: partData, response: partResponse } = + await client.POST("/preview/v2/images/{id}/parts", { + params: { path: { id: imageId } }, + body: { part_id: part }, + }); + + if (!partResponse.ok || !partData) { + const status = partResponse.status; + + if ( + status >= 400 && + status < 500 && + status !== 408 && + status !== 429 + ) { + bail( + new Error( + `Failed to get upload URL for part ${part}: ${status} ${partResponse.statusText}`, + ), + ); + return; + } + + throw new Error( + `Failed to get upload URL for part ${part}: ${status} ${partResponse.statusText}`, ); - return; } - throw new Error( - `Part ${part} upload failed: ${res.status} ${res.statusText}`, + const url = partData.url; + + // Read chunk from disk with progress tracking + const payload = await readChunk( + filePath, + start, + partSize, + (bytesRead) => { + updateProgress(part, bytesRead); + }, ); - } - }, - { - retries: 5, - factor: 2, - randomize: true, - }, - ); - return part; - }; + const res = await fetch(url, { + method: "PUT", + headers: { + "Content-Type": "application/octet-stream", + }, + body: payload as BodyInit, + }); + + if (!res.ok) { + if ( + res.status >= 400 && + res.status < 500 && + res.status !== 408 && + res.status !== 429 + ) { + bail( + new Error( + `Part ${part} upload failed: ${res.status} ${res.statusText}`, + ), + ); + return; + } + + throw new Error( + `Part ${part} upload failed: ${res.status} ${res.statusText}`, + ); + } + }, + { + retries: 5, + factor: 2, + randomize: true, + }, + ); + + return part; + }; + + // Process uploads with concurrency limit + const results: number[] = []; + try { + for (let i = 0; i < uploadParts.length; i += concurrencyLimit) { + const batch = uploadParts.slice(i, i + concurrencyLimit); + const batchResults = await Promise.allSettled( + batch.map(uploadPart), + ); - // Process uploads with concurrency limit - const results: number[] = []; - try { - for (let i = 0; i < uploadParts.length; i += concurrencyLimit) { - const batch = uploadParts.slice(i, i + concurrencyLimit); - const batchResults = await Promise.allSettled(batch.map(uploadPart)); - - for (const result of batchResults) { - if (result.status === "fulfilled") { - results.push(result.value); - } else { - throw new Error(`Upload failed: ${result.reason}`); + for (const result of batchResults) { + if (result.status === "fulfilled") { + results.push(result.value); + } else { + throw new Error(`Upload failed: ${result.reason}`); + } } } + } finally { + if (spinnerTimer) { + clearInterval(spinnerTimer); + spinnerTimer = undefined; + } } - } finally { - if (spinnerTimer) { - clearInterval(spinnerTimer); - spinnerTimer = undefined; - } - } - progressBar.update(fileSize, { - spinner: chalk.green("\u2714"), - speed: "0 B/s", - uploadedMB: (fileSize / (1024 * 1024)).toFixed(1), - totalMB: (fileSize / (1024 * 1024)).toFixed(1), - }); - progressBar.stop(); - - finalizingSpinner = ora("Validating upload...").start(); - - // Calculate SHA256 hash - const hash = crypto.createHash("sha256"); - const fileStream = fs.createReadStream(filePath); - for await (const chunk of fileStream) { - hash.update(chunk); - } + progressBar.update(fileSize, { + spinner: chalk.green("\u2714"), + speed: "0 B/s", + uploadedMB: (fileSize / (1024 * 1024)).toFixed(1), + totalMB: (fileSize / (1024 * 1024)).toFixed(1), + }); + progressBar.stop(); - const sha256Hash = hash.digest("hex"); + finalizingSpinner = ora("Validating upload...").start(); - // Complete upload via v2 API - const completeResponse = await fetch( - `${config.api_url}/v2/images/${imageId}/complete`, - { - method: "POST", - headers: apiHeaders, - body: JSON.stringify({ sha256: sha256Hash }), - }, - ); + // Calculate SHA256 hash + const hash = crypto.createHash("sha256"); + const fileStream = fs.createReadStream(filePath); + for await (const chunk of fileStream) { + hash.update(chunk); + } - if (!completeResponse.ok) { - throw new Error( - `Failed to complete upload: ${completeResponse.status} ${completeResponse.statusText}`, - ); - } + const sha256Hash = hash.digest("hex"); + + const { data: completeData, response: completeResponse } = + await client.POST("/preview/v2/images/{id}/complete", { + params: { path: { id: imageId } }, + body: { sha256: sha256Hash }, + }); - const completeData: { - object: "image"; - upload_status: string; - id: string; - } = await completeResponse.json(); + if (!completeResponse.ok || !completeData) { + throw new Error( + `Failed to complete upload: ${completeResponse.status} ${completeResponse.statusText}`, + ); + } - finalizingSpinner.succeed("Image uploaded and verified"); + finalizingSpinner.succeed("Image uploaded and verified"); - console.log(chalk.gray("\nNext steps:")); - console.log(` sf images get ${chalk.cyan(completeData.id)}`); - } catch (err) { - if (spinnerTimer) { - clearInterval(spinnerTimer); - spinnerTimer = undefined; - } + console.log(chalk.gray("\nNext steps:")); + console.log(` sf images get ${chalk.cyan(completeData.id)}`); + } catch (err) { + if (spinnerTimer) { + clearInterval(spinnerTimer); + spinnerTimer = undefined; + } - try { - progressBar?.stop(); - } catch { - // Ignore if progress bar not started - } + try { + progressBar?.stop(); + } catch { + // Ignore if progress bar not started + } - if (preparingSpinner?.isSpinning) { - preparingSpinner.fail( - `Upload preparation failed: ${ - err instanceof Error ? err.message : String(err) - }`, - ); - } else if (finalizingSpinner?.isSpinning) { - finalizingSpinner.fail( - `Failed to finalize upload: ${ - err instanceof Error ? err.message : String(err) - }`, - ); - } else { - console.error( - `\n${chalk.red("\u2717")} ${ - err instanceof Error ? err.message : String(err) - }`, - ); + if (preparingSpinner?.isSpinning) { + preparingSpinner.fail( + `Upload preparation failed: ${ + err instanceof Error ? err.message : String(err) + }`, + ); + } else if (finalizingSpinner?.isSpinning) { + finalizingSpinner.fail( + `Failed to finalize upload: ${ + err instanceof Error ? err.message : String(err) + }`, + ); + } else { + console.error( + `\n${chalk.red("\u2717")} ${ + err instanceof Error ? err.message : String(err) + }`, + ); + } + process.exit(1); } - process.exit(1); - } - }); - -export default upload; + }); +} diff --git a/src/lib/images/utils.ts b/src/lib/images/utils.ts index a43076a1..60461667 100644 --- a/src/lib/images/utils.ts +++ b/src/lib/images/utils.ts @@ -6,7 +6,7 @@ export async function getDefaultWorkspace(): Promise { let accountId = config.account_id; if (!accountId) { const client = await apiClient(); - const { data } = await client.GET("/v0/me"); + const { data } = await client.GET("/v1/account/me", {}); if (data?.id) { await saveConfig({ ...config, account_id: data.id }); accountId = data.id; diff --git a/src/lib/nodes/image/index.ts b/src/lib/nodes/image/index.ts deleted file mode 100644 index 6f79ab22..00000000 --- a/src/lib/nodes/image/index.ts +++ /dev/null @@ -1,32 +0,0 @@ -import { Command } from "@commander-js/extra-typings"; -import list from "./list.tsx"; -import show from "./show.tsx"; -import upload from "./upload.ts"; - -const image = new Command("images") - .alias("os") - .alias("image") - .description("Manage VM images") - .showHelpAfterError() - .addHelpText( - "after", - ` -Examples:\n - \x1b[2m# Upload an image file\x1b[0m - $ sf node image upload ./my-image.img - - \x1b[2m# List all images\x1b[0m - $ sf node image list - - \x1b[2m# Show image details and download URL\x1b[0m - $ sf node image show -`, - ) - .addCommand(list) - .addCommand(upload) - .addCommand(show) - .action(() => { - image.help(); - }); - -export default image; diff --git a/src/lib/nodes/image/list.tsx b/src/lib/nodes/image/list.tsx deleted file mode 100644 index 5de72c41..00000000 --- a/src/lib/nodes/image/list.tsx +++ /dev/null @@ -1,138 +0,0 @@ -import console from "node:console"; -import { Command } from "@commander-js/extra-typings"; -import chalk from "chalk"; -import Table from "cli-table3"; -import ora from "ora"; - -import { getAuthToken } from "../../../helpers/config.ts"; -import { logAndQuit } from "../../../helpers/errors.ts"; -import { formatDate } from "../../../helpers/format-time.ts"; -import { handleNodesError, nodesClient } from "../../../nodesClient.ts"; - -const list = new Command("list") - .alias("ls") - .description("List all VM images") - .showHelpAfterError() - .option("--json", "Output in JSON format") - .addHelpText( - "after", - ` -Next Steps:\n - \x1b[2m# List all images\x1b[0m - $ sf node images list - - \x1b[2m# Get detailed info for a specific image\x1b[0m - $ sf node images show - - \x1b[2m# List images in JSON format\x1b[0m - $ sf node images list --json -`, - ) - .action(async (options) => { - try { - const token = await getAuthToken(); - if (!token) { - logAndQuit("Not logged in. Please run 'sf login' first."); - } - const client = await nodesClient(token); - - const spinner = ora("Fetching images...").start(); - const { data: images } = await client.vms.images.list(); - - spinner.stop(); - - if (options.json) { - console.log(JSON.stringify(images, null, 2)); - return; - } - - if (images.length === 0) { - console.log("No images found."); - console.log(chalk.gray("\nUpload your first image:")); - console.log(" sf node images upload -f ./my-image.img -n my-image"); - return; - } - - // Sort images by created_at (newest first) - const sortedImages = [...images].sort((a, b) => { - const aTime = a.created_at || 0; - const bTime = b.created_at || 0; - return bTime - aTime; - }); - const imagesToShow = sortedImages.slice(0, 5); - - // Create and display images table - const table = new Table({ - head: [ - chalk.cyan("NAME"), - chalk.cyan("ID"), - chalk.cyan("STATUS"), - chalk.cyan("CREATED"), - ], - style: { - head: [], - border: ["gray"], - }, - }); - - for (const image of imagesToShow) { - const createdAt = image.created_at - ? formatDate(new Date(image.created_at * 1000)) - : "Unknown"; - - const status = (() => { - switch (image.upload_status) { - case "started": - return chalk.green("Started"); - case "uploading": - return chalk.yellow("Uploading"); - case "completed": - return chalk.cyan("Completed"); - case "failed": - return chalk.red("Failed"); - default: - return chalk.gray("Unknown"); - } - })(); - - table.push([image.name, image.image_id, status, createdAt]); - } - if (images.length > 5) { - table.push([ - { - colSpan: 4, - content: chalk.blackBright( - `${images.length - 5} older ${ - images.length - 5 === 1 ? "image" : "images" - } not shown. Use sf node images list --json to list all images.`, - ), - }, - ]); - } - - console.log(table.toString()); - - // Show next steps - console.log(chalk.gray("\nNext steps:")); - - // Always show how to get info for a specific image - const firstImage = sortedImages[0]; - if (firstImage) { - console.log(` sf node images show ${chalk.cyan(firstImage.image_id)}`); - } - const firstCompletedImage = sortedImages.find( - (image) => image.upload_status === "completed", - ); - if (firstCompletedImage) { - console.log( - ` sf nodes create -z hayesvalley -d 2h -p 13.50 --image ${chalk.cyan( - firstCompletedImage.image_id, - )}`, - ); - } - } catch (err) { - handleNodesError(err); - } - }); - -export default list; diff --git a/src/lib/nodes/image/show.tsx b/src/lib/nodes/image/show.tsx deleted file mode 100644 index 733e32e3..00000000 --- a/src/lib/nodes/image/show.tsx +++ /dev/null @@ -1,157 +0,0 @@ -import console from "node:console"; -import { Command } from "@commander-js/extra-typings"; -import chalk from "chalk"; -import dayjs from "dayjs"; -import advanced from "dayjs/plugin/advancedFormat"; -import timezone from "dayjs/plugin/timezone"; -import utc from "dayjs/plugin/utc"; -import { Box, render, Text } from "ink"; -import Link from "ink-link"; -import { apiClient } from "../../../apiClient.ts"; -import { logAndQuit } from "../../../helpers/errors.ts"; -import { formatDate } from "../../../helpers/format-time.ts"; -import { Row } from "../../Row.tsx"; - -dayjs.extend(utc); -dayjs.extend(advanced); -dayjs.extend(timezone); - -export function ImageDisplay({ - image, - download, -}: { - image: { - name: string; - id: string; - upload_status: string; - }; - download: { url: string; expires_at: number } | null; -}) { - const expiresAt = download?.expires_at - ? new Date(download.expires_at * 1000) - : null; - const isExpired = expiresAt ? expiresAt < new Date() : false; - - return ( - - - - Image: {image.name} ({image.id}) - - - - - - - {formatStatusText(image.upload_status)} - - - } - /> - {download && ( - <> - - Use curl or wget to download. - - {download.url} - - - } - /> - {expiresAt && ( - - - {expiresAt.toISOString()}{" "} - {chalk.blackBright( - `(${formatDate(dayjs(expiresAt).toDate())} ${dayjs( - expiresAt, - ).format("z")})`, - )} - - {isExpired && (Expired)} - - } - /> - )} - - )} - - - ); -} - -function formatStatusColor(status: string): string { - switch (status) { - case "started": - return "green"; - case "uploading": - return "yellow"; - case "completed": - return "cyan"; - case "failed": - return "red"; - default: - return "gray"; - } -} - -function formatStatusText(status: string): string { - switch (status) { - case "started": - return "Started"; - case "uploading": - return "Uploading"; - case "completed": - return "Completed"; - case "failed": - return "Failed"; - default: - return "Unknown"; - } -} - -const show = new Command("show") - .description("Show VM image details and download URL") - .argument("", "ID of the image") - .option("--json", "Output JSON") - .action(async (imageId, opts) => { - const client = await apiClient(); - - const { data: image, response } = await client.GET("/v2/images/{id}", { - params: { path: { id: imageId } }, - }); - if (!response.ok || !image) { - logAndQuit( - `Failed to get image: ${response.status} ${response.statusText}`, - ); - } - - let download = null; - if (image.upload_status === "completed") { - const { data: downloadData, response: downloadResponse } = - await client.GET("/v2/images/{id}/download", { - params: { path: { id: imageId } }, - }); - if (downloadResponse.ok && downloadData) { - download = downloadData; - } - } - - if (opts.json) { - console.log(JSON.stringify({ ...image, download }, null, 2)); - return; - } - - render(); - }); - -export default show; diff --git a/src/lib/nodes/image/upload.ts b/src/lib/nodes/image/upload.ts deleted file mode 100644 index 90995640..00000000 --- a/src/lib/nodes/image/upload.ts +++ /dev/null @@ -1,441 +0,0 @@ -import console from "node:console"; -import crypto from "node:crypto"; -import fs from "node:fs"; -import { open, stat } from "node:fs/promises"; -import process from "node:process"; -import { clearInterval, setInterval } from "node:timers"; -import { Command } from "@commander-js/extra-typings"; -import retry from "async-retry"; -import chalk from "chalk"; -import cliProgress from "cli-progress"; -import cliSpinners from "cli-spinners"; -import ora, { type Ora } from "ora"; -import { apiClient } from "../../../apiClient.ts"; -import { logAndQuit } from "../../../helpers/errors.ts"; - -async function readChunk( - filePath: string, - start: number, - length: number, - onProgress?: (bytesRead: number) => void, -): Promise { - const fileHandle = await open(filePath, "r"); - try { - const buffer = new Uint8Array(length); - let offset = 0; - - while (offset < length) { - const { bytesRead } = await fileHandle.read( - buffer, - offset, - length - offset, - start + offset, - ); - if (bytesRead === 0) { - // EOF reached - break; - } - offset += bytesRead; - if (onProgress) { - onProgress(bytesRead); - } - } - - if (offset !== length) { - throw new Error( - `Short read: expected ${length} bytes, got ${offset} bytes`, - ); - } - - return buffer; - } finally { - await fileHandle.close(); - } -} - -const upload = new Command("upload") - .description("Upload a VM image file (multipart)") - .requiredOption("-f, --file ", "Path to the image file") - .requiredOption("-n, --name ", "Image name") - .option( - "-c, --concurrency ", - "Number of parts to upload concurrently", - (value) => { - const parsed = Number.parseInt(value, 10); - if (Number.isNaN(parsed) || parsed < 1) { - throw new Error("Concurrency must be a positive integer"); - } - return parsed; - }, - 1, - ) - .action(async ({ name, file: filePath, concurrency: concurrencyLimit }) => { - let preparingSpinner: Ora | undefined; - let finalizingSpinner: Ora | undefined; - let spinnerTimer: NodeJS.Timeout | undefined; - let progressBar: cliProgress.SingleBar | undefined; - - try { - preparingSpinner = ora(`Preparing upload for ${name}...`).start(); - const client = await apiClient(); - - // Start upload - const startResponse = await client.POST("/v1/vms/images/start_upload", { - body: { - name, - }, - }); - - if (!startResponse.data) { - throw new Error( - `Failed to start upload: ${startResponse.response.status} ${startResponse.response.statusText}`, - ); - } - - const imageId = startResponse.data.image_id; - preparingSpinner.succeed( - `Started upload for image ${chalk.cyan(name)} (${chalk.blackBright( - imageId, - )})`, - ); - - // Get file info and open as stream - const fileInfo = await stat(filePath); - const fileSize = fileInfo.size; - - // Check file size limit (128 GiB) - const maxFileSize = 128 * 1024 * 1024 * 1024; // 128 GiB in bytes - if (fileSize > maxFileSize) { - logAndQuit( - `File size exceeds maximum allowed size of 128 GiB. File size: ${( - fileSize / (1024 * 1024 * 1024) - ).toFixed(2)} GiB`, - ); - } - - // Calculate parts for progress tracking - const minChunk = 5 * 1024 * 1024; // 5 MiB (minimum) - const defaultChunk = 64 * 1024 * 1024; // 64 MiB - const maxParts = 10000; // object storage supports up to 10k parts - - // For files smaller than default chunk, use the whole file as one part - // Otherwise use default chunk size, but ensure we don't exceed maxParts - const chunkSize = - fileSize <= defaultChunk - ? Math.max(fileSize, minChunk) - : Math.max(minChunk, Math.ceil(fileSize / maxParts), defaultChunk); - - const totalParts = Math.ceil(fileSize / chunkSize); - - // Calculate upload parts metadata - const uploadParts: Array<{ - part: number; - start: number; - end: number; - }> = []; - - for (let idx = 0; idx < totalParts; idx++) { - const part = idx + 1; - const start = idx * chunkSize; - const end = Math.min(start + chunkSize, fileSize); - uploadParts.push({ part, start, end }); - } - - // Create combined ora + progress bar with per-part progress tracking - const startTime = Date.now(); - // Track progress per part to handle retries correctly - const partProgress = new Map(); // part -> bytes uploaded - - // Derive total bytes uploaded by summing all parts - const getTotalBytesUploaded = () => { - let total = 0; - for (const bytes of partProgress.values()) { - total += bytes; - } - return total; - }; - - // Use cli-spinners for consistent spinner frames and timing - const spinner = cliSpinners.dots; - let spinnerIndex = 0; - - progressBar = new cliProgress.SingleBar({ - format: - "{spinner} Uploading [{bar}] {percentage}% | {uploadedMB}/{totalMB} MB | {speed}", - barCompleteChar: "\u2588", - barIncompleteChar: "\u2591", - hideCursor: true, - forceRedraw: false, - }); - - progressBar.start(fileSize, 0, { - spinner: spinner.frames[0], - speed: "0 B/s", - uploadedMB: "0.0", - totalMB: (fileSize / (1024 * 1024)).toFixed(1), - }); - - // Throttle UI updates to 200ms - const UI_UPDATE_INTERVAL_MS = 200; - let lastUIUpdate = 0; - - const renderProgress = () => { - const totalBytesUploaded = getTotalBytesUploaded(); - const elapsedTime = (Date.now() - startTime) / 1000; - const speed = totalBytesUploaded / elapsedTime; - - // Format speed - let speedStr: string; - if (speed > 1024 * 1024) { - speedStr = `${(speed / (1024 * 1024)).toFixed(1)} MB/s`; - } else if (speed > 1024) { - speedStr = `${(speed / 1024).toFixed(1)} KB/s`; - } else { - speedStr = `${speed.toFixed(0)} B/s`; - } - - progressBar?.update(totalBytesUploaded, { - spinner: spinner.frames[spinnerIndex % spinner.frames.length], - speed: speedStr, - uploadedMB: (totalBytesUploaded / (1024 * 1024)).toFixed(1), - totalMB: (fileSize / (1024 * 1024)).toFixed(1), - }); - }; - - // Create a timer to animate the spinner and update progress - spinnerTimer = setInterval(() => { - spinnerIndex++; - const now = Date.now(); - if (now - lastUIUpdate >= UI_UPDATE_INTERVAL_MS) { - renderProgress(); - lastUIUpdate = now; - } - }, spinner.interval); - - const updateProgress = (part: number, bytesUploaded: number) => { - const previousBytes = partProgress.get(part) || 0; - partProgress.set(part, previousBytes + bytesUploaded); - }; - - const resetPartProgress = (part: number) => { - partProgress.set(part, 0); - }; - - // Upload parts concurrently with specified concurrency limit - const uploadPart = async ({ - part, - start, - end, - }: { - part: number; - start: number; - end: number; - }) => { - const chunkSize = end - start; - - // Upload the chunk with retry, fetching fresh URL each attempt - await retry( - async (bail: (e: Error) => void, attemptNumber: number) => { - // Reset progress for this part on retry (except first attempt) - if (attemptNumber > 1) { - resetPartProgress(part); - } - - // Fetch fresh upload URL for this attempt - const response = await client.POST( - "/v1/vms/images/{image_id}/upload", - { - params: { - path: { - image_id: imageId, - }, - }, - body: { - part_id: part, - }, - }, - ); - - if (!response.response.ok || !response.data) { - const status = response.response.status; - const errorText = response.response.ok - ? "No data in response" - : await response.response.text().catch(() => ""); - - // Bail on non-transient 4xx errors (except 408 Request Timeout and 429 Too Many Requests) - if ( - status >= 400 && - status < 500 && - status !== 408 && - status !== 429 - ) { - bail( - new Error( - `Failed to get upload URL for part ${part}: ${status} ${response.response.statusText} - ${errorText}`, - ), - ); - return; - } - - throw new Error( - `Failed to get upload URL for part ${part}: ${status} ${response.response.statusText} - ${errorText}`, - ); - } - - const url = response.data.upload_url; - - // Read chunk from disk with progress tracking - const payload = await readChunk( - filePath, - start, - chunkSize, - (bytesRead) => { - updateProgress(part, bytesRead); - }, - ); - - const res = await fetch(url, { - method: "PUT", - headers: { - "Content-Type": "application/octet-stream", - }, - body: payload as BodyInit, - }); - - if (!res.ok) { - // Bail on non-transient 4xx errors (except 408 and 429) - if ( - res.status >= 400 && - res.status < 500 && - res.status !== 408 && - res.status !== 429 - ) { - bail( - new Error( - `Part ${part} upload failed: ${res.status} ${res.statusText}`, - ), - ); - return; - } - - throw new Error( - `Part ${part} upload failed: ${res.status} ${res.statusText}`, - ); - } - }, - { - retries: 5, - factor: 2, - randomize: true, - }, - ); - - // Mark part as complete - return part; - }; - - // Process uploads with concurrency limit - const results: number[] = []; - try { - for (let i = 0; i < uploadParts.length; i += concurrencyLimit) { - const batch = uploadParts.slice(i, i + concurrencyLimit); - const batchResults = await Promise.allSettled(batch.map(uploadPart)); - - for (const result of batchResults) { - if (result.status === "fulfilled") { - results.push(result.value); - } else { - throw new Error(`Upload failed: ${result.reason}`); - } - } - } - } finally { - // Always clean up timer, even on error - if (spinnerTimer) { - clearInterval(spinnerTimer); - spinnerTimer = undefined; - } - } - - progressBar.update(fileSize, { - spinner: chalk.green("✔"), - speed: "0 B/s", - uploadedMB: (fileSize / (1024 * 1024)).toFixed(1), - totalMB: (fileSize / (1024 * 1024)).toFixed(1), - }); - progressBar.stop(); - - finalizingSpinner = ora("Validating upload...").start(); - // Calculate SHA256 hash for integrity verification using streaming - const hash = crypto.createHash("sha256"); - - const fileStream = fs.createReadStream(filePath); - for await (const chunk of fileStream) { - hash.update(chunk); - } - - const sha256Hash = hash.digest("hex"); - const completeResponse = await client.PUT( - "/v1/vms/images/{image_id}/complete_upload", - { - params: { - path: { - image_id: imageId, - }, - }, - body: { - sha256_hash: sha256Hash, - }, - }, - ); - - if (!completeResponse.data) { - throw new Error( - `Failed to complete upload: ${completeResponse.response.status} ${completeResponse.response.statusText}`, - ); - } - - finalizingSpinner.succeed("Image uploaded and verified"); - - const object = completeResponse.data; - console.log(chalk.gray("\nNext steps:")); - console.log(` sf nodes images show ${chalk.cyan(object.id)}`); - } catch (err) { - // Clean up spinner timer - if (spinnerTimer) { - clearInterval(spinnerTimer); - spinnerTimer = undefined; - } - - // Stop progress bar - try { - progressBar?.stop(); - } catch { - // Ignore if progress bar not started - } - - // Stop any running spinners on error - if (preparingSpinner?.isSpinning) { - preparingSpinner.fail( - `Upload preparation failed: ${ - err instanceof Error ? err.message : String(err) - }`, - ); - } else if (finalizingSpinner?.isSpinning) { - finalizingSpinner.fail( - `Failed to finalize upload: ${ - err instanceof Error ? err.message : String(err) - }`, - ); - } else { - console.error( - `\n${chalk.red("✗")} ${ - err instanceof Error ? err.message : String(err) - }`, - ); - } - process.exit(1); - } - }); - -export default upload; diff --git a/src/lib/nodes/index.ts b/src/lib/nodes/index.ts index 36446960..05f5d92d 100644 --- a/src/lib/nodes/index.ts +++ b/src/lib/nodes/index.ts @@ -1,11 +1,10 @@ import console from "node:console"; import type { Command } from "@commander-js/extra-typings"; - +import { createImagesCommand } from "../images/index.ts"; import create from "./create.ts"; import deleteCommand from "./delete.ts"; import extend from "./extend.ts"; import get from "./get.tsx"; -import image from "./image/index.ts"; import list from "./list.tsx"; import logs from "./logs.ts"; import redeploy from "./redeploy.ts"; @@ -29,7 +28,7 @@ export function registerNodes(program: Command) { .addCommand(set) .addCommand(ssh) .addCommand(logs) - .addCommand(image); + .addCommand(createImagesCommand()); const baseHelpText = nodes.helpInformation(); diff --git a/src/lib/posthog.ts b/src/lib/posthog.ts index 06211b41..299183af 100644 --- a/src/lib/posthog.ts +++ b/src/lib/posthog.ts @@ -40,7 +40,7 @@ const trackEvent = ({ if (!exchangeAccountId) { const client = await apiClient(config.auth_token); - const { data } = await client.GET("/v0/me"); + const { data } = await client.GET("/v1/account/me", {}); if (data?.id) { exchangeAccountId = data.id; await saveConfig({ ...config, account_id: data.id }); @@ -81,16 +81,20 @@ export const isFeatureEnabled = async (feature: FeatureFlags) => { return cachedFlag.value; } - // Fetch from the v2/feature_flags API + // Fetch from the v2/feature_flags API. Uses raw fetch because the route is + // not exposed on the regenerated `src/schema.ts` (only the admin variant is), + // but it is still served externally per the HAProxy config. let finalResult = false; try { - const client = await apiClient(config.auth_token); - const { data, response } = await client.GET( - "/v2/feature_flags/{feature_flag_id}", - { params: { path: { feature_flag_id: feature } } }, + const response = await fetch( + `${config.api_url}/v2/feature_flags/${encodeURIComponent(feature)}`, + { headers: { Authorization: `Bearer ${config.auth_token}` } }, ); + if (response.ok) { + const data = (await response.json()) as { enabled?: boolean }; + finalResult = data?.enabled ?? false; + } // 404 means the flag doesn't exist → treat as disabled (false) - finalResult = response.ok ? (data?.enabled ?? false) : false; } catch { // Network or parse error → default to false } diff --git a/src/lib/scale/create.tsx b/src/lib/scale/create.tsx index bad2cf83..c80b7248 100644 --- a/src/lib/scale/create.tsx +++ b/src/lib/scale/create.tsx @@ -101,7 +101,9 @@ function useCreateProcurement() { }, ); if (!response.ok) { - throw new Error(error?.message || "Failed to create procurement"); + throw new Error( + error?.error?.message || "Failed to create procurement", + ); } setResult(data); } catch (err: unknown) { diff --git a/src/lib/scale/list.tsx b/src/lib/scale/list.tsx index df27bf3c..d59b5f33 100644 --- a/src/lib/scale/list.tsx +++ b/src/lib/scale/list.tsx @@ -26,7 +26,7 @@ async function listProcurements() { }); if (!response.ok) { - throw new Error(error?.message || "Failed to list procurements"); + throw new Error(error?.error?.message || "Failed to list procurements"); } const { data = [], has_more = false } = listObject ?? {}; diff --git a/src/lib/scale/update.tsx b/src/lib/scale/update.tsx index 311bd730..03515899 100644 --- a/src/lib/scale/update.tsx +++ b/src/lib/scale/update.tsx @@ -53,8 +53,8 @@ export async function updateProcurement({ ); if (!response.ok) { throw new Error( - error?.message - ? `${error.message} (${response.status})` + error?.error?.message + ? `${error.error.message} (${response.status})` : "Failed to update procurement", ); } diff --git a/src/lib/scale/utils.ts b/src/lib/scale/utils.ts index 9b5170de..7fa33e09 100644 --- a/src/lib/scale/utils.ts +++ b/src/lib/scale/utils.ts @@ -65,7 +65,7 @@ export async function getProcurement({ id }: { id: string }) { }); if (!res.response.ok) { - throw new Error(res.error?.message || "Failed to get procurement"); + throw new Error(res.error?.error?.message || "Failed to get procurement"); } return res.data ?? null; diff --git a/src/lib/vm/index.ts b/src/lib/vm/index.ts index 43cbf866..b754c7d1 100644 --- a/src/lib/vm/index.ts +++ b/src/lib/vm/index.ts @@ -3,7 +3,7 @@ import type { Command } from "@commander-js/extra-typings"; import boxen from "boxen"; import chalk from "chalk"; import { nodesClient } from "../../nodesClient.ts"; -import image from "../nodes/image/index.ts"; +import { createImagesCommand } from "../images/index.ts"; import { pluralizeNodes } from "../nodes/utils.ts"; import list from "./list.ts"; import logs from "./logs.ts"; @@ -66,5 +66,5 @@ export async function registerVM(program: Command) { .addCommand(logs) .addCommand(replace) .addCommand(script) - .addCommand(image); + .addCommand(createImagesCommand()); } diff --git a/src/schema.ts b/src/schema.ts index 0c80087e..b2d22590 100644 --- a/src/schema.ts +++ b/src/schema.ts @@ -4,229 +4,6 @@ */ export interface paths { - "/v0/me": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description The authenticated account */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["San_Francisco_Compute_Documentation_Account"]; - }; - }; - /** @description Account not found */ - 404: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["San_Francisco_Compute_Documentation_AccountNotFoundError"]; - }; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v0/tokens": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get: { - parameters: { - query?: { - include_system?: boolean; - origin_client?: "cli" | "web" | "manual"; - }; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description List tokens */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["San_Francisco_Compute_Documentation_ListTokenResponse"]; - }; - }; - /** @description Account not found */ - 404: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["San_Francisco_Compute_Documentation_AccountNotFoundError"]; - }; - }; - }; - }; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description Number of seconds until token expires. - * @example 604800 - */ - expires_in_seconds: number; - /** @description Name of the token. */ - name?: string; - /** @description Description of the token. */ - description?: string; - /** @enum {string} */ - origin_client: "cli"; - }; - }; - }; - responses: { - /** @description Token created successfully */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["San_Francisco_Compute_Documentation_Token"]; - }; - }; - /** @description Invalid request parameters */ - 400: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["San_Francisco_Compute_Documentation_MaxTokenLimitReached"]; - }; - }; - /** @description Authentication required */ - 401: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["San_Francisco_Compute_Documentation_AccountNotFoundError"]; - }; - }; - /** @description Account is frozen */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["San_Francisco_Compute_Documentation_AccountFrozenError"]; - }; - }; - /** @description Token not found */ - 404: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": - | components["schemas"]["San_Francisco_Compute_Documentation_AccountNotFoundError"] - | components["schemas"]["San_Francisco_Compute_Documentation_InvalidTokenCreateOriginClient"]; - }; - }; - /** @description Token generation rate limit exceeded */ - 429: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["San_Francisco_Compute_Documentation_MaxTokenLimitReached"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v0/tokens/{id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post?: never; - delete: { - parameters: { - query?: never; - header?: never; - path: { - id: string; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Token deleted */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - success: boolean; - }; - }; - }; - /** @description Token or account not found */ - 404: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": - | components["schemas"]["San_Francisco_Compute_Documentation_AccountNotFoundError"] - | components["schemas"]["San_Francisco_Compute_Documentation_TokenNotFound"]; - }; - }; - }; - }; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/v0/transactions": { parameters: { query?: never; @@ -298,107 +75,6 @@ export interface paths { patch?: never; trace?: never; }; - "/v0/credentials": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["SF_Compute_K8s_Orchestration_API_frontend_server.ListResponse"]; - }; - }; - }; - }; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** @description Credential details */ - requestBody: { - content: { - "application/json": components["schemas"]["SF_Compute_K8s_Orchestration_API_types.KubernetesCredentialBody"]; - }; - }; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["SF_Compute_K8s_Orchestration_API_frontend_server.BaseCredentialResponse"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v0/credentials/{id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post?: never; - delete: { - parameters: { - query?: never; - header?: never; - path: { - /** @description Credential ID (format: cred_) */ - id: string; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": Record; - }; - }; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["SF_Compute_K8s_Orchestration_API_frontend_server.DeleteResponse"]; - }; - }; - }; - }; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/v0/vms/instances": { parameters: { query?: never; @@ -479,7 +155,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v1/vms/images": { + "/v0/zones": { parameters: { query?: never; header?: never; @@ -487,10 +163,10 @@ export interface paths { cookie?: never; }; /** - * List Images - * @description List all VM Images for the authenticated account + * List zones + * @description List all available zones */ - get: operations["list_vms_images"]; + get: operations["list_zones_handler"]; put?: never; post?: never; delete?: never; @@ -499,302 +175,18 @@ export interface paths { patch?: never; trace?: never; }; - "/v1/vms/images/start_upload": { + "/v0/zones/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; - post: operations["start_image_upload"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v1/vms/images/{image_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Download Image - * @description Get the download URL for a VM image by ID - */ - get: operations["download_image"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v1/vms/images/{image_id}/complete_upload": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put: operations["complete_image_upload"]; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v1/vms/images/{image_id}/upload": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: operations["create_image_upload_url"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/images": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List Images - * @description List all VM Images for the authenticated account - */ - get: operations["list_images_v2"]; - put?: never; - /** - * Create image - * @description Start a new image upload. Returns the created image metadata. - */ - post: operations["start_upload"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/images/{id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get Image - * @description Get metadata for a VM image by ID - */ - get: operations["get_image"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/images/{id}/complete": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: operations["complete_upload"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/images/{id}/download": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Download Image - * @description Get a presigned download URL for a completed VM image - */ - get: operations["download_image_v2"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/images/{id}/parts": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: operations["upload_part"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/nodes": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List nodes - * @description List nodes - */ - get: operations["list_nodes"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/nodes/{id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get node - * @description Retrieve details of a specific node by ID. - */ - get: operations["get_node"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/nodes/{id}/logs": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get node logs - * @description Retrieve log chunks for a specific node, with optional filtering by sequence number and timestamp. - */ - get: operations["get_node_logs"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/nodes/{id}/replace": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** - * Replace node - * @description Replace a node by destroying the existing one and creating a new node in the same capacity. Optionally specify a new image and cloud-init user data. - */ - post: operations["replace_node"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/nodes/{id}/ssh": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get node SSH info - * @description Get SSH connection details for a specific node, including hostname, port, and host keys. - */ - get: operations["get_node_ssh"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v0/zones": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List zones - * @description List all available zones - */ - get: operations["list_zones_handler"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v0/zones/{id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get zone by ID - * @description Get detailed information about a specific zone - */ - get: operations["get_zone_handler"]; + /** + * Get zone by ID + * @description Get detailed information about a specific zone + */ + get: operations["get_zone_handler"]; put?: never; post?: never; delete?: never; @@ -1180,23 +572,27 @@ export interface paths { patch?: never; trace?: never; }; - "/v1/invoices/calculate_pricing": { + "/v1/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** + * List events + * @description List events for the authenticated account, ordered by sequence. + */ + get: operations["list_events"]; put?: never; - post: operations["post_calculate_invoice_pricing"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v1/invoices/create_draft": { + "/v1/invoices/calculate_pricing": { parameters: { query?: never; header?: never; @@ -1205,14 +601,14 @@ export interface paths { }; get?: never; put?: never; - post: operations["post_create_draft_invoice"]; + post: operations["post_calculate_invoice_pricing"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v1/invoices/finalize": { + "/v1/invoices/create_draft": { parameters: { query?: never; header?: never; @@ -1221,7 +617,23 @@ export interface paths { }; get?: never; put?: never; - post: operations["post_finalize_invoice"]; + post: operations["post_create_draft_invoice"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/invoices/finalize": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post: operations["post_finalize_invoice"]; delete?: never; options?: never; head?: never; @@ -1285,59 +697,249 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/capacities": { + "/preview/v2/admin/feature_flags": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * List capacities - * @description List all capacities owned by the authenticated user. + * Update a feature flag + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Update the enabled state and/or account_regex of an existing feature flag. At least one of enabled or account_regex must be provided. Omitted fields are left unchanged. + */ + put: operations["adminUpdateFeatureFlag"]; + /** + * Create a feature flag for an account + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Create a feature flag for an account. Returns a feature_flag_id that can be used to update or delete the entry. + */ + post: operations["adminCreateFeatureFlag"]; + /** + * Delete a feature flag + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Soft delete a feature flag entry by its feature_flag_id. */ - get: operations["list_capacities_handler"]; + delete: operations["adminDeleteFeatureFlag"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/admin/images/{id}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; put?: never; /** - * Create capacity - * @description Create a new capacity with optional requirements, node template, and scheduler. + * Publish image + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Publish an image, making it publicly visible to all users. Requires admin permissions. The image must belong to the caller's account and have a completed upload. */ - post: operations["create_capacity_handler"]; + post: operations["publish_image"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/capacities/{id}": { + "/preview/v2/admin/images/{id}/set-default": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; + put?: never; /** - * Get capacity by ID or name - * @description Retrieve a capacity including its compute schedule and scheduler configuration. + * Set default image + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Set a public image as the default. The image must have provider = 'sfc'. Atomically swaps the default from any previous default image to this one. Requires admin permissions. */ - get: operations["get_capacity_handler"]; + post: operations["set_default_image"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/admin/instance_sku_properties": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). */ + get: operations["listInstanceSkuPropertyKeys"]; + put?: never; + /** @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). */ + post: operations["createInstanceSkuPropertyKey"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/admin/instance_sku_properties/{key}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). */ + get: operations["getInstanceSkuPropertyKey"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). */ + patch: operations["patchInstanceSkuPropertyKey"]; + trace?: never; + }; + "/preview/v2/admin/instance_sku_properties/{key}/values": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). */ + get: operations["listInstanceSkuPropertyValues"]; + put?: never; + /** @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). */ + post: operations["createInstanceSkuPropertyValue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/admin/instance_sku_properties/{key}/values/{value}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). */ + get: operations["getInstanceSkuPropertyValue"]; put?: never; post?: never; + delete?: never; + options?: never; + head?: never; + /** @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). */ + patch: operations["patchInstanceSkuPropertyValue"]; + trace?: never; + }; + "/preview/v2/admin/instance_skus": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). */ + get: operations["listInstanceSkus"]; + put?: never; /** - * Delete capacity - * @description Delete a capacity. The capacity must be empty and the scheduler must be disabled or absent. + * Create a new instance SKU with validated properties. + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Minimal compared to the v1 `POST /v1/admin/clusters` endpoint: this + * does **not** touch zones, workspaces, capacities, delivery fees, or + * zone metadata — only the trading-engine `CreateCluster` command with + * validated properties. Use the v1 endpoint if you need that extra + * provider-onboarding plumbing. */ - delete: operations["delete_capacity_handler"]; + post: operations["createInstanceSku"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/admin/instance_skus/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). */ + get: operations["getInstanceSku"]; + /** @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). */ + put: operations["putInstanceSku"]; + post?: never; + /** @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). */ + delete: operations["deleteInstanceSku"]; options?: never; head?: never; /** - * Update capacity - * @description Update a capacity. Only provided fields are changed; omitted fields are left unchanged. + * Patch an instance SKU's display metadata. Currently only `name` is + * updatable here — properties go through `PUT /admin/instance_skus/{id}/properties` + * (full replacement, with the dangerous-rewrite guards). Lookups still + * happen by id; the name is purely for display. + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + */ + patch: operations["patchInstanceSku"]; + trace?: never; + }; + "/preview/v2/admin/invoices/{account_id}/create": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). */ + post: operations["adminCreateInvoice"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/availability": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List grouped instance-SKU availability + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Aggregate availability across instance SKUs that match `requirements`, grouped by the given property keys. Each group exposes a summed `total` schedule plus a per-SKU breakdown. */ - patch: operations["patch_capacity_handler"]; + get: operations["list_availability"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; trace?: never; }; - "/v2/node_templates": { + "/preview/v2/capacities": { parameters: { query?: never; header?: never; @@ -1345,23 +947,27 @@ export interface paths { cookie?: never; }; /** - * List node templates - * @description List all node templates accessible by the authenticated user. + * List capacities + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * List all capacities. */ - get: operations["list_node_templates_handler"]; + get: operations["list_capacities"]; put?: never; /** - * Create node template - * @description Create a new node template with reusable VM configuration. + * Create capacity + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Create a capacity to hold compute. */ - post: operations["create_node_template_handler"]; + post: operations["create_capacity"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/node_templates/{id}": { + "/preview/v2/capacities/{id}": { parameters: { query?: never; header?: never; @@ -1369,23 +975,33 @@ export interface paths { cookie?: never; }; /** - * Get node template by ID or name - * @description Get detailed information about a specific node template. + * Get capacity + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Retrieve a capacity by ID, resource path, or name, including its compute schedule. */ - get: operations["get_node_template_handler"]; + get: operations["fetch_capacity"]; put?: never; post?: never; /** - * Delete node template - * @description Delete a node template. The template must not be in use by any capacity. + * Delete capacity + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Delete a capacity. The capacity must have no active orders, future allocations, active nodes, deployments, or procurements. Remove all dependencies before deleting. */ - delete: operations["delete_node_template_handler"]; + delete: operations["delete_capacity"]; options?: never; head?: never; - patch?: never; + /** + * Update capacity + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Update a capacity. Omitted fields are left unchanged. + */ + patch: operations["update_capacity"]; trace?: never; }; - "/v2/orders": { + "/preview/v2/capacity_transfers": { parameters: { query?: never; header?: never; @@ -1393,23 +1009,27 @@ export interface paths { cookie?: never; }; /** - * List orders - * @description List all orders for the authenticated user. + * List capacity transfers + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * List capacity transfers for the caller's organization. */ - get: operations["list_orders"]; + get: operations["list_capacity_transfers"]; put?: never; /** - * Create order - * @description Place a buy or sell order on the market for a specific capacity. + * Create capacity transfer + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Transfer some or all of one capacity into another */ - post: operations["post_order"]; + post: operations["create_capacity_transfer"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/orders/{id}": { + "/preview/v2/capacity_transfers/{id}": { parameters: { query?: never; header?: never; @@ -1417,40 +1037,83 @@ export interface paths { cookie?: never; }; /** - * Get order details - * @description Retrieve details of a specific order by ID. + * Get capacity transfer + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Retrieve a capacity transfer by ID. */ - get: operations["get_order"]; + get: operations["fetch_capacity_transfer"]; put?: never; post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List deployments + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * List all deployments. + */ + get: operations["list_deployments"]; + put?: never; /** - * Cancel an order - * @description Request cancellation of an order. This is asynchronous — poll `GET /v2/orders/{id}` to confirm the status has changed to cancelled. + * Create deployment + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Create a deployment for bulk node management. */ - delete: operations["cancel_order"]; + post: operations["create_deployment"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/feature_flags/{feature_flag_id}": { + "/preview/v2/deployments/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get feature flag status for the authenticated user */ - get: operations["get_feature_flag"]; + /** + * Get deployment + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Retrieve a deployment by ID or name. + */ + get: operations["get_deployment"]; put?: never; post?: never; - delete?: never; + /** + * Delete deployment + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Delete a deployment. + */ + delete: operations["delete_deployment"]; options?: never; head?: never; - patch?: never; + /** + * Update deployment + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Update a deployment's configuration. + */ + patch: operations["patch_deployment"]; trace?: never; }; - "/v1/inference/batches": { + "/preview/v2/grants": { parameters: { query?: never; header?: never; @@ -1458,23 +1121,27 @@ export interface paths { cookie?: never; }; /** - * List all batches - * @description Returns all batches for your account. Archived batches are excluded. Use `limit` and `after` parameters for pagination. + * List grants + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * List grants, optionally filtered by workspace or principal. Callers without `grant:list` + `grant:read` are restricted to grants whose principal is themselves. */ - get: operations["list_batches"]; + get: operations["list_grants_handler"]; put?: never; /** - * Create batch jobs - * @description Creates a new batch job. Accepts a single batch request or multiple requests. Make sure to follow the [expected file structure for batches](large-scale-inference#large-scale-inference__input-file-format). The batch starts in `accepted` status. + * Create grant + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Grant a role to a principal (user or token) on a workspace, or org-wide when workspace_id is omitted. */ - post: operations["create_batches"]; + post: operations["create_grant_handler"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v1/inference/batches/{batch_id}": { + "/preview/v2/grants/{id}": { parameters: { query?: never; header?: never; @@ -1482,59 +1149,83 @@ export interface paths { cookie?: never; }; /** - * Get a batch - * @description Returns details for a specific batch identified by `batch_id`. + * Get grant + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Retrieve a grant by ID. Callers without `grant:read` may still fetch a grant whose principal is themselves */ - get: operations["get_batch"]; + get: operations["get_grant_handler"]; put?: never; post?: never; - delete?: never; + /** + * Delete grant + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Delete a grant. + */ + delete: operations["delete_grant_handler"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v1/inference/batches/{batch_id}/archive": { + "/preview/v2/images": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** + * List images + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * List images in the specified workspace. Pass `sfc:workspace:sfcompute:public` as the workspace to list sfc-provided public images instead. + */ + get: operations["list_images"]; put?: never; /** - * Archive a batch - * @description Archives a batch identified by `batch_id`. Archived batches are excluded from list results. + * Create image + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Create an image and start a multipart upload. */ - post: operations["archive_batch"]; + post: operations["create_image"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v1/inference/batches/{batch_id}/cancel": { + "/preview/v2/images/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** + * Get image + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Retrieve an image by ID. Returns both user-owned and public images. + */ + get: operations["fetch_image"]; put?: never; + post?: never; /** - * Cancel a batch - * @description Cancels a batch that is in `accepted` status. Batches in other states cannot be cancelled. + * Delete image + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Delete an image. */ - post: operations["cancel_batch"]; - delete?: never; + delete: operations["delete_image"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v1/inference/batches/{batch_id}/retry": { + "/preview/v2/images/{id}/complete": { parameters: { query?: never; header?: never; @@ -1544,17 +1235,19 @@ export interface paths { get?: never; put?: never; /** - * Retry a batch - * @description Retries a batch that is `failed`, `cancelled`, `expired`, or `completed` status. Presigned URLs must still be valid. Maximum `2` retries per batch. + * Complete image upload + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Finalize a multipart image upload. */ - post: operations["retry_batch"]; + post: operations["complete_image_upload"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v1/inference/models": { + "/preview/v2/images/{id}/download": { parameters: { query?: never; header?: never; @@ -1562,10 +1255,12 @@ export interface paths { cookie?: never; }; /** - * List available models - * @description Returns all available models. Use `model_id` values when creating batches. If you don't see a model you need, please [contact us](https://sfcompute.com/inference/contact). + * Download image + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Get a presigned URL to download an image. */ - get: operations["get_models"]; + get: operations["download_image"]; put?: never; post?: never; delete?: never; @@ -1574,2963 +1269,8914 @@ export interface paths { patch?: never; trace?: never; }; - "/v0/quote": { + "/preview/v2/images/{id}/parts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get: operations["handle_quote"]; + get?: never; put?: never; - post?: never; + /** + * Get upload part URL + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Get a presigned URL to upload one part of a multipart image upload. + */ + post: operations["create_image_upload_part_url"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; -} -export type webhooks = Record; -export interface components { - schemas: { - San_Francisco_Compute_Documentation_Account: { - /** - * @example account - * @enum {string} - */ - object: "account"; - /** @example acc_123 */ - id: string; - /** - * @example user - * @enum {string} - */ - role: "admin" | "user" | "vendor" | "clops" | "sfcd"; - /** @example true */ - can_buy: boolean; - /** @example false */ - can_sell: boolean; - }; - San_Francisco_Compute_Documentation_AccountNotFoundError: { - /** - * @example error - * @enum {string} - */ - object: "error"; - /** - * @example account.not_found - * @enum {string} - */ - code: "account.not_found"; - /** @example Account not found */ - message?: string; - /** @example {} */ - details?: { - [key: string]: unknown; - }; + "/preview/v2/images/{id}/revoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - San_Francisco_Compute_Documentation_Token: { - /** - * @description The type of object - * @enum {string} - */ - object: "token"; - id: string; - /** - * @description Only available after creation - * @example - */ - token?: string; - /** @description Name of the token. */ - name: string | null; - /** @description Description of the token. */ - description: string | null; - is_sandbox: boolean; - /** @description ISO 8601 date string of when token expires (in UTC). */ - last_active_at: string | null; - /** @description ISO 8601 date string of when token expires (in UTC). */ - expires_at: string; - /** @description ISO 8601 date string of when token was created (in UTC). */ - created_at: string; - /** @enum {string|null} */ - origin_client: "cli" | "web" | "manual" | null; - /** @description Whether the token was generated by the system & is being used in the background, or whether a user explicitly created it for their own use. */ - is_system: boolean; + get?: never; + put?: never; + /** + * Revoke image + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Revoke a private image. Revoked images can't back new instances; existing instances continue running. + */ + post: operations["revoke_image"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/instance_sku_property_catalog": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - San_Francisco_Compute_Documentation_ListTokenResponse: { - data: components["schemas"]["San_Francisco_Compute_Documentation_Token"][]; - /** - * @example true - * @example false - */ - has_more: boolean; - /** - * @example list - * @enum {string} - */ - object: "list"; + /** + * List instance SKU property catalog + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * List every property key and its allowed values. Use the keys and values here when filling in `requirements` on orders and procurements. + */ + get: operations["list_instance_sku_property_catalog"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/instance_skus": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - San_Francisco_Compute_Documentation_MaxTokenLimitReached: { - /** - * @example error - * @enum {string} - */ - object: "error"; - /** - * @example token.max_token_limit_reached - * @enum {string} - */ - code: "token.max_token_limit_reached"; - /** @example Max token limit reached */ - message?: string; - /** @example {} */ - details?: { - [key: string]: unknown; - }; + /** + * List instance SKUs + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * List all instance SKUs available on the market with their properties. + */ + get: operations["list_instance_skus"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/instance_skus/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - San_Francisco_Compute_Documentation_AccountFrozenError: { - /** - * @example error - * @enum {string} - */ - object: "error"; - /** - * @example account.frozen - * @enum {string} - */ - code: "account.frozen"; - /** @example Account is frozen */ - message?: string; - /** @example {} */ - details?: { - [key: string]: unknown; - }; + /** + * Get instance SKU + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Retrieve an instance SKU by ID, including its registered properties. + */ + get: operations["get_instance_sku"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/instance_templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - San_Francisco_Compute_Documentation_InvalidTokenCreateOriginClient: { - /** - * @example error - * @enum {string} - */ - object: "error"; - /** - * @example token.invalid_token_create_origin_client - * @enum {string} - */ - code: "token.invalid_token_create_origin_client"; - /** @example Invalid token create origin client */ - message?: string; - /** @example {} */ - details?: { - [key: string]: unknown; - }; + /** + * List instance templates + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * List all instance templates. + */ + get: operations["list_instance_templates"]; + put?: never; + /** + * Create instance template + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Create a reusable instance template. + */ + post: operations["create_instance_template"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/instance_templates/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - San_Francisco_Compute_Documentation_TokenNotFound: { - /** - * @example error - * @enum {string} - */ - object: "error"; - /** - * @example token.not_found - * @enum {string} - */ - code: "token.not_found"; - /** @example Token not found */ - message?: string; - /** @example {} */ - details?: { - [key: string]: unknown; - }; + /** + * Get instance template + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Retrieve an instance template by ID or resource path. + */ + get: operations["fetch_instance_template"]; + put?: never; + post?: never; + /** + * Delete instance template + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Delete an instance template. The template must not be in use by any capacity. + */ + delete: operations["delete_instance_template"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/instances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** - * @description Whether the transaction is incoming to or outgoing from the account. - * @example incoming - * @example outgoing - * @enum {string} + * List instances + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * List all instances. */ - San_Francisco_Compute_Documentation_TransactionDirection: - | "incoming" - | "outgoing"; + get: operations["list_instances"]; + put?: never; /** - * @description The current status of a transaction. - * @example accepted - * @example rejected - * @enum {string} + * Create instance + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Create an instance. */ - San_Francisco_Compute_Documentation_TransactionStatus: - | "accepted" - | "rejected"; + post: operations["create_instance"]; + delete?: never; + options?: never; + head?: never; /** - * @description The kind of account involved in the transaction. Each user has one account of each account kind. The account "primary" is the main one used for buy/sell on the platform. - * @example primary - * @example withdrawal_reserve - * @enum {string} + * Update multiple instances + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Update one or more instances atomically. All listed instances must be in the same workspace; mixed-workspace batches are rejected with 422. */ - San_Francisco_Compute_Documentation_AccountKind: - | "primary" - | "capital" - | "withdrawal_reserve" - | "fulfillment_escrow" - | "delivery_fee_escrow"; + patch: operations["batch_patch_instances"]; + trace?: never; + }; + "/preview/v2/instances/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** - * @description A transaction representing a movement of funds - * @example { - * "id": "tx_1234567890-4", - * "timestamp": "2024-03-15T00:30:00.000Z", - * "direction": "outgoing", - * "status": "accepted", - * "amount": 5000, - * "account_kind": "primary", - * "balance_before": 70000, - * "balance_after": 65000, - * "metadata": { - * "type": "buy", - * "start_time": "2024-11-05T07:24:24.207Z", - * "end_time": "2024-11-05T09:24:24.207Z", - * "quantity": 2, - * "order_id": "ordr_34905N", - * "instance_type_requirements": { - * "accelerator_types": [ - * "H100" - * ], - * "interconnect_types": [ - * "Infiniband" - * ], - * "regions": [ - * "NorthAmerica" - * ], - * "delivery_type": "K8s" - * } - * } - * } + * Get instance + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Retrieve an instance by ID or name. */ - San_Francisco_Compute_Documentation_Transaction: { - /** @description Unique identifier for the transaction */ - id: string; - /** - * Format: date-time - * @description When the money movement occurred within SFCs system - */ - timestamp: string; - direction: components["schemas"]["San_Francisco_Compute_Documentation_TransactionDirection"]; - status: components["schemas"]["San_Francisco_Compute_Documentation_TransactionStatus"]; - /** @description Transaction amount in cents */ - amount: number; - account_kind: components["schemas"]["San_Francisco_Compute_Documentation_AccountKind"]; - /** @description Account balance before transaction in cents */ - balance_before: number; - /** @description Account balance after transaction in cents */ - balance_after: number; - /** @description Additional transaction-specific details */ - metadata: - | { - /** @enum {string} */ - type: "buy"; - /** @description Requirements specified for the buy order */ - instance_type_requirements: { - /** @description List of allowed accelerator types. */ - accelerator_types?: ("H100" | "H200")[]; - /** @description List of allowed interconnect types. */ - interconnect_types?: ("Infiniband" | "None")[]; - /** @description List of allowed regions. */ - regions?: ( - | "NorthAmerica" - | "AsiaPacific" - | "EuropeMiddleEastAfrica" - )[]; - /** - * @description Delivery method. - * @enum {string} - */ - delivery_type: "K8s" | "VM"; - }; - /** @description Quantity requested in the buy order, in number of nodes (8 gpus) */ - quantity: number; + get: operations["fetch_instance"]; + put?: never; + post?: never; + /** + * Delete instance + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Delete an instance. + */ + delete: operations["delete_instance"]; + options?: never; + head?: never; + /** + * Update instance + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Update an instance. Omitted fields are left unchanged. + */ + patch: operations["update_instance"]; + trace?: never; + }; + "/preview/v2/instances/{id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get instance logs + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Retrieve logs for an instance. + */ + get: operations["get_instance_logs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/instances/{id}/ssh": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get instance SSH info + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Retrieve SSH connection details for an instance. + */ + get: operations["get_instance_ssh"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/instances/{id}/terminate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Terminate instance + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Terminates a running instance. Terminated instances can not be restarted. + */ + post: operations["terminate_instance"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/order_preview": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Estimate an order + * @description Estimate a buy or sell order before placing it. + */ + post: operations["get_order_preview"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/orderbook/depth": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get market depth + * @description Depth of book for the given requirements and delivery window, aggregated by price level. Individual orders, participants, and matched SKU identities are not exposed. + */ + get: operations["get_orderbook_depth"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/orderbook/fills": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List market fills + * @description All contracts that filled on hardware meeting the requirements for the given delivery window, sorted newest first. One row per fill (contract). Participant identity is never exposed. + */ + get: operations["list_orderbook_fills"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/orderbook/quote": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get market quote + * @description Top-of-book quote (best bid + best ask) for the given requirements and delivery window. The book is aggregated across every SKU whose orders satisfy the requirements and that the caller is permitted to see. + */ + get: operations["get_orderbook_quote"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/orderbook/windows": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List market windows + * @description List every delivery window with resting orders matching the requirements, within the given time range. Each row is a summary; use /quote or /depth for detail on a specific window. + */ + get: operations["list_orderbook_windows"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/orders": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List orders + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * List all orders. + */ + get: operations["list_orders"]; + put?: never; + /** + * Create order + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Place a buy or sell order. Orders fill completely or not at all. All nodes fill on a single instance SKU matching the order's `requirements`. Order filling is asynchronous; poll `GET /v2/orders/{id}` to check status. + */ + post: operations["create_order"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/orders/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get order + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Retrieve an order by ID. + */ + get: operations["fetch_order"]; + put?: never; + post?: never; + /** + * Cancel order + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Request cancellation of an order. This is asynchronous — poll `GET /v2/orders/{id}` to confirm the status has changed to cancelled. + */ + delete: operations["cancel_order"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/permissions/check": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Check permissions + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Evaluate one or more `"resource:verb"` actions against the caller's grants and return a single aggregated verdict. Pass `workspace` to check workspace-scoped grants, or omit it to check org-scoped grants. + */ + post: operations["check_permission_handler"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/procurements": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List procurements + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * List all procurements. + */ + get: operations["list_procurements"]; + put?: never; + /** + * Create procurement + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Create a market automation that maintains capacity by placing buy/sell orders. + */ + post: operations["create_procurement"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/procurements/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get procurement + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Retrieve a procurement by ID or name. + */ + get: operations["get_procurement"]; + put?: never; + post?: never; + /** + * Delete procurement + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Delete a procurement. Standing orders are cancelled automatically. + */ + delete: operations["delete_procurement"]; + options?: never; + head?: never; + /** + * Update procurement + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Update a procurement's configuration. + */ + patch: operations["patch_procurement"]; + trace?: never; + }; + "/preview/v2/roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List roles + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * List all role definitions. Built-in roles appear first, followed by custom roles sorted by creation date (newest first). + */ + get: operations["list_roles_handler"]; + put?: never; + /** + * Create role + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Create a role. + */ + post: operations["create_role_handler"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/roles/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get role + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Retrieve a role by ID, resource path, or name. + */ + get: operations["get_role_handler"]; + /** + * Update role + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Update a role's name and/or policy. + */ + put: operations["update_role_handler"]; + post?: never; + /** + * Delete role + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Delete a role by ID, resource path, or name. + */ + delete: operations["delete_role_handler"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List users + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * List users that are members of the caller's organization. + */ + get: operations["list_users_handler"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/users/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get user + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Returns user details by ID or resource path. + */ + get: operations["get_user_handler"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/workspaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List workspaces + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * List all workspaces for the authenticated account. + */ + get: operations["list_workspaces_handler"]; + put?: never; + /** + * Create workspace + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Create a workspace. + */ + post: operations["create_workspace_handler"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/preview/v2/workspaces/{workspace}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get workspace + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Retrieve a workspace by name or ID. + */ + get: operations["get_workspace_handler"]; + put?: never; + post?: never; + /** + * Delete workspace + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Soft-delete a workspace by name or ID. Workspace must be empty (no capacities, instance templates, or images). + */ + delete: operations["delete_workspace_handler"]; + options?: never; + head?: never; + /** + * Update workspace + * @description > ⚠️ This endpoint is in [public preview](/preview/roadmap). + * + * Rename a workspace. + */ + patch: operations["patch_workspace_handler"]; + trace?: never; + }; + "/v0/quote": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: operations["handle_quote"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; +} +export type webhooks = Record; +export interface components { + schemas: { + /** + * @description Whether the transaction is incoming to or outgoing from the account. + * @example incoming + * @example outgoing + * @enum {string} + */ + San_Francisco_Compute_Documentation_TransactionDirection: + | "incoming" + | "outgoing"; + /** + * @description The current status of a transaction. + * @example accepted + * @example rejected + * @enum {string} + */ + San_Francisco_Compute_Documentation_TransactionStatus: + | "accepted" + | "rejected"; + /** + * @description The kind of account involved in the transaction. Each user has one account of each account kind. The account "primary" is the main one used for buy/sell on the platform. + * @example primary + * @example withdrawal_reserve + * @enum {string} + */ + San_Francisco_Compute_Documentation_AccountKind: + | "primary" + | "capital" + | "withdrawal_reserve" + | "fulfillment_escrow" + | "delivery_fee_escrow"; + /** + * @description A transaction representing a movement of funds + * @example { + * "id": "tx_1234567890-4", + * "timestamp": "2024-03-15T00:30:00.000Z", + * "direction": "outgoing", + * "status": "accepted", + * "amount": 5000, + * "account_kind": "primary", + * "balance_before": 70000, + * "balance_after": 65000, + * "metadata": { + * "type": "buy", + * "start_time": "2024-11-05T07:24:24.207Z", + * "end_time": "2024-11-05T09:24:24.207Z", + * "quantity": 2, + * "order_id": "ordr_34905N", + * "instance_type_requirements": { + * "accelerator_types": [ + * "H100" + * ], + * "interconnect_types": [ + * "Infiniband" + * ], + * "regions": [ + * "NorthAmerica" + * ], + * "delivery_type": "K8s" + * } + * } + * } + */ + San_Francisco_Compute_Documentation_Transaction: { + /** @description Unique identifier for the transaction */ + id: string; + /** + * Format: date-time + * @description When the money movement occurred within SFCs system + */ + timestamp: string; + direction: components["schemas"]["San_Francisco_Compute_Documentation_TransactionDirection"]; + status: components["schemas"]["San_Francisco_Compute_Documentation_TransactionStatus"]; + /** @description Transaction amount in cents */ + amount: number; + account_kind: components["schemas"]["San_Francisco_Compute_Documentation_AccountKind"]; + /** @description Account balance before transaction in cents */ + balance_before: number; + /** @description Account balance after transaction in cents */ + balance_after: number; + /** @description Additional transaction-specific details */ + metadata: + | { + /** @enum {string} */ + type: "buy"; + /** @description Requirements specified for the buy order */ + instance_type_requirements: { + /** @description List of allowed accelerator types. */ + accelerator_types?: ("H100" | "H200")[]; + /** @description List of allowed interconnect types. */ + interconnect_types?: ("Infiniband" | "None")[]; + /** @description List of allowed regions. */ + regions?: ( + | "NorthAmerica" + | "AsiaPacific" + | "EuropeMiddleEastAfrica" + )[]; + /** + * @description Delivery method. + * @enum {string} + */ + delivery_type: "K8s" | "VM"; + }; + /** @description Quantity requested in the buy order, in number of nodes (8 gpus) */ + quantity: number; + /** + * Format: date-time + * @description The buy orders requested start time of the compute + */ + start_time: string; + /** + * Format: date-time + * @description The buy orders requested end time of compute + */ + end_time: string; + /** @description An external ID with prefix and alphanumeric string with underscores */ + order_id: string; + } + | { + /** @enum {string} */ + type: "sell"; + /** @description Quantity that was requested to sell, In number of nodes (8 gpus) */ + quantity: number; + /** + * Format: date-time + * @description The orders requested start time of the compute to sell + */ + start_time: string; + /** + * Format: date-time + * @description The orders requested end time of compute to sell + */ + end_time: string; + /** @description The sell order that was executed. */ + order_id: string; + } + | { + /** @enum {string} */ + type: "transfer"; + } + | { + /** @enum {string} */ + type: "error"; + /** @description Best effort type of the transaction without additional metadata, but may be 'unknown' */ + inner_type: string; + /** @description message of what went wrong */ + message?: unknown; + } + | { + /** @enum {string} */ + type: "instant_deposit"; + /** + * Format: date-time + * @description The time the bank involved marked marked this transaction as completed. + */ + completed_at: string; + /** + * @description The last 4 digits of the card that was used to perform the payment. + * @example 7302 + * @example 1038 + */ + card_last4: string; + /** + * @description Brand of card used for payment. + * @example visa + * @example mastercard + */ + card_brand: string; + /** + * @description The funding type of the card. + * @example credit + * @example debit + */ + card_funding: string; + /** + * Format: uri + * @description URL for the receipt if available. + * @example https://dashboard.stripe.com/receipts/payment/... + */ + receipt_url?: string; + } + | { + /** @enum {string} */ + type: "deposit_ach"; + /** + * Format: date-time + * @description The date the bank withdrawal was initiated. + */ + date_initiated: string; + /** + * Format: date-time + * @description The date the bank withdrawal was cancelled, if it was cancelled. + */ + date_cancelled: string | null; + /** + * Format: date-time + * @description The date the bank withdrawal settled by the bank, if it was cancelled. This will in most cases be close to the time SFC processed the transaction. + */ + date_settled: string | null; + /** + * @description A short description of the account. + * @example TOTAL CHECKING (checking) + */ + account_description: string; + /** + * @description The last 4 digits of the bank account number. + * @example 4902 + * @example 2038 + */ + bank_account_last4: string; + } + | { + /** @enum {string} */ + type: "withdrawal_bank"; + /** + * Format: date-time + * @description The date this bank withdrawal was approved. + */ + approved_at: string; + /** + * @description A short description of the account. + * @example TOTAL CHECKING (checking) + */ + account_description: string; + /** + * @description The last 4 digits of the bank account number. + * @example 4902 + * @example 2038 + */ + bank_account_last4: string; + } + | { + /** @enum {string} */ + type: "refund"; + /** + * Format: date-time + * @description Start time of experienced downtime. + */ + start_time: string; + /** + * Format: date-time + * @description End time of experienced downtime. + */ + end_time: string; + /** @description In number of nodes (8 gpus) affected during this period. */ + quantity: number; + /** @description The index rate per GPU, in cents, used to calculate the refund amount. */ + refund_cents_per_gpu_hour: number; + /** @description Downtime report ID that resulted in this refund being issued. */ + report_id: string; + /** + * Format: date-time + * @description The time at which SFC approved the refund. + */ + issue_date: string; + } + | { + /** @enum {string} */ + type: "admin_ledger_transfer"; + } + | { + /** @enum {string} */ + type: "fulfillment_escrow_release"; + } + | { + /** @enum {string} */ + type: "promotional_credit"; + } + | { + /** @enum {string} */ + type: "delivery_fees_collected"; + }; + }; + /** + * @description List of transactions for an account + * @example { + * "object": "transactions", + * "transactions": [ + * { + * "id": "tx_1234567890-4", + * "timestamp": "2024-03-15T00:30:00.000Z", + * "direction": "outgoing", + * "status": "accepted", + * "amount": 5000, + * "account_kind": "primary", + * "balance_before": 70000, + * "balance_after": 65000, + * "metadata": { + * "type": "buy", + * "start_time": "2024-11-05T07:24:24.207Z", + * "end_time": "2024-11-05T09:24:24.207Z", + * "quantity": 2, + * "order_id": "ordr_34Az95N", + * "instance_type_requirements": { + * "accelerator_types": [ + * "H100" + * ], + * "interconnect_types": [ + * "Infiniband" + * ], + * "regions": [ + * "NorthAmerica" + * ], + * "delivery_type": "K8s" + * } + * } + * } + * ], + * "pagination": { + * "has_more": true, + * "count": 1, + * "oldest_timestamp": "2024-03-15T00:30:00.000Z", + * "newest_timestamp": "2024-03-15T00:30:00.000Z" + * } + * } + */ + San_Francisco_Compute_Documentation_AccountTransactions: { + /** + * @description The type of the response object + * @example transactions + * @enum {string} + */ + object: "transactions"; + /** @description Transactions for all accounts (see account kind) associated with this user. */ + transactions: components["schemas"]["San_Francisco_Compute_Documentation_Transaction"][]; + /** @description Pagination information */ + pagination: { + /** + * @description Whether there are more transactions available + * @example true + */ + has_more: boolean; + /** + * @description Number of transactions returned + * @example 20 + */ + count: number; + /** + * Format: date-time + * @description Timestamp of the oldest transaction returned, useful for pagination + * @example 2024-03-15T00:30:00.000Z + */ + oldest_timestamp: string | null; + /** + * Format: date-time + * @description Timestamp of the newest transaction returned, useful for pagination + * @example 2024-03-15T00:30:00.000Z + */ + newest_timestamp: string | null; + }; + }; + vmorch_GetInstancesResponse: { + data: components["schemas"]["vmorch_VmInstance"][]; + }; + vmorch_GetSshResponse: { + ssh_hostname: string; + /** Format: u-int16 */ + ssh_port: number; + ssh_host_keys?: components["schemas"]["vmorch_SshHostKeyInfo"][] | null; + last_successful_key_update?: + | null + | components["schemas"]["vmorch_UnixEpoch"]; + last_attempted_key_update?: + | null + | components["schemas"]["vmorch_UnixEpoch"]; + }; + vmorch_GetUserDataResponse: { + script: components["schemas"]["vmorch_UserData"]; + }; + vmorch_PostReplaceRequest: { + vm_id: string; + }; + vmorch_PostReplaceResponse: { + replaced: string; + replaced_by: string; + }; + vmorch_PostUserDataRequest: { + script: components["schemas"]["vmorch_UserData"]; + }; + vmorch_PostUserDataResponse: { + script: components["schemas"]["vmorch_UserData"]; + }; + vmorch_SshHostKeyInfo: { + key_type: string; + /** Format: byte */ + base64_encoded_key: string; + }; + /** + * Format: int64 + * @description Unix timestamp. + * @example 1738972800 + */ + vmorch_UnixEpoch: number; + /** @description if the script is valid utf8 then the response may be in either string, or byte form and the client must handle both */ + vmorch_UserData: string | number[]; + vmorch_VmInstance: { + id: string; + cluster_id: string; + current_status: string; + last_updated_at: string; + }; + vmorch_VmsLogChunk: { + instance_id: string; + /** @description In RFC 3339 format */ + realtime_timestamp: string; + /** Format: u-int64 */ + monotonic_timestamp_sec: number; + /** Format: u-int32 */ + monotonic_timestamp_nano_sec: number; + /** Format: u-int64 */ + seqnum: number; + data: number[]; + }; + vmorch_VmsLogsResponse: { + data: components["schemas"]["vmorch_VmsLogChunk"][]; + }; + /** @enum {string} */ + "node-api_AcceleratorType": "H100" | "H200"; + "node-api_AvailabilityRectangle": { + start_timestamp: components["schemas"]["node-api_UnixEpoch"]; + end_timestamp: components["schemas"]["node-api_UnixEpoch"]; + /** + * Format: u-int64 + * @description The number of nodes available during this time period + */ + quantity: number; + }; + "node-api_BadRequestError": { + error: { + /** @enum {string} */ + type: "invalid_request_error"; + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + }; + }; + "node-api_ConflictError": { + error: { + /** @enum {string} */ + type: "conflict"; + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + }; + }; + "node-api_CreateNodesRequest": { + /** + * Format: u-int32 + * @example 1 + */ + desired_count: number; + /** + * @description Zone to create the nodes in. Required for auto reserved nodes if any_zone is false. + * @example hayesvalley + */ + zone?: string; + /** + * @description Allow auto reserved nodes to be created in any zone that meets the requirements + * @default false + * @example false + */ + any_zone: boolean; + /** + * Format: int64 + * @description Max price per hour for a node in cents + * @example 1600 + */ + max_price_per_node_hour: number; + /** + * Format: int64 + * @description Start time as Unix timestamp in seconds + * Optional for reserved nodes. If not provided, defaults to now + * @example 1640995200 + */ + start_at?: number; + /** + * Format: int64 + * @description End time as Unix timestamp in seconds + * If provided, end time must be aligned to the hour + * If not provided, the node will be created as an autoreserved node + */ + end_at?: number | null; + /** @default autoreserved */ + node_type: null | components["schemas"]["node-api_NodeType"]; + /** + * @description Custom node names + * Names cannot begin with 'vm_' or 'n_' as this is reserved for system-generated IDs + * Names cannot be numeric strings + * Names cannot exceed 256 characters + * @example [ + * "cuda-crunch" + * ] + */ + names?: string[]; + /** + * Format: byte + * @description User script to be executed during the VM's boot process + * Data should be base64 encoded + * @example aGVsbG8gd29ybGQ= + */ + cloud_init_user_data?: string; + /** + * @description Custom image ID to use for the VM instances + * @example image_1234567890abcdef + */ + image_id?: string; + /** + * @description (Optional) If set, enables forwarding to the VM on port 443. + * @default false + * @example false + */ + forward_443: boolean; + /** + * @description **Experimental — subject to change or removal without notice.** + * Enables InfiniBand. Requires hardware in the chosen zone that + * supports InfiniBand. + * @default false + * @example false + */ + _preview_enable_infiniband: boolean; + }; + /** @enum {string} */ + "node-api_DeliveryType": "K8s" | "VM"; + "node-api_ErrorContent": { + type: components["schemas"]["node-api_ErrorType"]; + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + }; + "node-api_ErrorDetail": { + /** @description The field that caused the error (for validation errors) */ + field?: string | null; + /** @description Specific error code for this detail */ + code: string; + /** @description Human-readable error message */ + message: string; + }; + "node-api_ErrorKind": + | { + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + /** @enum {string} */ + type: "api_error"; + } + | { + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + /** @enum {string} */ + type: "invalid_request_error"; + } + | { + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + /** @enum {string} */ + type: "authentication_error"; + } + | { + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + /** @enum {string} */ + type: "idempotency_error"; + } + | { + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + /** @enum {string} */ + type: "conflict"; + } + | { + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + /** @enum {string} */ + type: "not_found"; + } + | { + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + /** @enum {string} */ + type: "request_timed_out"; + } + | { + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + /** @enum {string} */ + type: "forbidden"; + } + | { + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + /** @enum {string} */ + type: "not_implemented"; + } + | { + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + /** @enum {string} */ + type: "upgrade_required"; + } + | { + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + /** @enum {string} */ + type: "payment_required"; + }; + /** @enum {string} */ + "node-api_ErrorType": + | "api_error" + | "invalid_request_error" + | "authentication_error" + | "idempotency_error" + | "conflict" + | "not_found" + | "request_timed_out" + | "forbidden" + | "not_implemented" + | "upgrade_required" + | "payment_required" + | "service_unavailable" + | "unprocessable_entity" + | "gone"; + "node-api_ExtendNodeRequest": { + /** + * Format: int64 + * @description Duration in seconds to extend the node + * Must be at least 1 hour (3600 seconds) and a multiple of 1 hour. + * @example 7200 + */ + duration_seconds: number; + /** + * Format: int64 + * @description Max price per hour for the extension in cents + * @example 1000 + */ + max_price_per_node_hour: number; + }; + "node-api_ForbiddenError": { + error: { + /** @enum {string} */ + type: "forbidden"; + message: string; + }; + }; + /** @enum {string} */ + "node-api_InterconnectType": "Infiniband" | "None"; + "node-api_InternalServerError": { + error: { + /** @enum {string} */ + type: "api_error"; + message: string; + }; + }; + "node-api_ListResponse_Node": { + /** @example list */ + object: string; + data: { + /** @example node */ + object: string; + /** @example n_b1dc52505c6db142 */ + id: string; + /** @example cuda-crunch */ + name: string; + /** @example hayesvalley */ + zone?: string | null; + gpu_type: components["schemas"]["node-api_AcceleratorType"]; + /** @example sfcompute */ + owner: string; + status: components["schemas"]["node-api_Status"]; + /** + * Format: int64 + * @description Creation time as Unix timestamp in seconds + * @example 1640995200 + */ + created_at?: number | null; + /** + * Format: int64 + * @description Last updated time as Unix timestamp in seconds + * @example 1640995200 + */ + updated_at?: number | null; + /** + * Format: int64 + * @description Start time as Unix timestamp in seconds + * @example 1640995200 + */ + start_at?: number | null; + /** + * Format: int64 + * @description End time as Unix timestamp in seconds + * @example 1640995200 + */ + end_at?: number | null; + /** + * Format: int64 + * @description Deletion time as Unix timestamp in seconds + * @example 1640995200 + */ + deleted_at?: number | null; + /** @example proc_b1dc52505c6de142 */ + procurement_id?: string | null; + /** + * Format: int64 + * @description Max price per hour you're willing to pay for a node in cents + * @example 1000 + */ + max_price_per_node_hour?: number | null; + node_type: components["schemas"]["node-api_NodeType"]; + vms?: null | components["schemas"]["node-api_VmList"]; + current_vm?: null | components["schemas"]["node-api_Vm"]; + }[]; + }; + "node-api_ListResponse_ZoneInfo": { + /** @example list */ + object: string; + data: { + object: string; + name: string; + /** @description User-facing zone name (e.g., "Hayes Valley", "Land's End") */ + display_name?: string | null; + /** + * @description The available capacity on this cluster, in the + * shape of consecutive "availability rectangles". + */ + available_capacity: components["schemas"]["node-api_AvailabilityRectangle"][]; + region: components["schemas"]["node-api_Region"]; + hardware_type: components["schemas"]["node-api_AcceleratorType"]; + interconnect_type: components["schemas"]["node-api_InterconnectType"]; + delivery_type: components["schemas"]["node-api_DeliveryType"]; + }[]; + }; + "node-api_Node": { + /** @example node */ + object: string; + /** @example n_b1dc52505c6db142 */ + id: string; + /** @example cuda-crunch */ + name: string; + /** @example hayesvalley */ + zone?: string | null; + gpu_type: components["schemas"]["node-api_AcceleratorType"]; + /** @example sfcompute */ + owner: string; + status: components["schemas"]["node-api_Status"]; + /** + * Format: int64 + * @description Creation time as Unix timestamp in seconds + * @example 1640995200 + */ + created_at?: number | null; + /** + * Format: int64 + * @description Last updated time as Unix timestamp in seconds + * @example 1640995200 + */ + updated_at?: number | null; + /** + * Format: int64 + * @description Start time as Unix timestamp in seconds + * @example 1640995200 + */ + start_at?: number | null; + /** + * Format: int64 + * @description End time as Unix timestamp in seconds + * @example 1640995200 + */ + end_at?: number | null; + /** + * Format: int64 + * @description Deletion time as Unix timestamp in seconds + * @example 1640995200 + */ + deleted_at?: number | null; + /** @example proc_b1dc52505c6de142 */ + procurement_id?: string | null; + /** + * Format: int64 + * @description Max price per hour you're willing to pay for a node in cents + * @example 1000 + */ + max_price_per_node_hour?: number | null; + node_type: components["schemas"]["node-api_NodeType"]; + vms?: null | components["schemas"]["node-api_VmList"]; + current_vm?: null | components["schemas"]["node-api_Vm"]; + }; + /** @enum {string} */ + "node-api_NodeType": "autoreserved" | "reserved"; + "node-api_NotFoundError": { + error: { + /** @enum {string} */ + type: "not_found"; + message: string; + }; + }; + "node-api_NotImplementedError": { + error: { + /** @enum {string} */ + type: "not_implemented"; + message: string; + }; + }; + "node-api_PaymentRequiredError": { + error: { + /** @enum {string} */ + type: "payment_required"; + message: string; + }; + }; + "node-api_RedeployNodeRequest": { + /** + * @description Redeploy node with this VM image ID + * @example image_1234567890abcdef + */ + image_id?: string; + /** + * Format: byte + * @description Update the cloud init user data for VMs running on this node + * Data should be base64 encoded + * @example aGVsbG8gd29ybGQ= + */ + cloud_init_user_data?: string; + /** + * @description If false, then the new VM will inherit any configuration (like image_id, + * cloud_init_user_data) that is left empty in this request from the current VM. + * + * If true, then any configuration left empty will be set as empty in the new VM. + * E.g if cloud_init_user_data is left unset and override_empty is true, then the new VM will not + * have any cloud init user data. + * override_empty defaults to false. + * @default false + */ + override_empty: boolean; + }; + /** @enum {string} */ + "node-api_Region": + | "NorthAmerica" + | "AsiaPacific" + | "EuropeMiddleEastAfrica"; + "node-api_RequestTimedOutError": { + error: { + /** @enum {string} */ + type: "request_timed_out"; + message: string; + }; + }; + "node-api_ServiceUnavailableError": { + error: { + /** @enum {string} */ + type: "service_unavailable"; + message: string; + }; + }; + /** + * @description Node Status + * @enum {string} + */ + "node-api_Status": + | "pending" + | "awaitingcapacity" + | "running" + | "released" + | "terminated" + | "deleted" + | "failed" + | "unknown"; + "node-api_UnauthorizedError": { + error: { + /** @enum {string} */ + type: "authentication_error"; + message: string; + }; + }; + /** + * Format: int64 + * @description Unix timestamp. + * @example 1738972800 + */ + "node-api_UnixEpoch": number; + "node-api_UnprocessableEntityError": { + error: { + /** @enum {string} */ + type: "unprocessable_entity"; + message: string; + details?: components["schemas"]["node-api_ErrorDetail"][]; + }; + }; + "node-api_UpgradeRequiredError": { + error: { + /** @enum {string} */ + type: "upgrade_required"; + message: string; + }; + }; + "node-api_Vm": { + /** @example vm */ + object: string; + /** @example vm_myOZZXw4pfcp7H9DQOldd */ + id: string; + status: components["schemas"]["node-api_VmStatus"]; + /** + * Format: int64 + * @example 1640995200 + */ + created_at: number; + /** + * Format: int64 + * @example 1640995200 + */ + updated_at: number; + /** + * Format: int64 + * @example 1640995200 + */ + start_at: number | null; + /** + * Format: int64 + * @example 1640998200 + */ + end_at: number | null; + /** @example image_myOZZXw4pfcp7H9DQOldd */ + image_id?: string | null; + /** @example hayesvalley */ + zone: string; + }; + "node-api_VmList": { + /** @example list */ + object: string; + data: components["schemas"]["node-api_Vm"][]; + }; + /** @enum {string} */ + "node-api_VmStatus": + | "Pending" + | "Running" + | "Destroyed" + | "NodeFailure" + | "Unspecified"; + "node-api_ZoneInfo": { + object: string; + name: string; + /** @description User-facing zone name (e.g., "Hayes Valley", "Land's End") */ + display_name?: string | null; + /** + * @description The available capacity on this cluster, in the + * shape of consecutive "availability rectangles". + */ + available_capacity: components["schemas"]["node-api_AvailabilityRectangle"][]; + region: components["schemas"]["node-api_Region"]; + hardware_type: components["schemas"]["node-api_AcceleratorType"]; + interconnect_type: components["schemas"]["node-api_InterconnectType"]; + delivery_type: components["schemas"]["node-api_DeliveryType"]; + }; + /** @description Response body for the account/me endpoint. */ + "market-api_AccountMeResponse": { + /** + * @description The unique identifier for the account + * @example gmail-com-name + */ + id: string; + /** + * @description The role assigned to this account + * @example user + */ + role: string; + /** + * @description Whether the account is currently frozen + * @example false + */ + is_frozen: boolean; + /** + * @description The KYC (Know Your Customer) verification level + * @example basic + */ + kyc: string; + /** + * @description Whether the user has submitted the waitlist form + * @example true + */ + submitted_waitlist: boolean; + /** + * @description Whether the user is on the waitlist + * @example false + */ + waitlist: boolean; + /** + * @description Whether the KYC-B form has been submitted + * @example false + */ + kycb_form_submitted: boolean; + /** + * Format: u-int64 + * @description When the account was created as a epoch unix timestamp + * @example 1749704176 + */ + created_at: number; + }; + "market-api_AddressPayload": { + country: string; + postal_code?: string | null; + state?: string | null; + city?: string | null; + line1?: string | null; + line2?: string | null; + }; + /** @description API-facing actor type that redacts internal system identifiers. */ + "market-api_ApiActor": + | { + id: string; + /** @enum {string} */ + type: "token"; + } + | { + /** @enum {string} */ + type: "system"; + }; + "market-api_BadRequestError": { + error: { + /** @enum {string} */ + type: "invalid_request_error"; + message: string; + details?: components["schemas"]["market-api_ErrorDetail"][]; + }; + }; + "market-api_CalculateInvoicePricingRequest": { + invoice_id: string; + payment_method_type: string; + /** Format: int64 */ + credit_amount_cents?: number | null; + address?: null | components["schemas"]["market-api_AddressPayload"]; + /** @default false */ + should_update_customer_address: boolean; + }; + "market-api_CalculateInvoicePricingResponse": { + /** + * @example pricing + * @enum {string} + */ + object: "pricing"; + /** Format: int64 */ + credit_amount_cents: number; + /** Format: int64 */ + platform_fee_cents: number; + /** Format: int64 */ + actual_fee_cents: number; + /** Format: int64 */ + adjustment_cents: number; + /** Format: int64 */ + subtotal_cents: number; + /** Format: int64 */ + tax_cents: number; + /** Format: int64 */ + total_with_tax_cents: number; + payment_method_type: string; + updated: boolean; + }; + "market-api_CancelOrderResponse": { + object: components["schemas"]["market-api_CancelOrderStatus"]; + }; + /** @enum {string} */ + "market-api_CancelOrderStatus": "pending"; + /** @example clus_k3R-nX9vLm7Qp2Yw5Jd8F */ + "market-api_ClusterId": string; + "market-api_ColocationStrategy": + | { + /** @enum {string} */ + type: "anywhere"; + } + | { + /** @enum {string} */ + type: "colocate"; + } + | { + /** @enum {string} */ + type: "colocate-pinned"; + } + | { + cluster_name: components["schemas"]["market-api_ZoneName"]; + /** @enum {string} */ + type: "pinned"; + }; + "market-api_ConflictError": { + error: { + /** @enum {string} */ + type: "conflict"; + message: string; + details?: components["schemas"]["market-api_ErrorDetail"][]; + }; + }; + "market-api_Context": { + workspace?: string | null; + zone?: string | null; + }; + /** @example cont_k3R-nX9vLm7Qp2Yw5Jd8F */ + "market-api_ContractId": string; + "market-api_ContractResponse": { + /** + * @example contract + * @enum {string} + */ + object: "contract"; + status: components["schemas"]["market-api_ContractStatus"]; + id: components["schemas"]["market-api_ContractId"]; + created_at: components["schemas"]["market-api_ISO8601DateTime"]; + instance_type: components["schemas"]["market-api_Ticker"]; + shape: components["schemas"]["market-api_ExternalShape"]; + /** @deprecated */ + colocate_with?: components["schemas"]["market-api_ContractId"][]; + cluster_id?: null | components["schemas"]["market-api_ClusterId"]; + zone?: null | components["schemas"]["market-api_ZoneName"]; + state: components["schemas"]["market-api_ContractState"]; + /** + * @description Specifies whether this contract is managed by the Nodes API + * @example true + */ + is_node: boolean; + /** + * @description The procurement which ordered this contract, if any + * @example proc_1234567890abcdef + */ + procurement_id?: string | null; + }; + /** @enum {string} */ + "market-api_ContractState": "Upcoming" | "Active" | "Expired"; + /** @enum {string} */ + "market-api_ContractStatus": "active" | "pending"; + "market-api_CreateDraftInvoiceRequest": { + /** Format: int64 */ + credit_amount_cents: number; + idempotency_key: string; + }; + "market-api_CreateDraftInvoiceResponse": { + /** + * @example invoice_draft + * @enum {string} + */ + object: "invoice_draft"; + invoice_id: string; + }; + "market-api_CreateOrderRequest": { + /** @description Order side: "buy" or "sell" */ + side: components["schemas"]["market-api_Side"]; + instance_type?: null | components["schemas"]["market-api_Ticker"]; + /** + * Format: int32 + * @example 10 + */ + quantity: number; + start_at: components["schemas"]["market-api_NowOrISO8601DateTime"]; + end_at: components["schemas"]["market-api_NowOrISO8601DateTime"]; + /** + * Format: int64 + * @description Price in cents + * @example 1600 + */ + price: number; + flags?: components["schemas"]["market-api_OrderFlags"]; + /** @description A contract to colocate with. This overrides the instance_type if specified. */ + colocate_with?: components["schemas"]["market-api_ContractId"][]; + cluster?: null | components["schemas"]["market-api_ZoneName"]; + }; + /** + * @example { + * "object": "order", + * "status": "pending", + * "id": "order_xyz789", + * "idempotency_key": "key_123" + * } + */ + "market-api_CreateOrderResponse": { + /** + * @example order + * @enum {string} + */ + object: "order"; + status: components["schemas"]["market-api_CreateOrderStatus"]; + id: components["schemas"]["market-api_OrderId"]; + /** @example key_123 */ + idempotency_key?: string | null; + }; + /** @enum {string} */ + "market-api_CreateOrderStatus": "pending" | "filled" | "cancelled"; + "market-api_CreateProcurementRequest": { + /** @description Procurement status (active or disabled) */ + status?: components["schemas"]["market-api_ProcurementStatus"]; + /** @description Instance type to procure */ + instance_type: components["schemas"]["market-api_Ticker"]; + /** + * Format: int32 + * @description Desired quantity of nodes + * @example 5 + */ + desired_quantity: number; + /** + * Format: int32 + * @description Maximum price per GPU hour in cents + * @example 250 + */ + buy_limit_price_per_gpu_hour?: number; + /** + * Format: int32 + * @description Minimum price per GPU hour in cents when selling back + * @example 25 + */ + sell_limit_price_per_gpu_hour?: number; + /** + * Format: int32 + * @description Planning horizon in minutes + * @example 60 + */ + horizon?: number; + /** @description Colocation strategy for the procurement */ + colocation_strategy?: components["schemas"]["market-api_ColocationStrategy"]; + }; + "market-api_ErrorDetail": { + /** @description The field that caused the error (for validation errors) */ + field?: string | null; + /** @description Specific error code for this detail */ + code: string; + /** @description Human-readable error message */ + message: string; + }; + /** @enum {string} */ + "market-api_ErrorType": + | "api_error" + | "invalid_request_error" + | "authentication_error" + | "idempotency_error" + | "conflict" + | "not_found" + | "request_timed_out" + | "forbidden" + | "not_implemented" + | "upgrade_required" + | "payment_required" + | "service_unavailable" + | "unprocessable_entity" + | "gone"; + "market-api_EventResponse": { + /** + * @example event + * @enum {string} + */ + object: "event"; + id: string; + cursor: components["schemas"]["market-api_EventsCursor"]; + action: string; + /** Format: int64 */ + occurred_at: number; + actor: components["schemas"]["market-api_ApiActor"]; + targets: components["schemas"]["market-api_Target"][]; + context: components["schemas"]["market-api_Context"]; + }; + /** @example evtc_gqXR7s0Kj5mHvE2wNpLc4Q */ + "market-api_EventsCursor": string; + /** + * @description A schedule representing a change of a quantity over time. The schedule changes at + * intervals[i] to quantity[i]. Intervals are sorted from first to last change. + */ + "market-api_ExternalShape": { + /** @description The times at which changes in quantity occur */ + intervals: components["schemas"]["market-api_ISO8601DateTime"][]; + /** @description The quantity changed to at that time */ + quantities: number[]; + }; + "market-api_FinalizeInvoiceRequest": { + invoice_id: string; + }; + "market-api_FinalizeInvoiceResponse": { + /** + * @example payment + * @enum {string} + */ + object: "payment"; + success: boolean; + invoice_id: string; + payment_intent_id: string; + client_secret: string; + status: string; + /** @description Stripe-hosted payment page URL for this invoice */ + hosted_invoice_url?: string | null; + }; + "market-api_ForbiddenError": { + error: { + /** @enum {string} */ + type: "forbidden"; + message: string; + }; + }; + "market-api_GetBalanceResponse": { + /** + * @example balances + * @enum {string} + */ + object: "balances"; + /** Format: u-int64 */ + available_balance_cents: number; + /** Format: u-int64 */ + current_balance_cents: number; + /** Format: u-int64 */ + current_overage_cents: number; + /** Format: u-int64 */ + overage_limit_cents: number; + /** Format: int64 */ + updated_at: number; + }; + /** @description string with format 'txc_base62_encoded_id' used for paginating a query to GET /v1/transactions */ + "market-api_GetTransactionsCursor": string; + "market-api_GoneError": { + error: { + /** @enum {string} */ + type: "gone"; + message: string; + }; + }; + /** + * Format: date-time + * @description An ISO 8601 datetime string + * @example 2025-07-11T20:41:37.423Z + */ + "market-api_ISO8601DateTime": string; + "market-api_InternalServerError": { + error: { + /** @enum {string} */ + type: "api_error"; + message: string; + }; + }; + "market-api_KubernetesClusterResponse": { + /** + * @example kubernetes_cluster + * @enum {string} + */ + object: "kubernetes_cluster"; + /** @example https://cluster.example.com */ + kubernetes_api_url?: string | null; + name: components["schemas"]["market-api_ZoneName"]; + /** @example sf-user123 */ + kubernetes_namespace: string; + /** @example -----BEGIN CERTIFICATE-----... */ + kubernetes_ca_cert?: string | null; + contract?: null | components["schemas"]["market-api_ContractResponse"]; + }; + "market-api_ListClustersResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + data: components["schemas"]["market-api_KubernetesClusterResponse"][]; + has_more: boolean; + }; + "market-api_ListContractsResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + data: components["schemas"]["market-api_ContractResponse"][]; + has_more: boolean; + }; + "market-api_ListEventsResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + data: components["schemas"]["market-api_EventResponse"][]; + has_more: boolean; + cursor?: null | components["schemas"]["market-api_EventsCursor"]; + }; + "market-api_ListOrdersResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + data: components["schemas"]["market-api_OrderResponse"][]; + has_more: boolean; + }; + "market-api_ListProcurementsResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + data: components["schemas"]["market-api_ProcurementResponse"][]; + has_more: boolean; + }; + "market-api_ListTransactionsResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + has_more: boolean; + data: components["schemas"]["market-api_TransactionResponse"][]; + }; + /** + * @description Request body for migrating an account to the new billing system. + * @example { + * "type": "withdraw", + * "column_counterparty_id": "cpty_2n4f8bxg3qj5p6r7s9t1v" + * } + */ + "market-api_MigrateAccountRequest": + | { + /** + * @description The identifier for your external bank account where funds will be transferred + * @example cpty_2n4f8bxg3qj5p6r7s9t1v + */ + column_counterparty_id: string; + /** @enum {string} */ + type: "withdraw"; + } + | { + /** @enum {string} */ + type: "convert_to_credits"; + }; + /** + * @description Response body for account migration requests. + * @example { + * "status": "migrated" + * } + * @enum {string} + */ + "market-api_MigrateAccountResponse": + | "migrated" + | "requires_manual_migration"; + "market-api_NodeIdEntry": { + current_status: string; + product_uuid?: string | null; + internal_ipv4?: string | null; + source?: null | components["schemas"]["market-api_NodeSource"]; + }; + "market-api_NodeIdResponse": { + /** Format: u-int32 */ + count: number; + /** Format: date-time */ + request_timestamp: string; + data: components["schemas"]["market-api_NodeIdEntry"][]; + }; + /** @enum {string} */ + "market-api_NodeSource": "vm"; + "market-api_NotFoundError": { + error: { + /** @enum {string} */ + type: "not_found"; + message: string; + }; + }; + "market-api_NotImplementedError": { + error: { + /** @enum {string} */ + type: "not_implemented"; + message: string; + }; + }; + /** + * @description A date/time value that can be either "NOW" or an ISO 8601 datetime string + * @example NOW + * @example 2025-07-11T20:41:37.423Z + */ + "market-api_NowOrISO8601DateTime": string; + /** @description Configure more fine grained order behavior. */ + "market-api_OrderFlags": { + /** + * @description If true, the order will be automatically cancelled if it doesn't + * immediately fill when being placed. + */ + ioc?: boolean; + /** + * @description If true, places the order straight into the book without trying to match + * against existing orders. + */ + post_only?: boolean; + /** @description If true, ignores the set limit price and matches any price that is available. */ + market?: boolean; + /** + * @description If the order start time should be automatically changed to "now" once + * start time < "now", proportionally changing it's limit price to reflect + * it's shorter duration. + */ + prorate?: boolean; + }; + /** @example ordr_k3R-nX9vLm7Qp2Yw5Jd8F */ + "market-api_OrderId": string; + "market-api_OrderResponse": { + /** + * @example order + * @enum {string} + */ + object: "order"; + id: components["schemas"]["market-api_OrderId"]; + side: components["schemas"]["market-api_OrderSide"]; + status: components["schemas"]["market-api_OrderStatus"]; + instance_type: components["schemas"]["market-api_Ticker"]; + /** + * Format: int32 + * @example 4 + */ + quantity: number; + start_at: components["schemas"]["market-api_ISO8601DateTime"]; + end_at: components["schemas"]["market-api_ISO8601DateTime"]; + /** + * Format: int64 + * @description Price in cents + * @example 2850000 + */ + price: number; + flags: components["schemas"]["market-api_OrderFlags"]; + executed: boolean; + executed_at?: null | components["schemas"]["market-api_ISO8601DateTime"]; + /** Format: int64 */ + execution_price?: number | null; + cancelled: boolean; + cancelled_at?: null | components["schemas"]["market-api_ISO8601DateTime"]; + colocate_with?: components["schemas"]["market-api_ContractId"][]; + created_at: components["schemas"]["market-api_ISO8601DateTime"]; + rejected: boolean; + rejected_reason?: string | null; + cluster?: null | components["schemas"]["market-api_ZoneName"]; + duration: components["schemas"]["market-api_UnixEpoch"]; + }; + /** @enum {string} */ + "market-api_OrderSide": "buy" | "sell"; + /** @enum {string} */ + "market-api_OrderStatus": "open" | "filled" | "cancelled" | "rejected"; + "market-api_PaymentRequiredError": { + error: { + /** @enum {string} */ + type: "payment_required"; + message: string; + }; + }; + /** @enum {string} */ + "market-api_ProcurementMessage": "insufficient_balance" | "running"; + "market-api_ProcurementResponse": { + /** + * @example procurement + * @enum {string} + */ + object: "procurement"; + /** @example proc_W9TRG */ + id: string; + instance_type: components["schemas"]["market-api_Ticker"]; + status: components["schemas"]["market-api_ProcurementStatus"]; + /** + * Format: int32 + * @example 1 + */ + desired_quantity: number; + /** + * Format: int32 + * @example 250 + */ + buy_limit_price_per_gpu_hour: number; + /** + * Format: int32 + * @example 25 + */ + sell_limit_price_per_gpu_hour: number; + /** + * Format: int32 + * @example 60 + */ + horizon: number; + colocation_strategy: components["schemas"]["market-api_ColocationStrategy"]; + last_message: components["schemas"]["market-api_ProcurementMessage"]; + }; + /** @enum {string} */ + "market-api_ProcurementStatus": "active" | "disabled"; + "market-api_ProviderOrderResource": { + /** + * @example provider_order + * @enum {string} + */ + object: "provider_order"; + cursor: components["schemas"]["market-api_ProviderOrdersCursor"]; + id: string; + /** Format: date-time */ + start_time: string; + /** Format: date-time */ + end_time: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + executed_at?: string | null; + /** Format: date-time */ + cancelled_at?: string | null; + executed: boolean; + cancelled: boolean; + quantity: string; + duration_hours: string; + tcv: string; + executed_gpu_hour_price?: string | null; + market: string; + accelerator_type: string; + sender: string; + was_repriced?: boolean | null; + }; + /** @description Opaque cursor string with format 'poc_base62_encoded_data' used for paginating provider orders */ + "market-api_ProviderOrdersCursor": string; + "market-api_ProviderOrdersResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + data: components["schemas"]["market-api_ProviderOrderResource"][]; + summary: components["schemas"]["market-api_ProviderOrdersSummary"]; + has_more: boolean; + }; + "market-api_ProviderOrdersSummary": { + /** + * @example provider_orders_summary + * @enum {string} + */ + object: "provider_orders_summary"; + /** Format: int64 */ + total_revenue_cents: number; + total_revenue_usd: string; + order_count: number; + /** Format: double */ + average_gpu_hour_price_cents?: number | null; + average_gpu_hour_price_usd?: string | null; + /** Format: date-time */ + period_start: string; + /** Format: date-time */ + period_end: string; + /** Format: date-time */ + generated_at: string; + }; + "market-api_RequestTimedOutError": { + error: { + /** @enum {string} */ + type: "request_timed_out"; + message: string; + }; + }; + "market-api_ServiceUnavailableError": { + error: { + /** @enum {string} */ + type: "service_unavailable"; + message: string; + }; + }; + /** @enum {string} */ + "market-api_Side": "sell" | "buy"; + /** + * @description Sort field for listing orders + * @example created_at + * @example start_time + * @enum {string} + */ + "market-api_SortBy": "created_at" | "start_time"; + /** + * @description Sort direction for listing orders + * @example ASC + * @example DESC + * @enum {string} + */ + "market-api_SortDirection": "ASC" | "DESC"; + "market-api_Target": { + type: string; + id: string; + }; + /** + * @example h100i + * @example h100v + * @example h200ki + */ + "market-api_Ticker": string; + "market-api_TransactionDetails": + | { + /** + * @example transaction_details + * @enum {string} + */ + object: "transaction_details"; + card_last4: string; + card_brand: string; + card_funding: string; + receipt_url: string; + /** @enum {string} */ + type: "stripe_card_payment"; + } + | { + /** + * @example transaction_details + * @enum {string} + */ + object: "transaction_details"; + description: string; + /** @enum {string} */ + type: "manual_payment"; + } + | { + /** + * @example transaction_details + * @enum {string} + */ + object: "transaction_details"; + memo: string; + /** @enum {string} */ + type: "credit_grant"; + } + | { + /** + * @example transaction_details + * @enum {string} + */ + object: "transaction_details"; + /** @enum {string} */ + type: "refund"; + } + | { + /** + * @example transaction_details + * @enum {string} + */ + object: "transaction_details"; + order_id: components["schemas"]["market-api_OrderId"]; + order?: null | { /** - * Format: date-time - * @description The buy orders requested start time of the compute + * @example order + * @enum {string} */ - start_time: string; + object: "order"; + id: components["schemas"]["market-api_OrderId"]; + side: components["schemas"]["market-api_OrderSide"]; + status: components["schemas"]["market-api_OrderStatus"]; + instance_type: components["schemas"]["market-api_Ticker"]; /** - * Format: date-time - * @description The buy orders requested end time of compute + * Format: int32 + * @example 4 */ - end_time: string; - /** @description An external ID with prefix and alphanumeric string with underscores */ - order_id: string; - } - | { - /** @enum {string} */ - type: "sell"; - /** @description Quantity that was requested to sell, In number of nodes (8 gpus) */ quantity: number; + start_at: components["schemas"]["market-api_ISO8601DateTime"]; + end_at: components["schemas"]["market-api_ISO8601DateTime"]; /** - * Format: date-time - * @description The orders requested start time of the compute to sell - */ - start_time: string; - /** - * Format: date-time - * @description The orders requested end time of compute to sell - */ - end_time: string; - /** @description The sell order that was executed. */ - order_id: string; - } - | { - /** @enum {string} */ - type: "transfer"; - } - | { - /** @enum {string} */ - type: "error"; - /** @description Best effort type of the transaction without additional metadata, but may be 'unknown' */ - inner_type: string; - /** @description message of what went wrong */ - message?: unknown; - } - | { - /** @enum {string} */ - type: "instant_deposit"; - /** - * Format: date-time - * @description The time the bank involved marked marked this transaction as completed. - */ - completed_at: string; - /** - * @description The last 4 digits of the card that was used to perform the payment. - * @example 7302 - * @example 1038 - */ - card_last4: string; - /** - * @description Brand of card used for payment. - * @example visa - * @example mastercard - */ - card_brand: string; - /** - * @description The funding type of the card. - * @example credit - * @example debit - */ - card_funding: string; - /** - * Format: uri - * @description URL for the receipt if available. - * @example https://dashboard.stripe.com/receipts/payment/... - */ - receipt_url?: string; - } - | { - /** @enum {string} */ - type: "deposit_ach"; - /** - * Format: date-time - * @description The date the bank withdrawal was initiated. - */ - date_initiated: string; - /** - * Format: date-time - * @description The date the bank withdrawal was cancelled, if it was cancelled. - */ - date_cancelled: string | null; - /** - * Format: date-time - * @description The date the bank withdrawal settled by the bank, if it was cancelled. This will in most cases be close to the time SFC processed the transaction. - */ - date_settled: string | null; - /** - * @description A short description of the account. - * @example TOTAL CHECKING (checking) - */ - account_description: string; - /** - * @description The last 4 digits of the bank account number. - * @example 4902 - * @example 2038 - */ - bank_account_last4: string; - } - | { - /** @enum {string} */ - type: "withdrawal_bank"; - /** - * Format: date-time - * @description The date this bank withdrawal was approved. - */ - approved_at: string; - /** - * @description A short description of the account. - * @example TOTAL CHECKING (checking) - */ - account_description: string; - /** - * @description The last 4 digits of the bank account number. - * @example 4902 - * @example 2038 + * Format: int64 + * @description Price in cents + * @example 2850000 */ - bank_account_last4: string; - } - | { - /** @enum {string} */ - type: "refund"; + price: number; + flags: components["schemas"]["market-api_OrderFlags"]; + executed: boolean; + executed_at?: + | null + | components["schemas"]["market-api_ISO8601DateTime"]; + /** Format: int64 */ + execution_price?: number | null; + cancelled: boolean; + cancelled_at?: + | null + | components["schemas"]["market-api_ISO8601DateTime"]; + colocate_with?: components["schemas"]["market-api_ContractId"][]; + created_at: components["schemas"]["market-api_ISO8601DateTime"]; + rejected: boolean; + rejected_reason?: string | null; + cluster?: null | components["schemas"]["market-api_ZoneName"]; + duration: components["schemas"]["market-api_UnixEpoch"]; + }; + /** @enum {string} */ + type: "buy_order"; + } + | { + /** + * @example transaction_details + * @enum {string} + */ + object: "transaction_details"; + order_id: components["schemas"]["market-api_OrderId"]; + order?: null | { /** - * Format: date-time - * @description Start time of experienced downtime. + * @example order + * @enum {string} */ - start_time: string; + object: "order"; + id: components["schemas"]["market-api_OrderId"]; + side: components["schemas"]["market-api_OrderSide"]; + status: components["schemas"]["market-api_OrderStatus"]; + instance_type: components["schemas"]["market-api_Ticker"]; /** - * Format: date-time - * @description End time of experienced downtime. + * Format: int32 + * @example 4 */ - end_time: string; - /** @description In number of nodes (8 gpus) affected during this period. */ quantity: number; - /** @description The index rate per GPU, in cents, used to calculate the refund amount. */ - refund_cents_per_gpu_hour: number; - /** @description Downtime report ID that resulted in this refund being issued. */ - report_id: string; + start_at: components["schemas"]["market-api_ISO8601DateTime"]; + end_at: components["schemas"]["market-api_ISO8601DateTime"]; /** - * Format: date-time - * @description The time at which SFC approved the refund. + * Format: int64 + * @description Price in cents + * @example 2850000 */ - issue_date: string; - } - | { - /** @enum {string} */ - type: "admin_ledger_transfer"; - } - | { - /** @enum {string} */ - type: "fulfillment_escrow_release"; - } - | { - /** @enum {string} */ - type: "promotional_credit"; - } - | { - /** @enum {string} */ - type: "delivery_fees_collected"; + price: number; + flags: components["schemas"]["market-api_OrderFlags"]; + executed: boolean; + executed_at?: + | null + | components["schemas"]["market-api_ISO8601DateTime"]; + /** Format: int64 */ + execution_price?: number | null; + cancelled: boolean; + cancelled_at?: + | null + | components["schemas"]["market-api_ISO8601DateTime"]; + colocate_with?: components["schemas"]["market-api_ContractId"][]; + created_at: components["schemas"]["market-api_ISO8601DateTime"]; + rejected: boolean; + rejected_reason?: string | null; + cluster?: null | components["schemas"]["market-api_ZoneName"]; + duration: components["schemas"]["market-api_UnixEpoch"]; }; + /** @enum {string} */ + type: "sell_order"; + }; + "market-api_TransactionResponse": { + /** + * @example transaction + * @enum {string} + */ + object: "transaction"; + /** @description Opaque cursor for use in pagination */ + cursor: components["schemas"]["market-api_GetTransactionsCursor"]; + /** + * Format: int64 + * @description Time the transaction took place as UNIX timestamp in seconds. + * @example 1640995200 + */ + transaction_time: number; + /** + * Format: int64 + * @description Transaction amount in cents (e.g., 50000 = $500.00) + * @example 50000 + */ + amount_cents: number; + /** + * Format: int64 + * @description Balance immediately after this transaction took place, in cents (e.g., 50000 = $500.00). + */ + balance: number; + /** @description Transaction details */ + details: components["schemas"]["market-api_TransactionDetails"]; + }; + /** @enum {string} */ + "market-api_TransactionTypeFilter": + | "stripe_card_payment" + | "manual_payment" + | "credit_grant" + | "refund" + | "buy_order" + | "sell_order"; + "market-api_UnauthorizedError": { + error: { + /** @enum {string} */ + type: "authentication_error"; + message: string; + }; + }; + /** + * Format: int64 + * @description Unix timestamp. + * @example 1738972800 + */ + "market-api_UnixEpoch": number; + "market-api_UnprocessableEntityError": { + error: { + /** @enum {string} */ + type: "unprocessable_entity"; + message: string; + details?: components["schemas"]["market-api_ErrorDetail"][]; + }; + }; + "market-api_UpdateProcurementRequest": { + status?: null | components["schemas"]["market-api_ProcurementStatus"]; + instance_type?: null | components["schemas"]["market-api_Ticker"]; + /** + * Format: int32 + * @description Desired quantity of nodes + * @example 5 + */ + desired_quantity?: number | null; + /** + * Format: int32 + * @description Maximum price per GPU hour in cents + * @example 350 + */ + buy_limit_price_per_gpu_hour?: number | null; + /** + * Format: int32 + * @description Minimum price per GPU hour in cents when selling back + * @example 50 + */ + sell_limit_price_per_gpu_hour?: number | null; + /** + * Format: int32 + * @description Planning horizon in minutes. The procurement will try to buy compute + * ahead of time as to always have at least this amount of time ahead + * scheduled at a minimum. + * @example 120 + */ + horizon?: number | null; + }; + "market-api_UpgradeRequiredError": { + error: { + /** @enum {string} */ + type: "upgrade_required"; + message: string; + }; + }; + /** @example richmond */ + "market-api_ZoneName": string; + /** + * @description A map from resource to verbs. Serializes as e.g. + * `{ "node": ["read", "write"], "capacity": ["*"] }`. + * + * Uses `BTreeMap` for deterministic key ordering. + */ + "sfc-api_ActionsMap": { + [key: string]: components["schemas"]["sfc-api_Verb"][]; + }; + "sfc-api_AdminCreateInvoiceRequest": { + /** Format: int64 */ + credit_amount_cents: number; + /** @description Required for `rail=stripe`; Mercury resolves the email from Clerk. */ + customer_email?: string | null; + memo?: string | null; + /** Format: int32 */ + days_until_due?: number | null; + /** @description Invoice rail. `stripe` (default) or `mercury`. */ + rail?: components["schemas"]["sfc-api_InvoiceRail"]; + /** @description Required for `rail=stripe`. Accepted values: `card`, `ach`. */ + payment_method_type?: string | null; + /** @description Required for both rails. */ + idempotency_key?: string | null; + }; + "sfc-api_AdminCreateInvoiceResponse": { + /** + * @example invoice + * @enum {string} + */ + object: "invoice"; + rail: components["schemas"]["sfc-api_InvoiceRail"]; + /** @description Set for `rail=stripe`. */ + stripe_invoice_id?: string | null; + /** @description Set for `rail=mercury`. */ + mercury_invoice_id?: string | null; + /** @description Local `invoices.id`. Set for `rail=mercury`. */ + invoice_id?: string | null; + hosted_invoice_url?: string | null; + /** Format: int64 */ + credit_amount_cents: number; + /** Format: int64 */ + platform_fee_cents: number; + /** Format: int64 */ + actual_fee_cents: number; + /** Format: int64 */ + adjustment_cents: number; + /** Format: int64 */ + subtotal_cents: number; + /** Format: int64 */ + total_cents: number; + payment_method_type: string; + }; + "sfc-api_AdminInstanceSku": { + /** + * @description Single discriminator for the instance-SKU object on both admin and + * public endpoints. They expose different field shapes but represent + * the same underlying resource (mirrors Stripe's pattern of one + * `object` discriminator per resource type, regardless of view). + * @example instance_sku + * @enum {string} + */ + object: "instance_sku"; + id: components["schemas"]["sfc-api_InstanceSkuId"]; + name?: null | components["schemas"]["sfc-api_Name"]; + properties: components["schemas"]["sfc-api_AdminInstanceSkuProperty"][]; + /** + * @description Total compute scheduled to be available for this SKU — the sum of + * every live contract's shape filtered by `cluster_id`. This is the + * "open interest" of the SKU's trading pool: how much capacity is in + * flight at any time, regardless of which capacity, owner, or + * procurement booked it. Honors `schedule_history_minutes` to include + * recent past schedule. + */ + total_scheduled_supply: components["schemas"]["sfc-api_Schedule"]; + }; + /** @description Admin view of an enumeration value. */ + "sfc-api_AdminInstanceSkuEnumerationValue": { + /** @description Parent property key this value belongs to. */ + key: components["schemas"]["sfc-api_Name"]; + name: components["schemas"]["sfc-api_Name"]; + display_name: string; + description: string; + documentation_link?: string | null; + stable_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + deprecated_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + deprecation_info?: string | null; + deleted_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + updated_at: components["schemas"]["sfc-api_UnixEpoch"]; + internal_note?: string | null; + }; + /** + * @description A property set on an instance SKU, admin view. Tagged to match the + * public [`InstanceSkuProperty`][crate::v2_routes::instance_skus::InstanceSkuProperty] + * shape, with extra variants for keys/values that aren't fully + * registered (admins see everything, customers only see fully + * registered properties). + */ + "sfc-api_AdminInstanceSkuProperty": + | { + key: components["schemas"]["sfc-api_AdminInstanceSkuPropertyKey"]; + value: components["schemas"]["sfc-api_AdminInstanceSkuEnumerationValue"]; + /** @enum {string} */ + type: "enumeration"; + } + | { + key: components["schemas"]["sfc-api_AdminInstanceSkuPropertyKey"]; + value: components["schemas"]["sfc-api_Name"]; + /** @enum {string} */ + type: "unregistered_enumeration_value"; + } + | { + key: string; + value: string; + /** @enum {string} */ + type: "unregistered"; + }; + /** + * @description Admin view of a property key. Same shape as the public + * [`InstanceSkuPropertyKey`][crate::v2_routes::instance_skus::InstanceSkuPropertyKey] + * with extra fields admins need to manage the registry lifecycle. + */ + "sfc-api_AdminInstanceSkuPropertyKey": { + name: components["schemas"]["sfc-api_Name"]; + display_name: string; + description: string; + documentation_link?: string | null; + required: boolean; + stable_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + deprecated_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + deprecation_info?: string | null; + deleted_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + updated_at: components["schemas"]["sfc-api_UnixEpoch"]; + internal_note?: string | null; + }; + /** + * @description Property key plus a live coverage snapshot. Returned by the + * `keys::*` endpoints. When a key is embedded inside an + * `AdminInstanceSkuProperty` we use the bare + * [`AdminInstanceSkuPropertyKey`] instead — coverage would be + * expensive and irrelevant in that context. + */ + "sfc-api_AdminInstanceSkuPropertyKeyDetail": { + key: components["schemas"]["sfc-api_AdminInstanceSkuPropertyKey"]; + coverage: components["schemas"]["sfc-api_PropertyKeyCoverage"]; + }; + /** @example aispkc_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_AdminInstanceSkuPropertyKeysCursor": string; + /** @example aispvc_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_AdminInstanceSkuPropertyValuesCursor": string; + /** @example aiskuc_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_AdminInstanceSkusCursor": string; + "sfc-api_AllocationSchedule": { + /** + * @description Combined allocation schedule across all instance SKUs. Only includes + * current and future schedule. + */ + total: components["schemas"]["sfc-api_Schedule"]; + /** + * @description Allocation schedule keyed by instance SKU. Only includes current and + * future schedule. + */ + by_instance_sku: { + [key: string]: components["schemas"]["sfc-api_Schedule"]; + }; + }; + /** + * @description Validated API version string. Currently only `"roles/v1"` is accepted. + * @enum {string} + */ + "sfc-api_ApiVersion": "roles/v1"; + /** @enum {string} */ + "sfc-api_AutomationStatus": "info" | "warning" | "error"; + /** + * @description One row of `GET /v2/availability` — the SKUs that share the requested + * group key, with their summed and per-SKU allocation schedules. + */ + "sfc-api_AvailabilityGroup": { + /** + * @description Values of the `group_by` keys that define this group, in the same + * order as the request's `group_by`. Empty when no `group_by` was + * passed (single-aggregate case). Properties are projected with the + * same public-key/value rules as `GET /v2/instance_skus`. + */ + group: components["schemas"]["sfc-api_InstanceSkuProperty"][]; + /** + * @description `total` = sum of `available_for_purchase_shape` across every SKU in + * the group; `by_instance_sku` = each SKU's own shape, unsummed. + */ + allocation_schedule: components["schemas"]["sfc-api_AllocationSchedule"]; + }; + "sfc-api_BadRequestError": { + error: { + /** @enum {string} */ + type: "invalid_request_error"; + message: string; + details?: components["schemas"]["sfc-api_ErrorDetail"][]; + }; + }; + /** + * @description One entry in a [`BatchPatchInstancesRequest`]. The `id` selects which + * instance to update; `priority` is the only mutable field supported by + * the batch endpoint today — for name/tag changes use the singleton + * `PATCH /v2/instances/{id}`. A future revision may grow optional fields + * here (name, tags, etc.); existing entry shapes remain forward-compatible. + */ + "sfc-api_BatchPatchInstanceEntry": { + id: components["schemas"]["sfc-api_InstanceId"]; + /** + * Format: int64 + * @description Shutdown priority. Higher numbers are kept longer. + */ + priority: number; + }; + /** + * @description Request body for `PATCH /v2/instances` (batch). Each entry in `data` + * applies a partial patch to one instance; instances not mentioned are + * untouched. All entries must succeed or none — a single failure rolls + * back every other entry's writes (422). + * + * Duplicate `id` entries are not deduplicated by serde; the handler runs + * the patches in order, so the last write wins. + */ + "sfc-api_BatchPatchInstancesRequest": { + data: components["schemas"]["sfc-api_BatchPatchInstanceEntry"][]; + }; + /** + * @description Response shape for `PATCH /v2/instances` (batch). Mirrors the input list + * — one `InstanceResponse` per *unique* `id` in the request body, reflecting + * the post-write state. Unlike the paginated list response, there's no + * `cursor` or `has_more`: the response is exactly the instances the caller + * mentioned, no pagination involved. + */ + "sfc-api_BatchPatchInstancesResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + data: components["schemas"]["sfc-api_InstanceResponse"][]; + }; + /** @example capc_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_CapacitiesCursor": string; + /** @example cap_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_CapacityId": string; + /** + * @description Capacity kind determines what operations are allowed on a capacity. + * + * - `Market`: User-created capacities. + * - `Originating`: Provider capacities for selling compute. Cannot add compute + * (buy orders/procurements). + * - `ReadOnly`: System-managed capacities used for legacy compute, bare metal + * contracts, and other. Cannot be modified through the API. + * @enum {string} + */ + "sfc-api_CapacityKind": "market" | "originating" | "read_only"; + "sfc-api_CapacityResponse": components["schemas"]["sfc-api_CapacityScope"] & { + /** + * @example capacity + * @enum {string} + */ + object: "capacity"; + /** + * @description Allocation schedule of this capacity. Add to the schedule by placing buy + * orders into this capacity. + */ + allocation_schedule: components["schemas"]["sfc-api_AllocationSchedule"]; + /** @description Active procurements targeting this capacity. */ + procurements?: components["schemas"]["sfc-api_ProcurementSummary"][]; + /** @description Active deployments targeting this capacity. */ + deployments?: components["schemas"]["sfc-api_DeploymentSummary"][]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + tags?: null | components["schemas"]["sfc-api_Tags"]; + }; + "sfc-api_CapacityScope": { + id: components["schemas"]["sfc-api_CapacityId"]; + resource_path: components["schemas"]["sfc-api_capacityResourcePath_CapacityId"]; + owner: components["schemas"]["sfc-api_Name"]; + workspace: components["schemas"]["sfc-api_Name"]; + name: components["schemas"]["sfc-api_Name"]; + kind: components["schemas"]["sfc-api_CapacityKind"]; + }; + "sfc-api_CapacitySummary": { + id: components["schemas"]["sfc-api_CapacityId"]; + name: components["schemas"]["sfc-api_Name"]; + }; + /** @example cxfr_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_CapacityTransferId": string; + /** @enum {string} */ + "sfc-api_CapacityTransferStatus": "pending" | "executed" | "rejected"; + /** @example ctfrc_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_CapacityTransfersCursor": string; + "sfc-api_CheckPermissionRequest": { + workspace?: null | components["schemas"]["sfc-api_WorkspaceId"]; + /** + * @description One or more `"resource:verb"` actions (e.g. `"node:read"`, + * `"order:write"`) to evaluate. The response is a single aggregated + * verdict across the whole list. + * @example [ + * "node:read", + * "order:write" + * ] + */ + actions: string[]; + }; + /** @description Complete a multipart image upload. */ + "sfc-api_CompleteUploadRequest": { + /** @description Not verified on upload; used during instance boot to verify integrity. */ + sha256: string; + }; + "sfc-api_ConflictError": { + error: { + /** @enum {string} */ + type: "conflict"; + message: string; + details?: components["schemas"]["sfc-api_ErrorDetail"][]; + }; + }; + /** @example cont_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_ContractId": string; + "sfc-api_CreateAdminInstanceSkuPropertyKeyRequest": { + name: components["schemas"]["sfc-api_Name"]; + display_name: string; + description: string; + documentation_link?: string | null; + required: boolean; + internal_note?: string | null; + }; + "sfc-api_CreateAdminInstanceSkuPropertyValueRequest": { + name: components["schemas"]["sfc-api_Name"]; + display_name: string; + description: string; + documentation_link?: string | null; + internal_note?: string | null; + }; + "sfc-api_CreateAdminInstanceSkuRequest": { + /** + * @description Provider account that owns the new instance SKU. Must already + * exist — this endpoint does not bootstrap accounts, workspaces, or + * originating capacities (use the v1 cluster endpoint for that path). + */ + owner: components["schemas"]["sfc-api_Name"]; + /** + * @description Human-readable name for this SKU. Globally unique across non-NULL + * rows. Lookups are still by id; the name is purely for display. + */ + name: components["schemas"]["sfc-api_Name"]; + /** + * @description Initial set of properties. Validated against the registry managed + * in `/v2/admin/instance_sku_properties`: every required, live key + * must be present. Keys not in the registry, deprecated keys, and + * enum values outside the registered set are all allowed. + */ + properties: components["schemas"]["sfc-api_InstanceType"]; + }; + "sfc-api_CreateCapacityRequest": { + name?: null | components["schemas"]["sfc-api_Name"]; + /** @description Workspace to create this capacity in. */ + workspace: components["schemas"]["sfc-api_ResourcePathOrId_WorkspaceId"]; + tags?: null | components["schemas"]["sfc-api_Tags"]; + }; + "sfc-api_CreateDeploymentRequest": { + name?: null | components["schemas"]["sfc-api_Name"]; + capacity: components["schemas"]["sfc-api_ResourcePathOrId_CapacityId"]; + instance_template: components["schemas"]["sfc-api_ResourcePathOrId_InstanceTemplateId"]; + /** Format: int32 */ + target_instance_count: number; + instance_name_template?: components["schemas"]["sfc-api_NameTemplate"]; + }; + "sfc-api_CreateFeatureFlagRequest": { + feature_flag: string; + account_regex: string; + enabled: boolean; + }; + "sfc-api_CreateFeatureFlagResponse": { + /** + * @example feature_flag + * @enum {string} + */ + object: "feature_flag"; + feature_flag_id: string; + feature_flag: string; + account_regex: string; + enabled: boolean; + }; + "sfc-api_CreateGrantRequest": components["schemas"]["sfc-api_Principal"] & { + workspace_id?: null | components["schemas"]["sfc-api_WorkspaceId"]; + role_id: components["schemas"]["sfc-api_RoleId"]; + }; + "sfc-api_CreateInstanceRequest": { + name?: null | components["schemas"]["sfc-api_Name"]; + capacity: components["schemas"]["sfc-api_ResourcePathOrId_CapacityId"]; + image: components["schemas"]["sfc-api_ResourcePathOrId_ImageId"]; + /** + * Format: byte + * @description Base64-encoded [cloud-init user data](https://cloudinit.readthedocs.io/en/latest/explanation/format/index.html). Maximum 64KB. + * @example IyEvYmluL2Jhc2gKZWNobyBoZWxsbyB3b3JsZAo= + */ + cloud_init_user_data?: string; + tags?: null | components["schemas"]["sfc-api_Tags"]; + /** + * Format: int64 + * @description Shutdown priority. Higher numbers are kept longer. Defaults to 0. + */ + priority?: number | null; + /** + * @description **Experimental — subject to change or removal without notice.** + * Enables InfiniBand. The chosen `instance_sku` must support InfiniBand. + * @default false + * @example false + */ + _preview_enable_infiniband: boolean; + }; + "sfc-api_CreateInstanceTemplateRequest": { + name?: null | components["schemas"]["sfc-api_Name"]; + /** @description Workspace to create this template in. */ + workspace: components["schemas"]["sfc-api_ResourcePathOrId_WorkspaceId"]; + /** @description Machine image to use when starting instances with this template. Accepts name or ID. */ + image: components["schemas"]["sfc-api_ResourcePathOrId_ImageId"]; + /** + * Format: byte + * @description Base64-encoded [cloud-init user data](https://cloudinit.readthedocs.io/en/latest/explanation/format/index.html). Maximum 64KB. + * @example IyEvYmluL2Jhc2gKZWNobyBoZWxsbyB3b3JsZAo= + */ + cloud_init_user_data?: string; + }; + "sfc-api_CreateProcurementRequest": { + name?: null | components["schemas"]["sfc-api_Name"]; + target: components["schemas"]["sfc-api_ProcurementTarget"]; + capacity: string; + /** + * @description Instance SKU the procurement's orders will fill on. Rejected at + * submission if the SKU id is not registered. + */ + instance_sku: components["schemas"]["sfc-api_InstanceSkuId"]; + /** + * @description Minimum price to sell compute for ($/node-hour). Must contain decimal + * point. Will be rounded to nearest multiple of $0.000060. + */ + min_sell_price_dollars_per_node_hour: components["schemas"]["sfc-api_DollarsPerNodeHour"]; + /** + * @description Maximum price to buy compute ($/node-hour). Must contain decimal point. + * Will be rounded to nearest multiple of $0.000060. + */ + max_buy_price_dollars_per_node_hour: components["schemas"]["sfc-api_DollarsPerNodeHour"]; + /** + * Format: int32 + * @description How far ahead (in minutes) the procurement buys and sells compute. Higher + * values secure compute further in advance but commit to longer windows + * that may need to be sold when scaling down, potentially at a loss. + * Lower values reduce waste but risk compute being unavailable. Orders + * are placed in 1-hour blocks, so the furthest hour is secured up to + * `managed_window_minutes - 60` minutes before it begins. + */ + managed_window_minutes: number; + /** + * @description Enable/disable the procurement. + * @default true + */ + enabled: boolean; + }; + "sfc-api_CreateRoleRequest": { + name: components["schemas"]["sfc-api_Name"]; + policy: components["schemas"]["sfc-api_Policy"]; + }; + /** @description Request body for `POST /v2/tokens`. */ + "sfc-api_CreateTokenRequest": { + name: components["schemas"]["sfc-api_Name"]; + /** + * Format: int64 + * @description Optional expiry as a Unix timestamp (seconds since epoch). + */ + expires_at?: number | null; + /** @description Optional list of role IDs. A grant is created for each role in the same transaction. */ + role_ids?: components["schemas"]["sfc-api_RoleId"][] | null; + }; + "sfc-api_CreateWorkspaceRequest": { + name?: null | components["schemas"]["sfc-api_Name"]; + }; + "sfc-api_DeleteFeatureFlagRequest": { + feature_flag_id: string; + }; + "sfc-api_DeleteFeatureFlagResponse": { + /** + * @example feature_flag + * @enum {string} + */ + object: "feature_flag"; + feature_flag_id: string; + }; + "sfc-api_DeleteImageResponse": { + /** + * @example image + * @enum {string} + */ + object: "image"; + deleted: boolean; + name: components["schemas"]["sfc-api_Name"]; + }; + /** @example depl_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_DeploymentId": string; + "sfc-api_DeploymentResponse": components["schemas"]["sfc-api_DeploymentScope"] & { + /** + * @example deployment + * @enum {string} + */ + object: "deployment"; + capacity: components["schemas"]["sfc-api_CapacitySummary"]; + instance_template: components["schemas"]["sfc-api_InstanceTemplateSummary"]; + /** Format: int32 */ + target_instance_count: number; + instance_name_template: components["schemas"]["sfc-api_NameTemplate"]; + status: components["schemas"]["sfc-api_ReconciliationStatus"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + updated_at: components["schemas"]["sfc-api_UnixEpoch"]; + }; + "sfc-api_DeploymentScope": { + id: components["schemas"]["sfc-api_DeploymentId"]; + resource_path: components["schemas"]["sfc-api_deploymentResourcePath_DeploymentId"]; + owner: components["schemas"]["sfc-api_Name"]; + workspace: components["schemas"]["sfc-api_Name"]; + name: components["schemas"]["sfc-api_Name"]; + }; + "sfc-api_DeploymentSummary": { + id: components["schemas"]["sfc-api_DeploymentId"]; + name: components["schemas"]["sfc-api_Name"]; + }; + /** @example deplc_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_DeploymentsCursor": string; + /** + * @description Price rate in dollars per node-hour. + * @example 2.500000 + */ + "sfc-api_DollarsPerNodeHour": string; + /** + * @description The effect of a rule on a matched action. + * + * Effects form a hierarchy for the approval system: + * - `Allow` is the union of `RequireApproval` and `ApproveApproval`: the user + * can perform the action directly, request approvals, and approve others' requests. + * - `RequireApproval` means the user can request approval but cannot perform + * the action directly or approve others' requests. + * - `ApproveApproval` means the user can approve others' approval requests + * but cannot perform the action directly or create approval requests. + * @enum {string} + */ + "sfc-api_Effect": "allow" | "require_approval" | "approve_approval"; + "sfc-api_ErrorContent": { + type: components["schemas"]["sfc-api_ErrorType"]; + message: string; + details?: components["schemas"]["sfc-api_ErrorDetail"][]; + }; + "sfc-api_ErrorDetail": { + /** @description The field that caused the error (for validation errors) */ + field?: string | null; + /** @description Specific error code for this detail */ + code: string; + /** @description Human-readable error message */ + message: string; + }; + /** @enum {string} */ + "sfc-api_ErrorType": + | "api_error" + | "invalid_request_error" + | "authentication_error" + | "idempotency_error" + | "conflict" + | "not_found" + | "request_timed_out" + | "forbidden" + | "not_implemented" + | "upgrade_required" + | "payment_required" + | "service_unavailable" + | "unprocessable_entity" + | "gone"; + "sfc-api_ForbiddenError": { + error: { + /** @enum {string} */ + type: "forbidden"; + message: string; + }; + }; + /** + * @example grant + * @enum {string} + */ + "sfc-api_GrantDiscriminator": "grant"; + /** @example grnt_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_GrantId": string; + "sfc-api_GrantResponse": components["schemas"]["sfc-api_Principal"] & { + /** + * @example grant + * @enum {string} + */ + object: "grant"; + id: components["schemas"]["sfc-api_GrantId"]; + workspace?: null | components["schemas"]["sfc-api_WorkspaceSummary"]; + role: components["schemas"]["sfc-api_RoleSummary"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + }; + "sfc-api_ImageDownloadResponse": { + /** @description Presigned download URL. */ + url: string; + expires_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** + * @description For integrity verification. + * @example e3b0c44298fc1c149af... + */ + sha256: string; + /** + * Format: u-int64 + * @description Image size in bytes. + */ + size: number; + }; + /** @example image_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_ImageId": string; + "sfc-api_ImageListEntry": components["schemas"]["sfc-api_ImageScope"] & { + /** + * @example image + * @enum {string} + */ + object: "image"; + upload_status: components["schemas"]["sfc-api_ImageUploadStatus"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + provider?: string | null; + sha256?: string | null; + }; + "sfc-api_ImageScope": { + id: components["schemas"]["sfc-api_ImageId"]; + resource_path: components["schemas"]["sfc-api_imageResourcePath_ImageId"]; + owner: components["schemas"]["sfc-api_Name"]; + workspace: components["schemas"]["sfc-api_Name"]; + name: components["schemas"]["sfc-api_Name"]; + }; + "sfc-api_ImageSummary": { + id: components["schemas"]["sfc-api_ImageId"]; + name: components["schemas"]["sfc-api_Name"]; + }; + "sfc-api_ImageUploadResponse": components["schemas"]["sfc-api_ImageScope"] & { + /** + * @example image + * @enum {string} + */ + object: "image"; + upload_status: components["schemas"]["sfc-api_ImageUploadStatus"]; + sha256?: string | null; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + }; + /** @enum {string} */ + "sfc-api_ImageUploadStatus": + | "started" + | "uploading" + | "completed" + | "failed" + | "revoked"; + /** @example imagec_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_ImagesCursor": string; + /** @example inst_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_InstanceId": string; + /** @enum {string} */ + "sfc-api_InstanceInclude": "cloud_init_user_data"; + "sfc-api_InstanceLogChunk": { + /** @description Wall-clock time. Unix timestamp. */ + timestamp_realtime: components["schemas"]["sfc-api_UnixEpoch"]; + /** + * Format: int64 + * @description Monotonic clock seconds. + */ + timestamp_monotonic_secs: number; + /** + * Format: u-int32 + * @description Nanosecond component of the monotonic clock. + */ + timestamp_monotonic_nanos: number; + /** Format: u-int64 */ + seqnum: number; + /** + * Format: byte + * @description Base-64 encoded raw console output. + * @example SGVsbG8gV29ybGQK + */ + data: string; + }; + "sfc-api_InstanceLogsResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + data: components["schemas"]["sfc-api_InstanceLogChunk"][]; + }; + "sfc-api_InstanceResponse": components["schemas"]["sfc-api_InstanceScope"] & { + /** + * @example instance + * @enum {string} + */ + object: "instance"; + status: components["schemas"]["sfc-api_InstanceStatus"]; + instance_sku?: null | components["schemas"]["sfc-api_InstanceSkuSummary"]; + /** @description Capacity this instance is utilizing. */ + capacity: components["schemas"]["sfc-api_CapacitySummary"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** @description Image this instance was launched from. */ + image: components["schemas"]["sfc-api_ImageSummary"]; + deployment?: null | components["schemas"]["sfc-api_DeploymentSummary"]; + /** @description Whether cloud-init user data is configured for this instance. */ + cloud_init_user_data_used: boolean; + /** + * Format: byte + * @description Base64-encoded [cloud-init user data](https://cloudinit.readthedocs.io/en/latest/explanation/format/index.html). + * @example IyEvYmluL2Jhc2gKZWNobyBoZWxsbyB3b3JsZAo= + */ + cloud_init_user_data?: string; + tags?: null | components["schemas"]["sfc-api_Tags"]; + expected_shutdown_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + /** + * Format: int64 + * @description Shutdown priority. Higher numbers are kept longer when the capacity's + * quota drops below the running-instance count. Default 0; any signed + * 64-bit integer is accepted. + */ + priority: number; + }; + "sfc-api_InstanceScope": { + id: components["schemas"]["sfc-api_InstanceId"]; + resource_path: components["schemas"]["sfc-api_instanceResourcePath_InstanceId"]; + owner: components["schemas"]["sfc-api_Name"]; + workspace: components["schemas"]["sfc-api_Name"]; + name: components["schemas"]["sfc-api_Name"]; + }; + "sfc-api_InstanceSku": { + /** + * @description Single discriminator for the instance-SKU object on both admin and + * public endpoints. They expose different field shapes but represent + * the same underlying resource (mirrors Stripe's pattern of one + * `object` discriminator per resource type, regardless of view). + * @example instance_sku + * @enum {string} + */ + object: "instance_sku"; + id: components["schemas"]["sfc-api_InstanceSkuId"]; + /** + * @description Human-readable name. Lookups still happen by id; the name is + * purely for display. The public `GET /v2/instance_skus` and + * `/v2/instance_skus/{id}` endpoints hide SKUs whose name hasn't + * been set, so this field is always present here. + */ + name: components["schemas"]["sfc-api_Name"]; + properties: components["schemas"]["sfc-api_InstanceSkuProperty"][]; + }; + /** @description One allowed value for an enumeration-typed property key. */ + "sfc-api_InstanceSkuEnumerationValue": { + name: components["schemas"]["sfc-api_Name"]; + /** @description Human-readable display name. */ + display_name: string; + description: string; + documentation_link?: string | null; + stable_at: components["schemas"]["sfc-api_UnixEpoch"]; + deprecated_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + /** @description Migration guidance shown when the value is deprecated. */ + deprecation_info?: string | null; + }; + /** @example isku_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_InstanceSkuId": string; + /** + * @description A property set on an instance SKU. Tagged by `type` so new value + * kinds can be added without breaking clients. + */ + "sfc-api_InstanceSkuProperty": { + key: components["schemas"]["sfc-api_InstanceSkuPropertyKey"]; + value: components["schemas"]["sfc-api_InstanceSkuEnumerationValue"]; + /** @enum {string} */ + type: "enumeration"; + }; + /** + * @description A catalog entry describing a property key together with its allowed + * enumeration values. + */ + "sfc-api_InstanceSkuPropertyDefinition": { + key: components["schemas"]["sfc-api_InstanceSkuPropertyKey"]; + values: components["schemas"]["sfc-api_InstanceSkuEnumerationValue"][]; + /** @enum {string} */ + type: "enumeration"; + }; + /** + * @description A property key describing something about an instance SKU (e.g. + * `accelerator`). + */ + "sfc-api_InstanceSkuPropertyKey": { + name: components["schemas"]["sfc-api_Name"]; + /** @description Human-readable display name. */ + display_name: string; + description: string; + /** @description Link to a spec sheet or further documentation. */ + documentation_link?: string | null; + stable_at: components["schemas"]["sfc-api_UnixEpoch"]; + deprecated_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + /** @description Migration guidance shown when the key is deprecated. */ + deprecation_info?: string | null; + }; + /** + * @description Summary view of an instance SKU embedded on responses that reference + * one (orders, procurements, instances, capacity transfers). Carries + * both the id and the human-readable name. Legacy SKUs whose `name` + * column hasn't been backfilled use `UNKNOWN_INSTANCE_SKU_NAME` as a + * placeholder so this field is always populated on the wire. + */ + "sfc-api_InstanceSkuSummary": { + id: components["schemas"]["sfc-api_InstanceSkuId"]; + name: components["schemas"]["sfc-api_Name"]; + }; + /** @enum {string} */ + "sfc-api_InstanceSkuValueType": "enumeration"; + /** @example iskuc_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_InstanceSkusCursor": string; + "sfc-api_InstanceSshHostKey": { + /** + * @description Key algorithm. + * @example ssh-ed25519 + * @example ssh-rsa + */ + key_type: string; + /** + * Format: byte + * @description Base64-encoded public key. + * @example AAAAC3NzaC1lZDI1NTE5AAAAI... + */ + key: string; + }; + "sfc-api_InstanceSshInfo": { + /** @example 24.125.89.203 */ + hostname: string; + /** + * Format: u-int16 + * @example 22 + */ + port: number; + host_keys: components["schemas"]["sfc-api_InstanceSshHostKey"][]; + last_successful_key_update_at?: + | null + | components["schemas"]["sfc-api_UnixEpoch"]; + last_attempted_key_update_at?: + | null + | components["schemas"]["sfc-api_UnixEpoch"]; + }; + /** + * @description `awaiting_allocation` when waiting for compute allocation on its capacity, + * `running` once assigned and the physical machine is running (still takes + * time for the image to be downloaded and booted), `terminated` when stopped + * by the user or after running out of allocation, `failed` on hardware fault. + * @enum {string} + */ + "sfc-api_InstanceStatus": + | "awaiting_allocation" + | "running" + | "terminated" + | "failed"; + /** @example itmpl_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_InstanceTemplateId": string; + /** @enum {string} */ + "sfc-api_InstanceTemplateInclude": "cloud_init_user_data"; + "sfc-api_InstanceTemplateResponse": components["schemas"]["sfc-api_InstanceTemplateScope"] & { + /** + * @example instance_template + * @enum {string} + */ + object: "instance_template"; + /** @description Machine image to use when starting instances with this template. */ + image: components["schemas"]["sfc-api_ImageSummary"]; + /** @description Whether cloud-init user data is configured for this template. */ + cloud_init_user_data_used: boolean; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** + * Format: byte + * @description Base64-encoded [cloud-init user data](https://cloudinit.readthedocs.io/en/latest/explanation/format/index.html). + * @example IyEvYmluL2Jhc2gKZWNobyBoZWxsbyB3b3JsZAo= + */ + cloud_init_user_data?: string; + }; + "sfc-api_InstanceTemplateScope": { + id: components["schemas"]["sfc-api_InstanceTemplateId"]; + resource_path: components["schemas"]["sfc-api_instance_templateResourcePath_InstanceTemplateId"]; + owner: components["schemas"]["sfc-api_Name"]; + workspace: components["schemas"]["sfc-api_Name"]; + name: components["schemas"]["sfc-api_Name"]; + }; + "sfc-api_InstanceTemplateSummary": { + id: components["schemas"]["sfc-api_InstanceTemplateId"]; + name: components["schemas"]["sfc-api_Name"]; + }; + /** @example itmplc_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_InstanceTemplatesCursor": string; + "sfc-api_InstanceType": { + [ + key: string + ]: components["schemas"]["sfc-api_InstanceTypeCategoryVariant"]; + }; + "sfc-api_InstanceTypeCategoryRequirements": components["schemas"]["sfc-api_InstanceTypeCategoryVariant"][]; + "sfc-api_InstanceTypeCategoryVariant": string; + "sfc-api_InstanceTypeRequirements": { + [ + key: string + ]: components["schemas"]["sfc-api_InstanceTypeCategoryRequirements"]; + }; + /** @example nodec_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_InstancesCursor": string; + "sfc-api_InternalServerError": { + error: { + /** @enum {string} */ + type: "api_error"; + message: string; + }; + }; + /** @enum {string} */ + "sfc-api_InvoiceRail": "stripe" | "mercury"; + "sfc-api_ListAdminInstanceSkuPropertyKeysResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + cursor?: + | null + | components["schemas"]["sfc-api_AdminInstanceSkuPropertyKeysCursor"]; + has_more: boolean; + data: components["schemas"]["sfc-api_AdminInstanceSkuPropertyKeyDetail"][]; + }; + "sfc-api_ListAdminInstanceSkuPropertyValuesResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + cursor?: + | null + | components["schemas"]["sfc-api_AdminInstanceSkuPropertyValuesCursor"]; + has_more: boolean; + data: components["schemas"]["sfc-api_AdminInstanceSkuEnumerationValue"][]; + }; + "sfc-api_ListAdminInstanceSkusResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + cursor?: null | components["schemas"]["sfc-api_AdminInstanceSkusCursor"]; + has_more: boolean; + data: components["schemas"]["sfc-api_AdminInstanceSku"][]; + }; + "sfc-api_ListAvailabilityResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + data: components["schemas"]["sfc-api_AvailabilityGroup"][]; + }; + "sfc-api_ListCapacitiesResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + cursor?: null | components["schemas"]["sfc-api_CapacitiesCursor"]; + has_more: boolean; + data: components["schemas"]["sfc-api_CapacityResponse"][]; + }; + "sfc-api_ListDeploymentsResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + cursor?: null | components["schemas"]["sfc-api_DeploymentsCursor"]; + has_more: boolean; + data: components["schemas"]["sfc-api_DeploymentResponse"][]; + }; + "sfc-api_ListGrantsResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + data: components["schemas"]["sfc-api_GrantResponse"][]; + }; + "sfc-api_ListImagesResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + cursor?: null | components["schemas"]["sfc-api_ImagesCursor"]; + has_more: boolean; + data: components["schemas"]["sfc-api_ImageListEntry"][]; + }; + /** + * @description Paginated list of property-catalog entries returned by + * `GET /v2/instance_sku_property_catalog`. + */ + "sfc-api_ListInstanceSkuPropertyCatalogResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + /** @description Pass as `starting_after` or `ending_before` to paginate. */ + cursor?: string | null; + has_more: boolean; + data: components["schemas"]["sfc-api_InstanceSkuPropertyDefinition"][]; + }; + /** @description Paginated list of instance SKUs returned by `GET /v2/instance_skus`. */ + "sfc-api_ListInstanceSkusResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + cursor?: null | components["schemas"]["sfc-api_InstanceSkusCursor"]; + has_more: boolean; + data: components["schemas"]["sfc-api_InstanceSku"][]; + }; + "sfc-api_ListInstanceTemplatesResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + cursor?: null | components["schemas"]["sfc-api_InstanceTemplatesCursor"]; + has_more: boolean; + data: components["schemas"]["sfc-api_InstanceTemplateResponse"][]; + }; + "sfc-api_ListInstancesResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + cursor?: null | components["schemas"]["sfc-api_InstancesCursor"]; + has_more: boolean; + data: components["schemas"]["sfc-api_InstanceResponse"][]; + }; + /** @description Paginated list of historical fills, newest first. */ + "sfc-api_ListOrderbookFillsResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + requirements: components["schemas"]["sfc-api_InstanceTypeRequirements"]; + start_at: components["schemas"]["sfc-api_UnixEpoch"]; + end_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** @description Server time when the fills were sampled. */ + requested_at: components["schemas"]["sfc-api_UnixEpoch"]; + cursor?: null | components["schemas"]["sfc-api_OrderbookFillsCursor"]; + has_more: boolean; + data: components["schemas"]["sfc-api_OrderbookFill"][]; + }; + /** @description Paginated list of active windows, sorted by `(start_at, end_at)` ascending. */ + "sfc-api_ListOrderbookWindowsResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + requirements: components["schemas"]["sfc-api_InstanceTypeRequirements"]; + range_start_at: components["schemas"]["sfc-api_UnixEpoch"]; + range_end_at: components["schemas"]["sfc-api_UnixEpoch"]; + cursor?: null | components["schemas"]["sfc-api_OrderbookWindowsCursor"]; + has_more: boolean; + data: components["schemas"]["sfc-api_OrderbookWindow"][]; + }; + "sfc-api_ListProcurementsResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + cursor?: null | components["schemas"]["sfc-api_ProcurementsCursor"]; + has_more: boolean; + data: components["schemas"]["sfc-api_ProcurementResponse"][]; + }; + "sfc-api_ListRolesResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + data: components["schemas"]["sfc-api_RoleResponse"][]; + }; + "sfc-api_ListTokensResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + url: string; + data: components["schemas"]["sfc-api_TokenResponse"][]; + has_more: boolean; + /** Format: int64 */ + total_count: number; + cursor?: null | components["schemas"]["sfc-api_TokensCursor"]; + }; + "sfc-api_ListUsersResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + data: components["schemas"]["sfc-api_UserResponse"][]; + has_more: boolean; + cursor?: null | components["schemas"]["sfc-api_UsersCursor"]; + }; + "sfc-api_ListWorkspacesResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + data: components["schemas"]["sfc-api_WorkspaceResponse"][]; + has_more: boolean; + }; + /** @example my-resource-name */ + "sfc-api_Name": string; + /** + * @description A name template using {{variable}} syntax. Available variables: {{adjective}} (~128 random adjectives), {{noun}} (~128 random nouns), {{nanoid(N)}} (N-character alphanumeric identifier, 1 ≤ N ≤ 21). The template must produce enough unique combinations to avoid collisions — equivalent to at least the default template {{adjective}}-{{noun}}-{{nanoid(6)}} (~1 quadrillion possibilities). Must start with an alphanumeric character. Resolved names are limited to 255 characters. + * @example my-fleet-{{nanoid(9)}} + */ + "sfc-api_NameTemplate": string; + /** @enum {string} */ + "sfc-api_NodeCountTag": "node_count"; + "sfc-api_NotFoundError": { + error: { + /** @enum {string} */ + type: "not_found"; + message: string; + }; + }; + "sfc-api_NotImplementedError": { + error: { + /** @enum {string} */ + type: "not_implemented"; + message: string; + }; + }; + /** @example ordr_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_OrderId": string; + /** + * @description The status of an order in the system. + * + * `pending` = not resolved/processed yet. + * + * `filled` = order executed. + * + * `standing` = the order is waiting for a match. + * + * `cancelled` = the order was cancelled either automatically (not a standing + * order and didn't immediately fill, or current time past `end_at`) or by + * explicit cancellation. + * + * `rejected` = validation/system error occurred. + * @enum {string} + */ + "sfc-api_OrderStatus": + | "pending" + | "filled" + | "rejected" + | "cancelled" + | "standing"; + /** + * @description Depth of book for one delivery window. Bids descending (highest first), + * asks ascending (lowest first). Either array may be empty when no orders + * rest on that side. + */ + "sfc-api_OrderbookDepthResponse": { + /** @description The hardware requirements the book was filtered by. */ + requirements: components["schemas"]["sfc-api_InstanceTypeRequirements"]; + /** @description Start of the delivery window the book covers. */ + start_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** @description End of the delivery window the book covers. */ + end_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** @description Server time when the book was sampled. */ + requested_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** @description Bids sorted descending by rate (best bid first). */ + bids: components["schemas"]["sfc-api_PriceLevel"][]; + /** @description Asks sorted ascending by rate (best ask first). */ + asks: components["schemas"]["sfc-api_PriceLevel"][]; + }; + /** @description A single trade: execution rate, node count, and the time it was recorded. */ + "sfc-api_OrderbookFill": { + /** @description Execution rate in dollars per node-hour. */ + dollars_per_node_hour: components["schemas"]["sfc-api_DollarsPerNodeHour"]; + /** + * Format: int64 + * @description Number of nodes filled at this execution rate. + * @example 3 + */ + node_count: number; + /** @description When the fill was recorded. */ + filled_at: components["schemas"]["sfc-api_UnixEpoch"]; + }; + /** @example mfilc_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_OrderbookFillsCursor": string; + /** + * @description Top-of-book snapshot: the highest resting buy (`best_bid`) and lowest + * resting sell (`best_ask`) for the requested window. Either side may be + * absent if no orders are resting on it. + */ + "sfc-api_OrderbookQuoteResponse": { + /** @description The hardware requirements the book was filtered by. */ + requirements: components["schemas"]["sfc-api_InstanceTypeRequirements"]; + /** @description Start of the delivery window the book covers. */ + start_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** @description End of the delivery window the book covers. */ + end_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** @description Server time when the book was sampled. */ + requested_at: components["schemas"]["sfc-api_UnixEpoch"]; + best_bid?: null | components["schemas"]["sfc-api_PriceLevel"]; + best_ask?: null | components["schemas"]["sfc-api_PriceLevel"]; + }; + /** + * @description Summary row: one delivery window with at least one resting order matching + * the requested filter. + */ + "sfc-api_OrderbookWindow": { + start_at: components["schemas"]["sfc-api_UnixEpoch"]; + end_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** + * Format: int64 + * @description Duration of the window in whole hours. + * @example 168 + */ + duration_hours: number; + /** + * Format: int64 + * @description Number of resting bid orders at this window. + * @example 3 + */ + total_bid_order_count: number; + /** + * Format: int64 + * @description Number of resting ask orders at this window. + * @example 5 + */ + total_ask_order_count: number; + /** + * Format: int64 + * @description Total node count across all resting bids at this window. + * @example 12 + */ + total_bid_node_count: number; + /** + * Format: int64 + * @description Total node count across all resting asks at this window. + * @example 18 + */ + total_ask_node_count: number; + best_bid?: null | components["schemas"]["sfc-api_PriceLevel"]; + best_ask?: null | components["schemas"]["sfc-api_PriceLevel"]; + }; + /** @example mwin_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_OrderbookWindowsCursor": string; + /** @example ordrc_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_OrdersCursor": string; + "sfc-api_PatchAdminInstanceSkuPropertyKeyRequest": { + display_name?: string | null; + description?: string | null; + documentation_link?: string | null; + required?: boolean | null; + set_stable?: boolean; + set_deprecated?: boolean; + deprecation_info?: string | null; + internal_note?: string | null; + set_deleted?: boolean; + }; + "sfc-api_PatchAdminInstanceSkuPropertyValueRequest": { + display_name?: string | null; + description?: string | null; + documentation_link?: string | null; + set_stable?: boolean; + set_deprecated?: boolean; + deprecation_info?: string | null; + internal_note?: string | null; + set_deleted?: boolean; + }; + "sfc-api_PatchAdminInstanceSkuRequest": { + name?: null | components["schemas"]["sfc-api_Name"]; + }; + "sfc-api_PatchCapacityRequest": { + name?: null | components["schemas"]["sfc-api_Name"]; + tags?: null | components["schemas"]["sfc-api_Tags"]; + }; + "sfc-api_PatchDeploymentRequest": { + name?: null | components["schemas"]["sfc-api_Name"]; + instance_template?: + | null + | components["schemas"]["sfc-api_ResourcePathOrId_InstanceTemplateId"]; + /** Format: int32 */ + target_instance_count?: number | null; + instance_name_template?: + | null + | components["schemas"]["sfc-api_NameTemplate"]; + }; + "sfc-api_PatchInstanceRequest": { + name?: null | components["schemas"]["sfc-api_Name"]; + tags?: null | components["schemas"]["sfc-api_Tags"]; + /** + * Format: int64 + * @description Shutdown priority. Higher numbers are kept longer. Omit to leave + * unchanged. + */ + priority?: number | null; + }; + "sfc-api_PatchProcurementRequest": { + name?: null | components["schemas"]["sfc-api_Name"]; + instance_sku?: null | components["schemas"]["sfc-api_InstanceSkuId"]; + min_sell_price_dollars_per_node_hour?: + | null + | components["schemas"]["sfc-api_DollarsPerNodeHour"]; + max_buy_price_dollars_per_node_hour?: + | null + | components["schemas"]["sfc-api_DollarsPerNodeHour"]; + /** + * Format: int32 + * @description How far ahead (in minutes) the procurement buys and sells compute. Higher + * values secure compute further in advance but commit to longer windows + * that may need to be sold when scaling down, potentially at a loss. + * Lower values reduce waste but risk compute being unavailable. Orders + * are placed in 1-hour blocks, so the furthest hour is secured up to + * `managed_window_minutes - 60` minutes before it begins. + */ + managed_window_minutes?: number | null; + enabled?: boolean | null; + }; + "sfc-api_PatchWorkspaceRequest": { + name?: string | null; + }; + "sfc-api_PaymentRequiredError": { + error: { + /** @enum {string} */ + type: "payment_required"; + message: string; + }; + }; + "sfc-api_PermissionCheckResponse": { + /** + * @description Whether the caller can perform every action in the request directly + * without approval. + */ + allowed: boolean; + }; + /** + * @description A parsed permission policy. + * + * Policies contain a list of rules. When evaluating whether an action is + * permitted, all matching rules are combined by unioning their capabilities. + * If no rule matches, the action is denied by default. + */ + "sfc-api_Policy": { + api_version: components["schemas"]["sfc-api_ApiVersion"]; + description: string; + rules?: components["schemas"]["sfc-api_Rule"][]; + }; + /** + * @description One price level in the order book — orders sharing the same per-node-hour + * rate are summed into a single entry. + */ + "sfc-api_PriceLevel": { + /** @description Per-node-hour rate for orders at this level. */ + dollars_per_node_hour: components["schemas"]["sfc-api_DollarsPerNodeHour"]; + /** + * Format: int64 + * @description Total nodes resting at this rate. + * @example 4 + */ + node_count: number; + }; + /** + * @description Tagged sum of who a grant applies to. Wire shape is two flat fields, + * `principal_type` and `principal_id`; the variant determines what + * `principal_id` means: + * + * - `User(UserId)` — `principal_id` is a `users.id` (validated as a `Name` + * on deserialize). The create handler additionally verifies the row exists + * in `users`. + * - `Token(TokenId)` — `principal_id` is a `tokn_*` id from `api_tokens.id`. + * This is what `check_permission` sees at request time (set by + * `lookup_api_token` after hashing the raw bearer secret). The create + * handler verifies the row exists in `api_tokens`. + */ + "sfc-api_Principal": + | { + principal_id: components["schemas"]["sfc-api_UserId"]; + /** @enum {string} */ + principal_type: "user"; + } + | { + principal_id: components["schemas"]["sfc-api_TokenId"]; + /** @enum {string} */ + principal_type: "token"; + }; + /** + * @description Postgres `principal_type` enum. Identifies what kind of principal a + * `grants.principal_id` refers to. + * + * Canonical home: `trading::grants`. `sfc_api::types::v2::grants` re-exports + * for callers that already import from there. + * @enum {string} + */ + "sfc-api_PrincipalType": "user" | "token"; + /** @example proc_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_ProcurementId": string; + "sfc-api_ProcurementResponse": components["schemas"]["sfc-api_ProcurementScope"] & { + /** + * @example procurement + * @enum {string} + */ + object: "procurement"; + target: components["schemas"]["sfc-api_ProcurementTarget"]; + capacity: components["schemas"]["sfc-api_CapacitySummary"]; + instance_sku?: null | components["schemas"]["sfc-api_InstanceSkuSummary"]; + /** + * @description Minimum price to sell compute for ($/node-hour). Must contain decimal + * point. Will be rounded to nearest multiple of $0.000060. + */ + min_sell_price_dollars_per_node_hour: components["schemas"]["sfc-api_DollarsPerNodeHour"]; + /** + * @description Maximum price to buy compute ($/node-hour). Must contain decimal point. + * Will be rounded to nearest multiple of $0.000060. + */ + max_buy_price_dollars_per_node_hour: components["schemas"]["sfc-api_DollarsPerNodeHour"]; + /** + * Format: int32 + * @description How far ahead (in minutes) the procurement buys and sells compute. Higher + * values secure compute further in advance but commit to longer windows + * that may need to be sold when scaling down, potentially at a loss. + * Lower values reduce waste but risk compute being unavailable. Orders + * are placed in 1-hour blocks, so the furthest hour is secured up to + * `managed_window_minutes - 60` minutes before it begins. + */ + managed_window_minutes: number; + /** @description Enable/disable the procurement. Disabling cancels all standing orders. */ + enabled: boolean; + status: components["schemas"]["sfc-api_ReconciliationStatus"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + updated_at: components["schemas"]["sfc-api_UnixEpoch"]; + }; + "sfc-api_ProcurementScope": { + id: components["schemas"]["sfc-api_ProcurementId"]; + resource_path: components["schemas"]["sfc-api_procurementResourcePath_ProcurementId"]; + owner: components["schemas"]["sfc-api_Name"]; + workspace: components["schemas"]["sfc-api_Name"]; + name: components["schemas"]["sfc-api_Name"]; + }; + "sfc-api_ProcurementSummary": { + id: components["schemas"]["sfc-api_ProcurementId"]; + name: components["schemas"]["sfc-api_Name"]; + }; + "sfc-api_ProcurementTarget": + | components["schemas"]["sfc-api_NodeCountTag"] + | number; + /** @example procc_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_ProcurementsCursor": string; + "sfc-api_PropertyEnumValue": { + key: components["schemas"]["sfc-api_Name"]; + value: components["schemas"]["sfc-api_Name"]; + customer_name: string; + customer_description: string; + customer_link?: string | null; + stable_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + deprecated_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + customer_deprecated_text?: string | null; + internal_note?: string | null; + deleted_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + updated_at: components["schemas"]["sfc-api_UnixEpoch"]; + }; + "sfc-api_PropertyKey": { + key: components["schemas"]["sfc-api_Name"]; + customer_name: string; + customer_description: string; + customer_link?: string | null; + required: boolean; + value_type: components["schemas"]["sfc-api_InstanceSkuValueType"]; + stable_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + deprecated_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + customer_deprecated_text?: string | null; + internal_note?: string | null; + deleted_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + updated_at: components["schemas"]["sfc-api_UnixEpoch"]; + }; + /** + * @description How the current instance SKUs line up against this property key's + * registry entry. All counts are live (computed on each read). + */ + "sfc-api_PropertyKeyCoverage": { + /** + * Format: int64 + * @description Total instance SKUs in the system. + */ + total: number; + /** + * Format: int64 + * @description SKUs that set this key. + */ + with_key: number; + /** + * Format: int64 + * @description SKUs missing this key. + */ + without_key: number; + /** + * Format: int64 + * @description SKUs that set this key with a value in the registered enumeration. + */ + with_registered_value: number; + /** + * Format: int64 + * @description SKUs that set this key with a value NOT in the registered enumeration. + */ + with_unregistered_value: number; + /** @description Up to 20 SKU IDs missing this key (stable sort by id). */ + sample_missing: components["schemas"]["sfc-api_InstanceSkuId"][]; + /** @description Up to 20 SKU IDs carrying an unregistered value (stable sort by id). */ + sample_unregistered_values: components["schemas"]["sfc-api_InstanceSkuId"][]; + }; + "sfc-api_PutAdminInstanceSkuRequest": { + /** + * @description Full replacement set of properties for the instance SKU. + * Validated against the registry managed in + * `/v2/admin/instance_sku_properties`: every key flagged `required=true` + * (and not deprecated/deleted) must be present. Keys not in the + * registry, deprecated keys, and enum values outside the registered + * set are all allowed. + */ + properties: components["schemas"]["sfc-api_InstanceType"]; + /** + * @description ⚠️ DANGER — DO NOT SET THIS UNLESS YOU MEAN IT. ⚠️ + * + * When `false` (the default), every existing `(key, value)` pair + * must be present unchanged in `properties` — new keys can be + * added, but no existing key may be dropped or have its value + * rewritten. The trading engine treats SKU properties as the + * canonical hardware/visibility identity of the SKU; flipping + * `audience: public → internal`, dropping `accelerator`, or + * renaming a property retroactively reshapes every order, contract, + * and procurement that's already pointed at this SKU. Customers + * who trusted that the SKU they bought against was H100 will + * suddenly be matching against whatever you wrote. + * + * Set this to `true` ONLY when you have audited every live + * procurement, order, and contract on this SKU and know for + * certain that the rewrite is intended (e.g. correcting a typo + * nobody has matched against yet, or renaming a property the + * trading engine doesn't key on). For everything else, create a + * new SKU and migrate. + */ + allow_modify?: boolean; + }; + "sfc-api_ReconciliationStatus": { + state: components["schemas"]["sfc-api_AutomationStatus"]; + message: string; + }; + "sfc-api_RequestTimedOutError": { + error: { + /** @enum {string} */ + type: "request_timed_out"; + message: string; + }; + }; + /** + * @description Key/value filters on instance SKU properties. + * + * Valid keys and values are published at + * `GET /v2/instance_sku_property_catalog`. + * + * Empty map = no constraints. + * @example { + * "accelerator": [ + * "H100" + * ] + * } + */ + "sfc-api_Requirements": { + [key: string]: components["schemas"]["sfc-api_Name"][]; + }; + /** + * @description A resource in the permission system. + * + * `Wildcard` matches all resources and serializes as `"*"`. + * + * Variants must stay in sync with the `rule_resource` PostgreSQL enum + * defined in migration 00110. + * @enum {string} + */ + "sfc-api_Resource": + | "*" + | "node" + | "capacity" + | "secret" + | "ssh_key" + | "firewall" + | "role" + | "grant" + | "token" + | "billing" + | "order" + | "limits" + | "approval" + | "user"; + /** + * @description A resource path like 'sfc:capacity:acme:prod:my-capacity' _or_ an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent. + * @example cap_k3R-nX9vLm7Qp2Yw5Jd8F + */ + "sfc-api_ResourcePathOrId_CapacityId": string; + /** + * @description A resource path like 'sfc:image:acme:prod:my-image' _or_ an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent. + * @example image_k3R-nX9vLm7Qp2Yw5Jd8F + */ + "sfc-api_ResourcePathOrId_ImageId": string; + /** + * @description A resource path like 'sfc:instance_template:acme:prod:my-instance_template' _or_ an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent. + * @example itmpl_k3R-nX9vLm7Qp2Yw5Jd8F + */ + "sfc-api_ResourcePathOrId_InstanceTemplateId": string; + /** + * @description A resource path like 'sfc:procurement:acme:prod:my-procurement' _or_ an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent. + * @example proc_k3R-nX9vLm7Qp2Yw5Jd8F + */ + "sfc-api_ResourcePathOrId_ProcurementId": string; + /** + * @description A resource path like 'sfc:role:acme:my-role' _or_ an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent. + * @example role_k3R-nX9vLm7Qp2Yw5Jd8F + */ + "sfc-api_ResourcePathOrId_RoleId": string; + /** + * @description A resource path like 'sfc:subnet:acme:prod:my-subnet' _or_ an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent. + * @example snet_k3R-nX9vLm7Qp2Yw5Jd8F + */ + "sfc-api_ResourcePathOrId_SubnetId": string; + /** + * @description A resource path like 'sfc:user:my-user' _or_ an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent. + * @example my-resource-name + */ + "sfc-api_ResourcePathOrId_UserId": string; + /** + * @description A resource path like 'sfc:workspace:acme:my-workspace' _or_ an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent. + * @example wksp_k3R-nX9vLm7Qp2Yw5Jd8F + */ + "sfc-api_ResourcePathOrId_WorkspaceId": string; + /** + * @example role + * @enum {string} + */ + "sfc-api_RoleDiscriminator": "role"; + /** @example role_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_RoleId": string; + "sfc-api_RoleResponse": components["schemas"]["sfc-api_RoleScope"] & { + /** + * @example role + * @enum {string} + */ + object: "role"; + role_type: components["schemas"]["sfc-api_RoleType"]; + policy: components["schemas"]["sfc-api_Policy"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + updated_at: components["schemas"]["sfc-api_UnixEpoch"]; + }; + "sfc-api_RoleScope": { + id: components["schemas"]["sfc-api_RoleId"]; + resource_path: components["schemas"]["sfc-api_roleResourcePath_RoleId"]; + owner: components["schemas"]["sfc-api_Name"]; + name: components["schemas"]["sfc-api_Name"]; + }; + "sfc-api_RoleSummary": { + id: components["schemas"]["sfc-api_RoleId"]; + name: components["schemas"]["sfc-api_Name"]; + }; + /** @enum {string} */ + "sfc-api_RoleType": "built_in" | "custom"; + /** @description A single rule in a policy: an effect plus a set of actions. */ + "sfc-api_Rule": { + effect: components["schemas"]["sfc-api_Effect"]; + actions: components["schemas"]["sfc-api_ActionsMap"]; + }; + /** + * @description Node count over time, as a list of `[start_at, end_at)` time ranges. + * + * Example: 5 nodes from t=0 to t=3600 is `[{"start_at": 0, "end_at": 3600, "node_count": 5}]`. + * + * `start_at` and `end_at` must be 60-second aligned, `node_count` must be + * non-negative. On non-final entries, `end_at` may be omitted (inferred + * from the next entry's `start_at`); gaps fill with `node_count: 0`. + */ + "sfc-api_Schedule": components["schemas"]["sfc-api_ScheduleEntry"][]; + /** + * @description A `[start_at, end_at)` time range with a fixed `node_count`. + * `end_at` is `null` only on the final entry, marking an unbounded tail. + */ + "sfc-api_ScheduleEntry": { + start_at: components["schemas"]["sfc-api_UnixEpoch"]; + end_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + /** Format: int32 */ + node_count: number; + }; + "sfc-api_ServiceUnavailableError": { + error: { + /** @enum {string} */ + type: "service_unavailable"; + message: string; + }; + }; + "sfc-api_SetDefaultImageResponse": components["schemas"]["sfc-api_ImageScope"] & { + /** + * @example image + * @enum {string} + */ + object: "image"; + upload_status: components["schemas"]["sfc-api_ImageUploadStatus"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + provider?: string | null; + sha256?: string | null; + is_default: boolean; + }; + /** @enum {string} */ + "sfc-api_Side": "sell" | "buy"; + /** @description Start a multipart image upload. Max image size is 128 GiB. */ + "sfc-api_StartUploadRequest": { + name?: null | components["schemas"]["sfc-api_Name"]; + /** @description Workspace to create this image in. */ + workspace: components["schemas"]["sfc-api_ResourcePathOrId_WorkspaceId"]; + }; + /** @example snet_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_SubnetId": string; + /** + * @example { + * "env": "prod", + * "team": "infra" + * } + */ + "sfc-api_Tags": { + [key: string]: string; + }; + /** @example tokn_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_TokenId": string; + /** @description Token metadata response. Never includes the raw token value. */ + "sfc-api_TokenResponse": components["schemas"]["sfc-api_TokenScope"] & { + /** + * @example api_token + * @enum {string} + */ + object: "api_token"; + suffix: string; + expires_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + last_used_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + }; + "sfc-api_TokenScope": { + id: components["schemas"]["sfc-api_TokenId"]; + resource_path: components["schemas"]["sfc-api_tokenResourcePath_TokenId"]; + owner: components["schemas"]["sfc-api_Name"]; + name: components["schemas"]["sfc-api_Name"]; + }; + /** @description Response returned only at creation time. Includes the one-time raw token value. */ + "sfc-api_TokenWithValueResponse": components["schemas"]["sfc-api_TokenScope"] & { + /** + * @example api_token + * @enum {string} + */ + object: "api_token"; + /** @description The token value. Only shown once at creation. */ + token: string; + suffix: string; + expires_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + last_used_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + }; + /** @example tokc_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_TokensCursor": string; + "sfc-api_UnauthorizedError": { + error: { + /** @enum {string} */ + type: "authentication_error"; + message: string; + }; + }; + /** + * Format: int64 + * @description Unix timestamp. + * @example 1738972800 + */ + "sfc-api_UnixEpoch": number; + "sfc-api_UnprocessableEntityError": { + error: { + /** @enum {string} */ + type: "unprocessable_entity"; + message: string; + details?: components["schemas"]["sfc-api_ErrorDetail"][]; + }; + }; + "sfc-api_UpdateFeatureFlagRequest": { + feature_flag_id: string; + account_regex?: string | null; + enabled?: boolean | null; + }; + "sfc-api_UpdateFeatureFlagResponse": { + /** + * @example feature_flag + * @enum {string} + */ + object: "feature_flag"; + feature_flag_id: string; + }; + "sfc-api_UpdateRoleRequest": { + name?: null | components["schemas"]["sfc-api_Name"]; + policy?: null | components["schemas"]["sfc-api_Policy"]; + }; + "sfc-api_UpgradeRequiredError": { + error: { + /** @enum {string} */ + type: "upgrade_required"; + message: string; + }; + }; + "sfc-api_UploadPartRequest": { + /** + * Format: int32 + * @description Caller-assigned part number, starting at 1. + */ + part_id: number; + }; + "sfc-api_UploadPartResponse": { + /** @description Presigned URL to upload the part. */ + url: string; + expires_at: components["schemas"]["sfc-api_UnixEpoch"]; + }; + /** + * @example user + * @enum {string} + */ + "sfc-api_UserDiscriminator": "user"; + /** @example my-resource-name */ + "sfc-api_UserId": string; + "sfc-api_UserResponse": { + /** + * @example user + * @enum {string} + */ + object: "user"; + id: components["schemas"]["sfc-api_UserId"]; + resource_path: components["schemas"]["sfc-api_userResourcePath_UserId"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + }; + /** @example usrc_gqXR7s0Kj5mHvE2wNpLc4Q */ + "sfc-api_UsersCursor": string; + /** + * @description The validator only rejects one thing: a instance SKU missing a + * required, live (non-deprecated, non-deleted) key. + * + * Everything else is permitted — callers are free to set keys not in the + * registry, keys that are deprecated or deleted, and enum values that + * aren't in the enumeration table. The registry is descriptive metadata, + * not a whitelist. + */ + "sfc-api_ValidationError": { + key: components["schemas"]["sfc-api_Name"]; + /** @enum {string} */ + kind: "missing_required"; + }; + /** + * @description A verb (action type) in the permission system. + * + * `Wildcard` matches all verbs and serializes as `"*"`. + * + * Variants must stay in sync with the `rule_verb` PostgreSQL enum + * defined in migration 00110. + * @enum {string} + */ + "sfc-api_Verb": "*" | "read" | "write" | "delete" | "list" | "create"; + /** + * @example workspace + * @enum {string} + */ + "sfc-api_WorkspaceDiscriminator": "workspace"; + /** @example wksp_k3R-nX9vLm7Qp2Yw5Jd8F */ + "sfc-api_WorkspaceId": string; + "sfc-api_WorkspaceResponse": components["schemas"]["sfc-api_WorkspaceScope"] & { + /** + * @example workspace + * @enum {string} + */ + object: "workspace"; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + }; + "sfc-api_WorkspaceScope": { + id: components["schemas"]["sfc-api_WorkspaceId"]; + resource_path: components["schemas"]["sfc-api_workspaceResourcePath_WorkspaceId"]; + owner: components["schemas"]["sfc-api_Name"]; + name: components["schemas"]["sfc-api_Name"]; + }; + "sfc-api_WorkspaceSummary": { + id: components["schemas"]["sfc-api_WorkspaceId"]; + name: components["schemas"]["sfc-api_Name"]; + }; + /** + * @description A resource path for a capacity resource. Format: sfc:capacity:::. + * @example sfc:capacity::: + */ + "sfc-api_capacityResourcePath_CapacityId": string; + /** + * @description A resource path for a deployment resource. Format: sfc:deployment:::. + * @example sfc:deployment::: + */ + "sfc-api_deploymentResourcePath_DeploymentId": string; + /** + * @description A resource path for a image resource. Format: sfc:image:::. + * @example sfc:image::: + */ + "sfc-api_imageResourcePath_ImageId": string; + /** + * @description A resource path for a instance resource. Format: sfc:instance:::. + * @example sfc:instance::: + */ + "sfc-api_instanceResourcePath_InstanceId": string; + /** + * @description A resource path for a instance_template resource. Format: sfc:instance_template:::. + * @example sfc:instance_template::: + */ + "sfc-api_instance_templateResourcePath_InstanceTemplateId": string; + /** + * @description A resource path for a procurement resource. Format: sfc:procurement:::. + * @example sfc:procurement::: + */ + "sfc-api_procurementResourcePath_ProcurementId": string; + /** + * @description A resource path for a role resource. Format: sfc:role::. + * @example sfc:role:: + */ + "sfc-api_roleResourcePath_RoleId": string; + /** + * @description A resource path for a token resource. Format: sfc:token::. + * @example sfc:token:: + */ + "sfc-api_tokenResourcePath_TokenId": string; + /** + * @description A resource path for a user resource. Format: sfc:user:. + * @example sfc:user: + */ + "sfc-api_userResourcePath_UserId": string; + "sfc-api_v2.BuyOrderPreviewRequest": { + requirements: components["schemas"]["sfc-api_Requirements"]; + /** @description Order start. Must align to a 60-second boundary. */ + start_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** + * Format: u-int64 + * @description Order duration in seconds. Must be a positive multiple of 60. + */ + duration_seconds: number; + /** + * Format: int32 + * @description Number of nodes. Must be positive. + */ + node_count: number; + capacity?: + | null + | components["schemas"]["sfc-api_ResourcePathOrId_CapacityId"]; + }; + "sfc-api_v2.CapacityTransferResponse": { + /** + * @example capacity_transfer + * @enum {string} + */ + object: "capacity_transfer"; + id: components["schemas"]["sfc-api_CapacityTransferId"]; + status: components["schemas"]["sfc-api_CapacityTransferStatus"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + from_capacity: components["schemas"]["sfc-api_CapacityId"]; + to_capacity: components["schemas"]["sfc-api_CapacityId"]; + /** + * @description Instance SKU the transfer applied to. Carries the SKU's + * human-readable name when one is registered. + */ + instance_sku: components["schemas"]["sfc-api_InstanceSkuSummary"]; + /** @description Reason a capacity transfer was rejected. */ + rejected_reason?: string | null; + /** + * @description The transfer's allocation schedule, expanded into constant-quantity + * rectangles. The final rectangle has `end_at: null` (the unbounded tail); + * gaps are represented as explicit zero-quantity rectangles. + */ + allocation_schedule_delta: components["schemas"]["sfc-api_Schedule"]; + }; + "sfc-api_v2.CreateCapacityTransferRequest": { + /** @description Source capacity (must belong to the authenticated caller). */ + from_capacity: components["schemas"]["sfc-api_ResourcePathOrId_CapacityId"]; + /** @description Destination capacity (must belong to the authenticated caller). */ + to_capacity: components["schemas"]["sfc-api_ResourcePathOrId_CapacityId"]; + /** + * @description The transfer's allocation schedule as constant-quantity rectangles. + * If the final entry does not have `end_at: null`, a zero-quantity + * unbounded tail is appended automatically. + */ + allocation_schedule_delta: components["schemas"]["sfc-api_Schedule"]; + /** @description Instance SKU the transfer applies to. */ + instance_sku: components["schemas"]["sfc-api_InstanceSkuId"]; + }; + "sfc-api_v2.CreateOrderRequest": { + /** @description Target capacity that receives compute when filled. */ + capacity: components["schemas"]["sfc-api_ResourcePathOrId_CapacityId"]; + side: components["schemas"]["sfc-api_Side"]; + /** + * @description If true, the order rests on the order book until it fills, is + * cancelled, or its end time passes. If false, the order is cancelled + * immediately if it does not fill. + */ + allow_standing?: boolean; + /** + * @description Instance SKU this order will fill on. Rejected at submission if the + * SKU id is not registered. + */ + instance_sku: components["schemas"]["sfc-api_InstanceSkuId"]; + /** + * @description Change in capacity if the order fills (added on `buy`, subtracted + * on `sell`). Must be a single time range with both `start_at` and + * `end_at`. + */ + allocation_schedule_delta: components["schemas"]["sfc-api_Schedule"]; + /** + * @description Limit price per node-hour. Decimal string (e.g. `"1.500000"`); rounded + * to per-minute precision on submission. + */ + limit_price_dollars_per_node_hour: components["schemas"]["sfc-api_DollarsPerNodeHour"]; + }; + "sfc-api_v2.ListCapacityTransfersResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + cursor?: null | components["schemas"]["sfc-api_CapacityTransfersCursor"]; + has_more: boolean; + data: components["schemas"]["sfc-api_v2.CapacityTransferResponse"][]; + }; + "sfc-api_v2.ListOrdersResponse": { + /** + * @example list + * @enum {string} + */ + object: "list"; + cursor?: null | components["schemas"]["sfc-api_OrdersCursor"]; + has_more: boolean; + data: components["schemas"]["sfc-api_v2.OrderResponse"][]; + }; + /** @enum {string} */ + "sfc-api_v2.MaintenanceNoticeType": + | "info" + | "degraded_performance" + | "marketplace_unavailable"; + /** @description A single fill event: one contract that was produced when the order matched. */ + "sfc-api_v2.OrderFill": { + contract?: null | components["schemas"]["sfc-api_ContractId"]; + filled_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** + * @description Capacity change this fill delivered. Quantities are always positive; + * `side` on the parent order determines whether this added or removed + * capacity. + */ + allocation_schedule_delta: components["schemas"]["sfc-api_Schedule"]; + price_dollars_per_node_hour: components["schemas"]["sfc-api_DollarsPerNodeHour"]; + }; + /** + * @description Fee charged on fills for the targeted instance SKU. + * + * Total fee = `flat_dollars_per_node_hour × node_count × duration_hours` + * + `percentage_bps / 10000 × execution_total_dollars`. + * + * Recomputed against the realized price at fill time. + */ + "sfc-api_v2.OrderPreviewFee": { + /** @description Flat fee per node-hour. */ + flat_dollars_per_node_hour: components["schemas"]["sfc-api_DollarsPerNodeHour"]; + /** + * Format: int32 + * @description Percentage of execution total, in basis points (10000 = 100%). + */ + percentage_bps: number; + }; + "sfc-api_v2.OrderPreviewNotice": { + start_at: components["schemas"]["sfc-api_UnixEpoch"]; + end_at: components["schemas"]["sfc-api_UnixEpoch"]; + maintenance_type: components["schemas"]["sfc-api_v2.MaintenanceNoticeType"]; + title: string; + description: string; + action_message?: string | null; + /** @enum {string} */ + type: "maintenance_window"; + }; + "sfc-api_v2.OrderPreviewRequest": + | (components["schemas"]["sfc-api_v2.BuyOrderPreviewRequest"] & { + /** @enum {string} */ + side: "buy"; + }) + | (components["schemas"]["sfc-api_v2.SellOrderPreviewRequest"] & { + /** @enum {string} */ + side: "sell"; + }); + "sfc-api_v2.OrderPreviewResponse": + | { + /** + * @description Ready-to-submit body for `POST /v2/orders`. Posting this body + * verbatim will fill at the estimated price. + */ + post_order_body: components["schemas"]["sfc-api_v2.CreateOrderRequest"]; + /** @description Fee policy for the matched instance SKU. */ + fee: components["schemas"]["sfc-api_v2.OrderPreviewFee"]; + /** + * @description Maintenance windows for the matched instance SKU overlapping + * the order's delivery window. + */ + notices?: components["schemas"]["sfc-api_v2.OrderPreviewNotice"][]; + /** @enum {string} */ + type: "quoted"; + } + | { + reason: components["schemas"]["sfc-api_v2.OrderPreviewUnavailableReason"]; + fee?: null | components["schemas"]["sfc-api_v2.OrderPreviewFee"]; + /** + * @description Maintenance windows for the targeted instance SKU overlapping + * the requested order window. + */ + notices?: components["schemas"]["sfc-api_v2.OrderPreviewNotice"][]; + /** @enum {string} */ + type: "unavailable"; + }; + /** @enum {string} */ + "sfc-api_v2.OrderPreviewUnavailableReason": + | "no_matching_instance_skus" + | "no_availability"; + "sfc-api_v2.OrderResponse": { + /** + * @example order + * @enum {string} + */ + object: "order"; + id: components["schemas"]["sfc-api_OrderId"]; + /** + * @description Target capacity that receives or loses compute if this order fills + * (depending on order type). + */ + capacity: components["schemas"]["sfc-api_CapacitySummary"]; + side: components["schemas"]["sfc-api_Side"]; + /** + * @description If true, the order stays in the order book until either fills, is + * explicitly cancelled, or the order end time is reached resulting in + * automatic cancellation. If false, the order is cancelled immediately if + * it doesn't fill. + */ + allow_standing: boolean; + instance_sku?: null | components["schemas"]["sfc-api_InstanceSkuSummary"]; + /** + * @description Change in capacity if the order fills. Must be a single time range + * with both `start_at` and `end_at`. + */ + allocation_schedule_delta: components["schemas"]["sfc-api_Schedule"]; + limit_price_dollars_per_node_hour: components["schemas"]["sfc-api_DollarsPerNodeHour"]; + status: components["schemas"]["sfc-api_OrderStatus"]; + created_at: components["schemas"]["sfc-api_UnixEpoch"]; + filled_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + /** + * Format: int32 + * @description Node count that filled. Equals the order's quantity for complete fills. + */ + filled_quantity?: number | null; + filled_average_price_dollars_per_node_hour?: + | null + | components["schemas"]["sfc-api_DollarsPerNodeHour"]; + /** @description Each contract produced by this order. Empty for unfilled orders. */ + fills?: components["schemas"]["sfc-api_v2.OrderFill"][]; + cancelled_at?: null | components["schemas"]["sfc-api_UnixEpoch"]; + }; + /** @enum {string} */ + "sfc-api_v2.OrderSortBy": + | "created_at" + | "-created_at" + | "start_at" + | "-start_at"; + "sfc-api_v2.SellOrderPreviewRequest": { + capacity?: + | null + | components["schemas"]["sfc-api_ResourcePathOrId_CapacityId"]; + /** @description Order start. Must align to a 60-second boundary. */ + start_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** + * Format: u-int64 + * @description Order duration in seconds. Must be a positive multiple of 60. + */ + duration_seconds: number; + /** + * Format: int32 + * @description Number of nodes. Must be positive. + */ + node_count: number; + requirements: components["schemas"]["sfc-api_Requirements"]; + }; + /** + * @description A resource path for a workspace resource. Format: sfc:workspace::. + * @example sfc:workspace:: + */ + "sfc-api_workspaceResourcePath_WorkspaceId": string; + /** + * @description Quote details with side-specific fields + * + * The response structure differs based on order side: + * - Buy orders include `instance_type` + * - Sell orders include `contract_id` + */ + quoter_ApiQuoteDetails: { + /** + * Format: u-int64 + * @description Total price in cents (USD) + */ + price: number; + /** + * Format: u-int64 + * @description Number of nodes + */ + quantity: number; + /** @description Start time: ISO 8601 or "NOW" */ + start_at: components["schemas"]["quoter_NowOrISO8601DateTime"]; + /** @description End time: ISO 8601 */ + end_at: components["schemas"]["quoter_NowOrISO8601DateTime"]; + /** @description Instance type being quoted */ + instance_type: string; + zone: string; + }; + /** + * @description Response format for GET /v0/quote + * + * Returns a quote object with side-specific details. + * If no quote is available, the `quote` field will be `None`. + */ + quoter_ApiQuoteResponse: { + /** @description Always "quote" */ + object: string; + /** @description Matches the requested side: "buy" or "sell" */ + side: string; + quote?: null | components["schemas"]["quoter_ApiQuoteDetails"]; + no_quote_reason?: null | components["schemas"]["quoter_NoQuoteReason"]; + }; + quoter_BadRequestError: { + error: { + /** @enum {string} */ + type: "invalid_request_error"; + message: string; + details?: components["schemas"]["quoter_ErrorDetail"][]; + }; + }; + quoter_ConflictError: { + error: { + /** @enum {string} */ + type: "conflict"; + message: string; + details?: components["schemas"]["quoter_ErrorDetail"][]; + }; + }; + /** @example cont_k3R-nX9vLm7Qp2Yw5Jd8F */ + quoter_ContractId: string; + quoter_ErrorDetail: { + /** @description The field that caused the error (for validation errors) */ + field?: string; + /** @description Specific error code for this detail */ + code: string; + /** @description Human-readable error message */ + message: string; + }; + /** @enum {string} */ + quoter_ErrorType: + | "api_error" + | "invalid_request_error" + | "authentication_error" + | "idempotency_error" + | "conflict" + | "not_found" + | "request_timed_out" + | "forbidden" + | "not_implemented" + | "upgrade_required" + | "payment_required" + | "service_unavailable" + | "unprocessable_entity" + | "gone"; + quoter_ForbiddenError: { + error: { + /** @enum {string} */ + type: "forbidden"; + message: string; + }; + }; + quoter_GoneError: { + error: { + /** @enum {string} */ + type: "gone"; + message: string; + }; + }; + quoter_InternalServerError: { + error: { + /** @enum {string} */ + type: "api_error"; + message: string; + }; + }; + /** + * @description Reason why a quote could not be provided. + * @enum {string} + */ + quoter_NoQuoteReason: + | "no_matching_clusters" + | "no_availability" + | "bid_price_too_low" + | "ask_price_too_high" + | "internal_solver_error"; + quoter_NotFoundError: { + error: { + /** @enum {string} */ + type: "not_found"; + message: string; + }; + }; + quoter_NotImplementedError: { + error: { + /** @enum {string} */ + type: "not_implemented"; + message: string; + }; + }; + /** + * @description A date/time value that can be either "NOW" or an ISO 8601 datetime string + * @example NOW + * @example 2025-07-11T20:41:37.423Z + */ + quoter_NowOrISO8601DateTime: string; + quoter_PaymentRequiredError: { + error: { + /** @enum {string} */ + type: "payment_required"; + message: string; + }; + }; + /** + * @description Query parameters for GET /v0/quote + * + * # Validation Rules + * + * ## Required Fields + * - `side`: Must be "buy" or "sell" + * - `quantity`: Must be a positive integer (1-1024) + * + * ## Date Constraints + * - `min_start_date` and `max_start_date` accept: + * - "NOW" (literal string for current time) + * - ISO 8601 date string + * - If neither provided, defaults to "NOW" + * - `max_start_date` must be >= `min_start_date` + * + * ## Duration Constraints (mutually exclusive) + * - EITHER provide `duration` (in seconds) + * - OR provide both `min_duration` AND `max_duration` (in seconds) + * - All durations must be positive + * - Maximum duration: 3 years (94,608,000 seconds) + * - When `duration` is provided, it expands to a range: + * - min = duration + * - max = duration + 59 minutes + * + * ## Side-Specific Constraints + * + * ### Buy Orders + * - **Required**: `instance_type` (must be one of: "h100i", "h100v", "h200ki") + * - **Optional**: `colocate_with` (contract ID), `cluster` + * - **Forbidden**: `contract_id` + * + * ### Sell Orders + * - **Required**: `contract_id` (must be owned by authenticated user) + * - **Forbidden**: `instance_type`, `cluster`, `colocate_with` + */ + quoter_QuoteRequestParams: { + side: components["schemas"]["quoter_Side"]; + /** @description Instance type for buy orders: "h100i", "h100v", or "h200ki" */ + instance_type?: string | null; + colocate_with?: null | components["schemas"]["quoter_ContractId"]; + /** @description Cluster constraint (optional) - hostname to resolve to cluster_id */ + cluster?: string | null; + min_start_date?: + | null + | components["schemas"]["quoter_NowOrISO8601DateTime"]; + max_start_date?: + | null + | components["schemas"]["quoter_NowOrISO8601DateTime"]; + /** + * Format: u-int64 + * @description Number of nodes (1-1024) + */ + quantity: number; + /** + * Format: u-int64 + * @description Exact duration in seconds (mutually exclusive with min_duration/max_duration) + */ + duration?: number | null; + /** + * Format: u-int64 + * @description Minimum duration in seconds (must be used with max_duration) + */ + min_duration?: number | null; + /** + * Format: u-int64 + * @description Maximum duration in seconds (must be used with min_duration) + */ + max_duration?: number | null; + }; + quoter_RequestTimedOutError: { + error: { + /** @enum {string} */ + type: "request_timed_out"; + message: string; + }; + }; + quoter_ServiceUnavailableError: { + error: { + /** @enum {string} */ + type: "service_unavailable"; + message: string; + }; + }; + /** @enum {string} */ + quoter_Side: "sell" | "buy"; + quoter_UnauthorizedError: { + error: { + /** @enum {string} */ + type: "authentication_error"; + message: string; + }; + }; + quoter_UnprocessableEntityError: { + error: { + /** @enum {string} */ + type: "unprocessable_entity"; + message: string; + details?: components["schemas"]["quoter_ErrorDetail"][]; + }; + }; + quoter_UpgradeRequiredError: { + error: { + /** @enum {string} */ + type: "upgrade_required"; + message: string; + }; + }; + }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type $defs = Record; +export interface operations { + get_vms_instances: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["vmorch_GetInstancesResponse"]; + }; + }; + 401: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + get_vms_logs2: { + parameters: { + query: { + instance_id: string; + before_seqnum?: number; + since_seqnum?: number; + before_realtime_timestamp?: string; + since_realtime_timestamp?: string; + order_by: "seqnum_asc" | "seqnum_desc"; + limit?: number; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["vmorch_VmsLogsResponse"]; + }; + }; + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + post_vms_replace: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["vmorch_PostReplaceRequest"]; + }; + }; + responses: { + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["vmorch_PostReplaceResponse"]; + }; + }; + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + get_vms_user_data: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["vmorch_GetUserDataResponse"]; + }; + }; + 401: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + post_vms_user_data: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["vmorch_PostUserDataRequest"]; + }; + }; + responses: { + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["vmorch_PostUserDataResponse"]; + }; + }; + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + get_vms_ssh: { + parameters: { + query: { + vm_id: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["vmorch_GetSshResponse"]; + }; + }; + 401: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + list_zones_handler: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description List of zones */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_ListResponse_ZoneInfo"]; + }; + }; + /** @description Unauthorized request */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_ForbiddenError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_InternalServerError"]; + }; + }; + }; + }; + get_zone_handler: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Zone ID */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Zone information */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_ZoneInfo"]; + }; + }; + /** @description Unauthorized request */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_ForbiddenError"]; + }; + }; + /** @description Zone not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_InternalServerError"]; + }; + }; }; - /** - * @description List of transactions for an account - * @example { - * "object": "transactions", - * "transactions": [ - * { - * "id": "tx_1234567890-4", - * "timestamp": "2024-03-15T00:30:00.000Z", - * "direction": "outgoing", - * "status": "accepted", - * "amount": 5000, - * "account_kind": "primary", - * "balance_before": 70000, - * "balance_after": 65000, - * "metadata": { - * "type": "buy", - * "start_time": "2024-11-05T07:24:24.207Z", - * "end_time": "2024-11-05T09:24:24.207Z", - * "quantity": 2, - * "order_id": "ordr_34Az95N", - * "instance_type_requirements": { - * "accelerator_types": [ - * "H100" - * ], - * "interconnect_types": [ - * "Infiniband" - * ], - * "regions": [ - * "NorthAmerica" - * ], - * "delivery_type": "K8s" - * } - * } - * } - * ], - * "pagination": { - * "has_more": true, - * "count": 1, - * "oldest_timestamp": "2024-03-15T00:30:00.000Z", - * "newest_timestamp": "2024-03-15T00:30:00.000Z" - * } - * } - */ - San_Francisco_Compute_Documentation_AccountTransactions: { - /** - * @description The type of the response object - * @example transactions - * @enum {string} - */ - object: "transactions"; - /** @description Transactions for all accounts (see account kind) associated with this user. */ - transactions: components["schemas"]["San_Francisco_Compute_Documentation_Transaction"][]; - /** @description Pagination information */ - pagination: { - /** - * @description Whether there are more transactions available - * @example true - */ - has_more: boolean; + }; + health_handler: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Health check successful */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "text/plain": string; + }; + }; + /** @description Health check failed */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "text/plain": string; + }; + }; + }; + }; + list_nodes_handler: { + parameters: { + query?: { /** - * @description Number of transactions returned - * @example 20 + * @description Filter nodes by node_id + * Use ?id=n_b1dc52505c6db142&id=n_b1dc52505c6db133 to specify multiple IDs. + * Cannot combine with name or node_type */ - count: number; + id?: string[]; /** - * Format: date-time - * @description Timestamp of the oldest transaction returned, useful for pagination - * @example 2024-03-15T00:30:00.000Z + * @description Filter nodes by their names + * Use ?name=val1&name=val2 to specify multiple names. + * Cannot combine with id or node_type */ - oldest_timestamp: string | null; + name?: string[]; /** - * Format: date-time - * @description Timestamp of the newest transaction returned, useful for pagination - * @example 2024-03-15T00:30:00.000Z + * @description Filter nodes by their type + * Cannot combine with id or name + * @example autoreserved */ - newest_timestamp: string | null; + type?: components["schemas"]["node-api_NodeType"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description List of nodes */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_ListResponse_Node"]; + }; + }; + /** @description Bad request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_BadRequestError"]; + }; + }; + /** @description Unauthorized request */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_ForbiddenError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_InternalServerError"]; + }; + }; + }; + }; + create_nodes_handler: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["node-api_CreateNodesRequest"]; + }; + }; + responses: { + /** @description Nodes created successfully */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_ListResponse_Node"]; + }; + }; + /** @description Bad request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_BadRequestError"]; + }; + }; + /** @description Unauthorized request */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_UnauthorizedError"]; + }; + }; + /** @description Payment Required */ + 402: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_PaymentRequiredError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_ForbiddenError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_InternalServerError"]; + }; }; }; - "SF_Compute_K8s_Orchestration_API_frontend_server.BaseCredentialResponse": { - cluster?: components["schemas"]["SF_Compute_K8s_Orchestration_API_frontend_server.ClusterInfo"]; - id?: string; - label?: string; - object?: string; - pubkey?: string; - username?: string; - }; - "SF_Compute_K8s_Orchestration_API_frontend_server.ClusterInfo": { - id?: string; - kubernetes_api_url?: string; - kubernetes_ca_cert?: string; - kubernetes_namespace?: string; - name?: string; - object?: string; - }; - "SF_Compute_K8s_Orchestration_API_frontend_server.CredentialResponse": { - cluster?: components["schemas"]["SF_Compute_K8s_Orchestration_API_frontend_server.ClusterInfo"]; - cluster_type?: string; - encrypted_kubeconfig?: string; - encrypted_token?: string; - ephemeral_pubkey?: string; - id?: string; - label?: string; - nonce?: string; - object?: string; - pubkey?: string; - username?: string; - }; - "SF_Compute_K8s_Orchestration_API_frontend_server.DeleteResponse": { - deleted?: boolean; - id?: string; - object?: string; - }; - "SF_Compute_K8s_Orchestration_API_frontend_server.ListResponse": { - data?: components["schemas"]["SF_Compute_K8s_Orchestration_API_frontend_server.CredentialResponse"][]; - has_more?: boolean; - object?: string; - }; - /** @description Credential request body */ - "SF_Compute_K8s_Orchestration_API_types.KubernetesCredentialBody": { - cluster?: string; - label?: string; - object?: string; - pubkey?: string; - username?: string; - }; - /** - * @description Unique identifier with prefix 'cap_'. - * @example cap_k3R-nX9vLm7Qp2Yw5Jd8F - */ - vmorch_CapacityId: string; - vmorch_CompleteUploadRequest: { - sha256_hash: string; - }; - vmorch_CompleteUploadResponse: { - /** - * @example image - * @enum {string} - */ - object?: "image"; - upload_status: components["schemas"]["vmorch_ImageUploadStatus"]; - id: components["schemas"]["vmorch_ImageId"]; - }; - vmorch_ErrorDetail: { - /** @description The field that caused the error (for validation errors) */ - field?: string | null; - /** @description Specific error code for this detail */ - code: string; - /** @description Human-readable error message */ - message: string; - }; - /** @enum {string} */ - vmorch_ErrorType: - | "api_error" - | "invalid_request_error" - | "authentication_error" - | "idempotency_error" - | "conflict" - | "not_found" - | "request_timed_out" - | "forbidden" - | "not_implemented" - | "upgrade_required" - | "payment_required" - | "service_unavailable" - | "unprocessable_entity"; - vmorch_GetInstancesResponse: { - data: components["schemas"]["vmorch_VmInstance"][]; - }; - vmorch_GetSshResponse: { - ssh_hostname: string; - /** Format: u-int16 */ - ssh_port: number; - ssh_host_keys?: components["schemas"]["vmorch_SshHostKeyInfo"][] | null; - last_successful_key_update?: - | null - | components["schemas"]["vmorch_UnixEpoch"]; - last_attempted_key_update?: - | null - | components["schemas"]["vmorch_UnixEpoch"]; - }; - vmorch_GetUserDataResponse: { - script: components["schemas"]["vmorch_UserData"]; - }; - /** - * @example image - * @enum {string} - */ - vmorch_ImageDiscriminator: "image"; - vmorch_ImageDownloadResponse: { - url: string; - expires_at: components["schemas"]["vmorch_UnixEpoch"]; - sha256_hash: string; - /** Format: u-int64 */ - object_size: number; + }; + get_node_handler: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Node ID or name */ + id: string; + }; + cookie?: never; }; - /** - * @description Unique identifier with prefix 'image_'. - * @example image_k3R-nX9vLm7Qp2Yw5Jd8F - */ - vmorch_ImageId: string; - vmorch_ImageInfo: { - /** - * @example image - * @enum {string} - */ - object?: "image"; - id: components["schemas"]["vmorch_ImageId"]; - name: components["schemas"]["vmorch_Name"]; - upload_status: components["schemas"]["vmorch_ImageUploadStatus"]; - sha256_hash?: string | null; - created_at: components["schemas"]["vmorch_UnixEpoch"]; + requestBody?: never; + responses: { + /** @description Node details */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_Node"]; + }; + }; + /** @description Bad request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_BadRequestError"]; + }; + }; + /** @description Unauthorized request */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_ForbiddenError"]; + }; + }; + /** @description Node not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_InternalServerError"]; + }; + }; }; - vmorch_ImageResponse: { - /** - * @example image - * @enum {string} - */ - object?: "image"; - id: components["schemas"]["vmorch_ImageId"]; - name: components["schemas"]["vmorch_Name"]; - upload_status: components["schemas"]["vmorch_ImageUploadStatus"]; - sha256_hash?: string | null; - created_at: components["schemas"]["vmorch_UnixEpoch"]; + }; + delete_node_handler: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Node ID or name */ + id: string; + }; + cookie?: never; }; - /** @description Request body for image upload presigned URL generation */ - vmorch_ImageUploadRequest: { - /** - * Format: int32 - * @description part idx (1-based) - */ - part_id: number; + requestBody?: never; + responses: { + /** @description Node deleted successfully */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_BadRequestError"]; + }; + }; + /** @description Unauthorized request */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_ForbiddenError"]; + }; + }; + /** @description Node not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_InternalServerError"]; + }; + }; }; - /** @description Response body for image upload presigned URL generation */ - vmorch_ImageUploadResponse: { - /** @description The presigned URL that can be used to upload the image part */ - upload_url: string; - /** @description Timestamp when the presigned URL expires (RFC 3339 format) */ - expires_at: string; + }; + extend_node_handler: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Node ID or name */ + id: string; + }; + cookie?: never; }; - /** @enum {string} */ - vmorch_ImageUploadStatus: "started" | "uploading" | "completed" | "failed"; - /** - * @description Opaque pagination cursor for ImagesCursor. Wire format: `imgc_{base64url}`. - * @example imgc_gqXR7s0Kj5mHvE2wNpLc4Q - */ - vmorch_ImagesCursor: string; - vmorch_ListImagesResponse: { - /** - * @example list - * @enum {string} - */ - object: "list"; - cursor?: null | components["schemas"]["vmorch_ImagesCursor"]; - has_more: boolean; - data: components["schemas"]["vmorch_ImageInfo"][]; + requestBody: { + content: { + "application/json": components["schemas"]["node-api_ExtendNodeRequest"]; + }; }; - vmorch_ListNodesResponse: { - /** - * @example list - * @enum {string} - */ - object: "list"; - cursor?: null | components["schemas"]["vmorch_NodesCursor"]; - has_more: boolean; - data: components["schemas"]["vmorch_NodeResponse"][]; + responses: { + /** @description Node extended successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_Node"]; + }; + }; + /** @description Bad request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_BadRequestError"]; + }; + }; + /** @description Unauthorized request */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_UnauthorizedError"]; + }; + }; + /** @description Insufficient balance */ + 402: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_PaymentRequiredError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_ForbiddenError"]; + }; + }; + /** @description Node not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_NotFoundError"]; + }; + }; + /** @description Extension failed due to capacity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_InternalServerError"]; + }; + }; }; - /** - * @description A validated resource name. Must start with alphanumeric, followed by alphanumeric, '.', '_', or '-'. Max 255 characters. - * @example my-resource-name - */ - vmorch_Name: string; - /** - * @description Unique identifier with prefix 'node_'. - * @example node_k3R-nX9vLm7Qp2Yw5Jd8F - */ - vmorch_NodeId: string; - vmorch_NodeLogChunk: { - /** - * @example logs_chunk - * @enum {string} - */ - object?: "logs_chunk"; - node_id: components["schemas"]["vmorch_NodeId"]; - /** @description Wall-clock time as a unix timestamp (seconds). */ - timestamp_realtime: components["schemas"]["vmorch_UnixEpoch"]; - /** - * Format: int64 - * @description Monotonic clock seconds. - */ - timestamp_monotonic_secs: number; - /** - * Format: u-int32 - * @description Nanosecond component of the monotonic clock. - */ - timestamp_monotonic_nanos: number; - /** Format: u-int64 */ - seqnum: number; - data: number[]; + }; + redeploy_node_handler: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Node ID or name */ + id: string; + }; + cookie?: never; }; - vmorch_NodeLogsResponse: { - /** - * @example list - * @enum {string} - */ - object: "list"; - data: components["schemas"]["vmorch_NodeLogChunk"][]; + requestBody: { + content: { + "application/json": components["schemas"]["node-api_RedeployNodeRequest"]; + }; }; - vmorch_NodeResponse: { - /** - * @example node - * @enum {string} - */ - object?: "node"; - id: components["schemas"]["vmorch_NodeId"]; - status: components["schemas"]["vmorch_NodeStatus"]; - capacity: components["schemas"]["vmorch_CapacityId"]; - template: components["schemas"]["vmorch_NodeTemplateId"]; + responses: { + /** @description Node redeployed successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_Node"]; + }; + }; + /** @description Bad request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_BadRequestError"]; + }; + }; + /** @description Unauthorized request */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_ForbiddenError"]; + }; + }; + /** @description Node not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_NotFoundError"]; + }; + }; + /** @description Redeploy failed due to invalid state */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_InternalServerError"]; + }; + }; }; - vmorch_NodeSshHostKey: { - /** - * @description Key algorithm (e.g. `ssh-ed25519`, `ssh-rsa`). - * @example ssh-ed25519 - * @example ssh-rsa - */ - key_type: string; - base64_encoded_key: string; + }; + release_node_handler: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Node ID or name */ + id: string; + }; + cookie?: never; }; - vmorch_NodeSshInfo: { - /** @example 24.125.89.203 */ - ssh_hostname: string; - /** - * Format: u-int16 - * @example 22 - */ - ssh_port: number; - ssh_host_keys: components["schemas"]["vmorch_NodeSshHostKey"][]; - last_successful_key_update?: - | null - | components["schemas"]["vmorch_UnixEpoch"]; - last_attempted_key_update?: - | null - | components["schemas"]["vmorch_UnixEpoch"]; + requestBody?: never; + responses: { + /** @description Node released successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_Node"]; + }; + }; + /** @description Bad request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_BadRequestError"]; + }; + }; + /** @description Unauthorized request */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_ForbiddenError"]; + }; + }; + /** @description Node not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_NotFoundError"]; + }; + }; + /** @description Node already released */ + 409: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_ConflictError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["node-api_InternalServerError"]; + }; + }; }; - /** @enum {string} */ - vmorch_NodeStatus: "pending" | "running" | "terminated" | "node_failure"; - /** - * @description Unique identifier with prefix 'ntmpl_'. - * @example ntmpl_k3R-nX9vLm7Qp2Yw5Jd8F - */ - vmorch_NodeTemplateId: string; - /** - * @description Opaque pagination cursor for NodesCursor. Wire format: `nodec_{base64url}`. - * @example nodec_gqXR7s0Kj5mHvE2wNpLc4Q - */ - vmorch_NodesCursor: string; - vmorch_PostReplaceRequest: { - vm_id: string; + }; + listClusters: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - vmorch_PostReplaceResponse: { - replaced: string; - replaced_by: string; + requestBody?: never; + responses: { + /** @description List of Kubernetes clusters */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "list", + * "data": [ + * { + * "object": "kubernetes_cluster", + * "name": "starlight", + * "kubernetes_namespace": "sf-user123", + * "kubernetes_api_url": "https://starlight.sf-k8s.com", + * "kubernetes_ca_cert": "-----BEGIN CERTIFICATE-----...", + * "contract": { + * "object": "contract", + * "status": "active", + * "id": "cont_xyz123", + * "created_at": "2024-07-15T22:30:17.426Z", + * "instance_type": "h100i", + * "shape": { + * "intervals": [ + * "2024-07-16T00:00:00Z", + * "2024-07-17T00:00:00Z" + * ], + * "quantities": [ + * 4, + * 0 + * ] + * }, + * "colocate_with": [], + * "cluster_id": "clstr_abc456", + * "state": "Active", + * "is_node": false + * } + * } + * ], + * "has_more": false + * } + */ + "application/json": components["schemas"]["market-api_ListClustersResponse"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "authentication_error", + * "message": "missing authentication token" + * } + * } + */ + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden - account frozen */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "forbidden", + * "message": "Account is frozen" + * } + * } + */ + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "api_error", + * "message": "An internal server error occurred" + * } + * } + */ + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - vmorch_PostUserDataRequest: { - script: components["schemas"]["vmorch_UserData"]; + }; + listContracts: { + parameters: { + query?: { + /** + * @description Filter by instance type + * @example h100i + */ + instance_type?: components["schemas"]["market-api_Ticker"]; + /** + * @description Start of interval to find active contracts. Must be used with active_within_interval_end + * @example 2024-01-01T00:00:00Z + */ + active_within_interval_start?: components["schemas"]["market-api_ISO8601DateTime"]; + /** + * @description End of interval to find active contracts. Must be used with active_within_interval_start + * @example 2024-01-02T00:00:00Z + */ + active_within_interval_end?: components["schemas"]["market-api_ISO8601DateTime"]; + /** + * @description Filter by contract state. Options: "All", "Upcoming", "Active", "Expired". Default excludes expired contracts + * @example Active + */ + state?: string; + /** + * @description Include contracts managed by the Nodes API + * @example true + */ + include_nodes?: boolean; + /** + * @description Include contracts associated with procurements + * @example true + */ + include_procurements?: boolean; + }; + header?: never; + path?: never; + cookie?: never; }; - vmorch_PostUserDataResponse: { - script: components["schemas"]["vmorch_UserData"]; + requestBody?: never; + responses: { + /** @description List of contracts */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "list", + * "data": [ + * { + * "object": "contract", + * "status": "active", + * "id": "cont_xyz789", + * "created_at": "2024-07-15T22:30:17.426Z", + * "instance_type": "h100i", + * "shape": { + * "intervals": [ + * "2024-07-16T00:00:00Z", + * "2024-07-17T00:00:00Z" + * ], + * "quantities": [ + * 10, + * 0 + * ] + * }, + * "state": "Active", + * "is_node": false, + * "procurement_id": "proc_1234567890abcdef" + * } + * ], + * "has_more": false + * } + */ + "application/json": components["schemas"]["market-api_ListContractsResponse"]; + }; + }; + /** @description Bad request - invalid query parameters */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "invalid_request_error", + * "message": "must provide both active_within_interval_start and active_within_interval_end or none of them" + * } + * } + */ + "application/json": components["schemas"]["market-api_BadRequestError"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "authentication_error", + * "message": "missing authentication token" + * } + * } + */ + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden - account frozen */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "forbidden", + * "message": "Account is frozen" + * } + * } + */ + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "api_error", + * "message": "An internal server error occurred" + * } + * } + */ + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - vmorch_ReplaceNodeRequest: { - /** @description Image to boot the replacement node. Defaults to the capacity's configured image. */ - template?: string | null; + }; + getContract: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description Contract ID + * @example cont_xyz789 + */ + id: components["schemas"]["market-api_ContractId"]; + }; + cookie?: never; }; - /** @description SFC standard error response */ - vmorch_SerdeErrorProxy: { - /** @description The error type identifier */ - type: components["schemas"]["vmorch_ErrorType"]; - /** @description Human-readable error message */ - message: string; - /** @description Array of detailed error information when applicable */ - details: components["schemas"]["vmorch_ErrorDetail"][]; + requestBody?: never; + responses: { + /** @description Contract details */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "contract", + * "status": "active", + * "id": "cont_xyz789", + * "created_at": "2024-07-15T22:30:17.426Z", + * "instance_type": "h100i", + * "shape": { + * "intervals": [ + * "2024-07-16T22:30:16Z", + * "2024-07-17T22:30:16Z", + * "2024-07-18T22:30:16Z" + * ], + * "quantities": [ + * 10, + * 20, + * 0 + * ] + * }, + * "colocate_with": [ + * "cont_abc456" + * ], + * "cluster_id": "clus_xyz123", + * "state": "Active", + * "is_node": false, + * "procurement_id": "proc_1234567890abcdef" + * } + */ + "application/json": components["schemas"]["market-api_ContractResponse"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "authentication_error", + * "message": "missing authentication token" + * } + * } + */ + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden - account frozen */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "forbidden", + * "message": "Account is frozen" + * } + * } + */ + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Contract not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "not_found", + * "message": "Contract not found" + * } + * } + */ + "application/json": components["schemas"]["market-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "api_error", + * "message": "An internal server error occurred" + * } + * } + */ + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - vmorch_SshHostKeyInfo: { - key_type: string; - /** Format: byte */ - base64_encoded_key: string; + }; + listOrders: { + parameters: { + query?: { + /** @description Filter by order side (buy or sell) */ + side?: components["schemas"]["market-api_OrderSide"]; + /** @description Filter by instance type */ + instance_type?: components["schemas"]["market-api_Ticker"]; + /** @description Minimum price in cents */ + min_price?: number; + /** @description Maximum price in cents */ + max_price?: number; + /** @description Minimum start date */ + min_start_date?: components["schemas"]["market-api_ISO8601DateTime"]; + /** @description Maximum start date */ + max_start_date?: components["schemas"]["market-api_ISO8601DateTime"]; + /** @description Minimum duration in seconds */ + min_duration?: components["schemas"]["market-api_UnixEpoch"]; + /** @description Maximum duration in seconds */ + max_duration?: components["schemas"]["market-api_UnixEpoch"]; + /** @description Minimum quantity */ + min_quantity?: number; + /** @description Maximum quantity */ + max_quantity?: number; + /** @description Filter by contract ID */ + contract_id?: components["schemas"]["market-api_ContractId"]; + /** @description Show only open orders */ + only_open?: boolean; + /** @description Exclude filled orders */ + exclude_filled?: boolean; + /** @description Show only filled orders */ + only_filled?: boolean; + /** @description Minimum filled at date */ + min_filled_at?: components["schemas"]["market-api_ISO8601DateTime"]; + /** @description Maximum filled at date */ + max_filled_at?: components["schemas"]["market-api_ISO8601DateTime"]; + /** @description Minimum fill price in cents */ + min_fill_price?: number; + /** @description Maximum fill price in cents */ + max_fill_price?: number; + /** @description Exclude cancelled orders */ + exclude_cancelled?: boolean; + /** @description Show only cancelled orders */ + only_cancelled?: boolean; + /** @description Minimum cancelled at date */ + min_cancelled_at?: components["schemas"]["market-api_ISO8601DateTime"]; + /** @description Maximum cancelled at date */ + max_cancelled_at?: components["schemas"]["market-api_ISO8601DateTime"]; + /** @description Minimum placed at date */ + min_placed_at?: components["schemas"]["market-api_ISO8601DateTime"]; + /** @description Maximum placed at date */ + max_placed_at?: components["schemas"]["market-api_ISO8601DateTime"]; + /** @description Maximum number of results to return (default: 100, max: 100) */ + limit?: number; + /** @description Number of results to skip */ + offset?: number; + /** @description Sort field */ + sort_by?: components["schemas"]["market-api_SortBy"]; + /** @description Sort direction */ + sort_direction?: components["schemas"]["market-api_SortDirection"]; + include_public?: unknown; + }; + header?: never; + path?: never; + cookie?: never; }; - /** @description Request body for starting a multipart upload */ - vmorch_StartMultipartUploadRequest: { - /** @description Name of the image file. Must be unique per account. */ - name: string; + requestBody?: never; + responses: { + /** @description List of orders */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "list", + * "data": [ + * { + * "object": "order", + * "id": "ordr_xyz123", + * "side": "buy", + * "instance_type": "h100i", + * "price": 1600, + * "quantity": 2, + * "status": "open", + * "created_at": "2024-07-15T22:30:17.426Z", + * "start_at": "2024-07-16T00:00:00Z", + * "end_at": "2024-07-17T00:00:00Z", + * "flags": { + * "ioc": false, + * "post_only": false, + * "market": false, + * "prorate": false + * } + * } + * ], + * "has_more": false + * } + */ + "application/json": components["schemas"]["market-api_ListOrdersResponse"]; + }; + }; + /** @description Invalid request parameters */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "invalid_request_error", + * "message": "Cannot specify both 'only_filled' and 'only_cancelled'" + * } + * } + */ + "application/json": components["schemas"]["market-api_BadRequestError"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "authentication_error", + * "message": "missing authentication token" + * } + * } + */ + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden - account frozen */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "forbidden", + * "message": "Account is frozen" + * } + * } + */ + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "api_error", + * "message": "An internal server error occurred" + * } + * } + */ + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - /** @description Response body for starting a multipart upload */ - vmorch_StartMultipartUploadResponse: { - object: components["schemas"]["vmorch_ImageDiscriminator"]; - /** @description The image ID for the created image */ - image_id: string; + }; + createOrder: { + parameters: { + query?: never; + header?: { + /** @description Optional key to ensure idempotent order creation */ + "Idempotency-Key"?: string | null; + }; + path?: never; + cookie?: never; }; - vmorch_StartUploadRequest: { - name: components["schemas"]["vmorch_Name"]; - /** @description Workspace URN (e.g. sfc:workspace:{account_id}:default). */ - workspace?: string; + requestBody: { + content: { + "application/json": components["schemas"]["market-api_CreateOrderRequest"]; + }; }; - /** - * Format: int64 - * @description Unix timestamp in seconds since epoch - * @example 1738972800 - */ - vmorch_UnixEpoch: number; - vmorch_UploadPartRequest: { - /** Format: int32 */ - part_id: number; + responses: { + /** @description Order created successfully */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "order", + * "status": "pending", + * "id": "order_xyz789", + * "idempotency_key": "key_123" + * } + */ + "application/json": components["schemas"]["market-api_CreateOrderResponse"]; + }; + }; + /** @description Invalid request parameters */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "type": "invalid_request_error", + * "message": "Start time must be within +/- 1 minute of now, on a future hour, or the string literal 'NOW'", + * "details": [] + * } + */ + "application/json": components["schemas"]["market-api_BadRequestError"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "type": "authentication_error", + * "message": "missing authentication token", + * "details": [] + * } + */ + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden - account frozen, insufficient credits, unauthorized seller, or trading halted */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "type": "forbidden", + * "message": "Account is frozen", + * "details": [] + * } + */ + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Not found - contract or cluster not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "type": "not_found", + * "message": "Contract not found", + * "details": [] + * } + */ + "application/json": components["schemas"]["market-api_NotFoundError"]; + }; + }; + /** @description Upgrade required - legacy account needs migration */ + 426: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "type": "invalid_request_error", + * "message": "Legacy account must be upgraded before placing orders", + * "details": [] + * } + */ + "application/json": components["schemas"]["market-api_UpgradeRequiredError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "type": "api_error", + * "message": "An internal server error occurred", + * "details": [] + * } + */ + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - vmorch_UploadPartResponse: { - upload_url: string; - expires_at: components["schemas"]["vmorch_UnixEpoch"]; + }; + getOrder: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description Order ID + * @example order_xyz789 + */ + id: components["schemas"]["market-api_OrderId"]; + }; + cookie?: never; }; - /** @description if the script is valid utf8 then the response may be in either string, or byte form and the client must handle both */ - vmorch_UserData: string | number[]; - vmorch_VmInstance: { - id: string; - cluster_id: string; - current_status: string; - last_updated_at: string; + requestBody?: never; + responses: { + /** @description Order details */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "order", + * "id": "order_xyz789", + * "side": "buy", + * "status": "open", + * "instance_type": "h100i", + * "quantity": 4, + * "start_at": "2021-01-01T00:00:00Z", + * "end_at": "2021-01-01T01:00:00Z", + * "price": 2850000, + * "flags": { + * "market": false, + * "post_only": false, + * "ioc": false + * }, + * "executed": false, + * "cancelled": false, + * "colocate_with": [], + * "created_at": "2021-01-01T00:00:00Z", + * "rejected": false + * } + */ + "application/json": components["schemas"]["market-api_OrderResponse"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "type": "authentication_error", + * "message": "missing authentication token", + * "details": [] + * } + */ + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden - user not authorized to view this order */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "type": "forbidden", + * "message": "User not authorized to view this order", + * "details": [] + * } + */ + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Order not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "type": "not_found", + * "message": "Order not found", + * "details": [] + * } + */ + "application/json": components["schemas"]["market-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "type": "api_error", + * "message": "An internal server error occurred", + * "details": [] + * } + */ + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - vmorch_VmsLogChunk: { - instance_id: string; - /** @description In RFC 3339 format */ - realtime_timestamp: string; - /** Format: u-int64 */ - monotonic_timestamp_sec: number; - /** Format: u-int32 */ - monotonic_timestamp_nano_sec: number; - /** Format: u-int64 */ - seqnum: number; - data: number[]; + }; + cancelOrder: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description Order ID + * @example ordr_xyz789 + */ + id: components["schemas"]["market-api_OrderId"]; + }; + cookie?: never; }; - vmorch_VmsLogsResponse: { - data: components["schemas"]["vmorch_VmsLogChunk"][]; + requestBody?: never; + responses: { + /** @description Order cancelled successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "pending" + * } + */ + "application/json": components["schemas"]["market-api_CancelOrderResponse"]; + }; + }; + /** @description Order already cancelled */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "type": "validation_error", + * "message": "Order already cancelled", + * "details": [] + * } + */ + "application/json": components["schemas"]["market-api_BadRequestError"]; + }; + }; + /** @description Order not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "type": "not_found", + * "message": "Order not found", + * "details": [] + * } + */ + "application/json": components["schemas"]["market-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "type": "api_error", + * "message": "An internal server error occurred", + * "details": [] + * } + */ + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - /** @enum {string} */ - "node-api_AcceleratorType": "H100" | "H200"; - "node-api_AvailabilityRectangle": { - start_timestamp: components["schemas"]["node-api_UnixEpoch"]; - end_timestamp: components["schemas"]["node-api_UnixEpoch"]; - /** - * Format: u-int64 - * @description The number of nodes available during this time period - */ - quantity: number; + }; + getOrderClusters: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description Order ID + * @example ordr_W9TRG + */ + id: components["schemas"]["market-api_OrderId"]; + }; + cookie?: never; }; - "node-api_CreateNodesRequest": { - /** - * Format: u-int32 - * @example 1 - */ - desired_count: number; - /** - * @description Zone to create the nodes in. Required for auto reserved nodes if any_zone is false. - * @example hayesvalley - */ - zone?: string; - /** - * @description Allow auto reserved nodes to be created in any zone that meets the requirements - * @default false - * @example false - */ - any_zone: boolean; - /** - * Format: int64 - * @description Max price per hour for a node in cents - * @example 1600 - */ - max_price_per_node_hour: number; - /** - * Format: int64 - * @description Start time as Unix timestamp in seconds - * Optional for reserved nodes. If not provided, defaults to now - * @example 1640995200 - */ - start_at?: number; - /** - * Format: int64 - * @description End time as Unix timestamp in seconds - * If provided, end time must be aligned to the hour - * If not provided, the node will be created as an autoreserved node - */ - end_at?: number | null; - /** @default autoreserved */ - node_type: null | components["schemas"]["node-api_NodeType"]; - /** - * @description Custom node names - * Names cannot begin with 'vm_' or 'n_' as this is reserved for system-generated IDs - * Names cannot be numeric strings - * Names cannot exceed 128 characters - * @example [ - * "cuda-crunch" - * ] - */ - names?: string[]; - /** - * Format: byte - * @description User script to be executed during the VM's boot process - * Data should be base64 encoded - * @example aGVsbG8gd29ybGQ= - */ - cloud_init_user_data?: string; - /** - * @description Custom image ID to use for the VM instances - * @example vmi_1234567890abcdef - */ - image_id?: string; - /** - * @description (Optional) If set, enables forwarding to the VM on port 443. - * @default false - * @example false - */ - forward_443: boolean; + requestBody?: never; + responses: { + /** @description List of clusters associated with the order */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "list", + * "data": [ + * { + * "object": "kubernetes_cluster", + * "name": "starlight", + * "kubernetes_namespace": "sf-user123", + * "kubernetes_api_url": "https://starlight.sf-k8s.com", + * "kubernetes_ca_cert": "-----BEGIN CERTIFICATE-----...", + * "contract": { + * "object": "contract", + * "status": "active", + * "id": "cont_xyz123", + * "created_at": "2024-07-15T22:30:17.426Z", + * "instance_type": "h100i", + * "shape": { + * "intervals": [ + * "2024-07-16T00:00:00Z", + * "2024-07-17T00:00:00Z" + * ], + * "quantities": [ + * 4, + * 0 + * ] + * }, + * "colocate_with": [], + * "cluster_id": "clstr_abc456", + * "state": "Active", + * "is_node": false + * } + * } + * ], + * "has_more": false + * } + */ + "application/json": components["schemas"]["market-api_ListClustersResponse"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "authentication_error", + * "message": "missing authentication token" + * } + * } + */ + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden - account frozen */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "forbidden", + * "message": "Account is frozen" + * } + * } + */ + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Order not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "not_found", + * "message": "Order not found" + * } + * } + */ + "application/json": components["schemas"]["market-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "api_error", + * "message": "An internal server error occurred" + * } + * } + */ + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - /** @enum {string} */ - "node-api_DeliveryType": "K8s" | "VM"; - "node-api_ErrorContent": { - type: components["schemas"]["node-api_ErrorType"]; - message: string; - details?: components["schemas"]["node-api_ErrorDetail"][]; + }; + listProcurements: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - "node-api_ErrorDetail": { - /** @description The field that caused the error (for validation errors) */ - field?: string | null; - /** @description Specific error code for this detail */ - code: string; - /** @description Human-readable error message */ - message: string; + requestBody?: never; + responses: { + /** @description List of procurements */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "list", + * "data": [ + * { + * "object": "procurement", + * "id": "proc_test123", + * "status": "active", + * "instance_type": "h100i", + * "desired_quantity": 5, + * "buy_limit_price_per_gpu_hour": 250, + * "sell_limit_price_per_gpu_hour": 25, + * "horizon": 60, + * "colocation_strategy": "colocate_pinned", + * "actual_quantity": 5, + * "active_order_count": 2, + * "last_message": "Running" + * } + * ], + * "has_more": false + * } + */ + "application/json": components["schemas"]["market-api_ListProcurementsResponse"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "authentication_error", + * "message": "missing authentication token" + * } + * } + */ + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden - account frozen */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "forbidden", + * "message": "Account is frozen" + * } + * } + */ + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "api_error", + * "message": "An internal server error occurred" + * } + * } + */ + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - "node-api_ErrorKind": - | { - message: string; - details?: components["schemas"]["node-api_ErrorDetail"][]; - /** @enum {string} */ - type: "api_error"; - } - | { - message: string; - details?: components["schemas"]["node-api_ErrorDetail"][]; - /** @enum {string} */ - type: "invalid_request_error"; - } - | { - message: string; - details?: components["schemas"]["node-api_ErrorDetail"][]; - /** @enum {string} */ - type: "authentication_error"; - } - | { - message: string; - details?: components["schemas"]["node-api_ErrorDetail"][]; - /** @enum {string} */ - type: "idempotency_error"; - } - | { - message: string; - details?: components["schemas"]["node-api_ErrorDetail"][]; - /** @enum {string} */ - type: "conflict"; - } - | { - message: string; - details?: components["schemas"]["node-api_ErrorDetail"][]; - /** @enum {string} */ - type: "not_found"; - } - | { - message: string; - details?: components["schemas"]["node-api_ErrorDetail"][]; - /** @enum {string} */ - type: "request_timed_out"; - } - | { - message: string; - details?: components["schemas"]["node-api_ErrorDetail"][]; - /** @enum {string} */ - type: "forbidden"; - } - | { - message: string; - details?: components["schemas"]["node-api_ErrorDetail"][]; - /** @enum {string} */ - type: "not_implemented"; - } - | { - message: string; - details?: components["schemas"]["node-api_ErrorDetail"][]; - /** @enum {string} */ - type: "upgrade_required"; - } - | { - message: string; - details?: components["schemas"]["node-api_ErrorDetail"][]; - /** @enum {string} */ - type: "payment_required"; + }; + createProcurement: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["market-api_CreateProcurementRequest"]; + }; + }; + responses: { + /** @description Successfully created procurement */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "procurement", + * "id": "proc_xyz123", + * "status": "active", + * "instance_type": "h100i", + * "desired_quantity": 5, + * "buy_limit_price_per_gpu_hour": 250, + * "sell_limit_price_per_gpu_hour": 25, + * "horizon": 60, + * "colocation_strategy": "colocate_pinned", + * "actual_quantity": 0, + * "active_order_count": 0 + * } + */ + "application/json": components["schemas"]["market-api_ProcurementResponse"]; + }; + }; + /** @description Bad request - invalid field values */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "invalid_request_error", + * "message": "desired_quantity must be non-negative" + * } + * } + */ + "application/json": components["schemas"]["market-api_BadRequestError"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "authentication_error", + * "message": "missing authentication token" + * } + * } + */ + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; + }; + /** @description Payment required - insufficient funds */ + 402: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "payment_required", + * "message": "insufficient funds" + * } + * } + */ + "application/json": components["schemas"]["market-api_PaymentRequiredError"]; }; - "node-api_ErrorObject": { - error: components["schemas"]["node-api_ErrorContent"]; - }; - /** @enum {string} */ - "node-api_ErrorType": - | "api_error" - | "invalid_request_error" - | "authentication_error" - | "idempotency_error" - | "conflict" - | "not_found" - | "request_timed_out" - | "forbidden" - | "not_implemented" - | "upgrade_required" - | "payment_required" - | "service_unavailable" - | "unprocessable_entity"; - "node-api_ExtendNodeRequest": { - /** - * Format: int64 - * @description Duration in seconds to extend the node - * Must be at least 1 hour (3600 seconds) and a multiple of 1 hour. - * @example 7200 - */ - duration_seconds: number; - /** - * Format: int64 - * @description Max price per hour for the extension in cents - * @example 1000 - */ - max_price_per_node_hour: number; + }; + /** @description Forbidden - account frozen */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "forbidden", + * "message": "Account is frozen" + * } + * } + */ + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Not found - cluster not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "not_found", + * "message": "cluster starlight not found" + * } + * } + */ + "application/json": components["schemas"]["market-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "api_error", + * "message": "An internal server error occurred" + * } + * } + */ + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - /** @enum {string} */ - "node-api_InterconnectType": "Infiniband" | "None"; - "node-api_ListResponse_Node": { - /** @example list */ - object: string; - data: { - /** @example node */ - object: string; - /** @example n_b1dc52505c6db142 */ - id: string; - /** @example cuda-crunch */ - name: string; - /** @example hayesvalley */ - zone?: string | null; - gpu_type: components["schemas"]["node-api_AcceleratorType"]; - /** @example sfcompute */ - owner: string; - status: components["schemas"]["node-api_Status"]; - /** - * Format: int64 - * @description Creation time as Unix timestamp in seconds - * @example 1640995200 - */ - created_at?: number | null; - /** - * Format: int64 - * @description Last updated time as Unix timestamp in seconds - * @example 1640995200 - */ - updated_at?: number | null; - /** - * Format: int64 - * @description Start time as Unix timestamp in seconds - * @example 1640995200 - */ - start_at?: number | null; - /** - * Format: int64 - * @description End time as Unix timestamp in seconds - * @example 1640995200 - */ - end_at?: number | null; - /** - * Format: int64 - * @description Deletion time as Unix timestamp in seconds - * @example 1640995200 - */ - deleted_at?: number | null; - /** @example proc_b1dc52505c6de142 */ - procurement_id?: string | null; + }; + getProcurement: { + parameters: { + query?: never; + header?: never; + path: { /** - * Format: int64 - * @description Max price per hour you're willing to pay for a node in cents - * @example 1000 + * @description Procurement ID + * @example proc_xyz123 */ - max_price_per_node_hour?: number | null; - node_type: components["schemas"]["node-api_NodeType"]; - vms?: null | components["schemas"]["node-api_VmList"]; - current_vm?: null | components["schemas"]["node-api_Vm"]; - }[]; + id: string; + }; + cookie?: never; }; - "node-api_ListResponse_ZoneInfo": { - /** @example list */ - object: string; - data: { - object: string; - name: string; - /** @description User-facing zone name (e.g., "Hayes Valley", "Land's End") */ - display_name?: string | null; + requestBody?: never; + responses: { + /** @description Procurement details */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "procurement", + * "id": "proc_xyz123", + * "status": "active", + * "instance_type": "h100i", + * "desired_quantity": 5, + * "buy_limit_price_per_gpu_hour": 250, + * "sell_limit_price_per_gpu_hour": 25, + * "horizon": 60, + * "colocation_strategy": "colocate_pinned", + * "actual_quantity": 5, + * "active_order_count": 2, + * "last_message": "Running" + * } + */ + "application/json": components["schemas"]["market-api_ProcurementResponse"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "authentication_error", + * "message": "missing authentication token" + * } + * } + */ + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden - account frozen */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "forbidden", + * "message": "Account is frozen" + * } + * } + */ + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Procurement not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "not_found", + * "message": "Procurement proc_xyz123 not found" + * } + * } + */ + "application/json": components["schemas"]["market-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "api_error", + * "message": "An internal server error occurred" + * } + * } + */ + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; + }; + }; + updateProcurement: { + parameters: { + query?: never; + header?: never; + path: { /** - * @description The available capacity on this cluster, in the - * shape of consecutive "availability rectangles". + * @description Procurement ID + * @example proc_xyz123 */ - available_capacity: components["schemas"]["node-api_AvailabilityRectangle"][]; - region: components["schemas"]["node-api_Region"]; - hardware_type: components["schemas"]["node-api_AcceleratorType"]; - interconnect_type: components["schemas"]["node-api_InterconnectType"]; - delivery_type: components["schemas"]["node-api_DeliveryType"]; - }[]; - }; - "node-api_Node": { - /** @example node */ - object: string; - /** @example n_b1dc52505c6db142 */ - id: string; - /** @example cuda-crunch */ - name: string; - /** @example hayesvalley */ - zone?: string | null; - gpu_type: components["schemas"]["node-api_AcceleratorType"]; - /** @example sfcompute */ - owner: string; - status: components["schemas"]["node-api_Status"]; - /** - * Format: int64 - * @description Creation time as Unix timestamp in seconds - * @example 1640995200 - */ - created_at?: number | null; - /** - * Format: int64 - * @description Last updated time as Unix timestamp in seconds - * @example 1640995200 - */ - updated_at?: number | null; - /** - * Format: int64 - * @description Start time as Unix timestamp in seconds - * @example 1640995200 - */ - start_at?: number | null; - /** - * Format: int64 - * @description End time as Unix timestamp in seconds - * @example 1640995200 - */ - end_at?: number | null; - /** - * Format: int64 - * @description Deletion time as Unix timestamp in seconds - * @example 1640995200 - */ - deleted_at?: number | null; - /** @example proc_b1dc52505c6de142 */ - procurement_id?: string | null; - /** - * Format: int64 - * @description Max price per hour you're willing to pay for a node in cents - * @example 1000 - */ - max_price_per_node_hour?: number | null; - node_type: components["schemas"]["node-api_NodeType"]; - vms?: null | components["schemas"]["node-api_VmList"]; - current_vm?: null | components["schemas"]["node-api_Vm"]; + id: string; + }; + cookie?: never; }; - /** @enum {string} */ - "node-api_NodeType": "autoreserved" | "reserved"; - "node-api_RedeployNodeRequest": { - /** - * @description Redeploy node with this VM image ID - * @example vmi_1234567890abcdef - */ - image_id?: string; - /** - * Format: byte - * @description Update the cloud init user data for VMs running on this node - * Data should be base64 encoded - * @example aGVsbG8gd29ybGQ= - */ - cloud_init_user_data?: string; - /** - * @description If false, then the new VM will inherit any configuration (like image_id, - * cloud_init_user_data) that is left empty in this request from the current VM. - * - * If true, then any configuration left empty will be set as empty in the new VM. - * E.g if cloud_init_user_data is left unset and override_empty is true, then the new VM will not - * have any cloud init user data. - * override_empty defaults to false. - * @default false - */ - override_empty: boolean; + requestBody: { + content: { + "application/json": components["schemas"]["market-api_UpdateProcurementRequest"]; + }; }; - /** @enum {string} */ - "node-api_Region": - | "NorthAmerica" - | "AsiaPacific" - | "EuropeMiddleEastAfrica"; - /** - * @description Node Status - * @enum {string} - */ - "node-api_Status": - | "pending" - | "awaitingcapacity" - | "running" - | "released" - | "terminated" - | "deleted" - | "failed" - | "unknown"; - /** - * Format: int64 - * @description Unix timestamp in seconds since epoch - * @example 1738972800 - */ - "node-api_UnixEpoch": number; - "node-api_Vm": { - /** @example vm */ - object: string; - /** @example vm_myOZZXw4pfcp7H9DQOldd */ - id: string; - status: components["schemas"]["node-api_VmStatus"]; - /** - * Format: int64 - * @example 1640995200 - */ - created_at: number; - /** - * Format: int64 - * @example 1640995200 - */ - updated_at: number; - /** - * Format: int64 - * @example 1640995200 - */ - start_at: number | null; - /** - * Format: int64 - * @example 1640998200 - */ - end_at: number | null; - /** @example vmi_myOZZXw4pfcp7H9DQOldd */ - image_id?: string | null; - /** @example hayesvalley */ - zone: string; + responses: { + /** @description Successfully updated procurement */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "procurement", + * "id": "proc_xyz123", + * "status": "disabled", + * "instance_type": "h100i", + * "desired_quantity": 5, + * "buy_limit_price_per_gpu_hour": 400, + * "sell_limit_price_per_gpu_hour": 100, + * "horizon": 120, + * "colocation_strategy": "colocate_pinned", + * "actual_quantity": 3, + * "active_order_count": 1 + * } + */ + "application/json": components["schemas"]["market-api_ProcurementResponse"]; + }; + }; + /** @description Bad request - invalid field values */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "invalid_request_error", + * "message": "desired_quantity must be non-negative" + * } + * } + */ + "application/json": components["schemas"]["market-api_BadRequestError"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "authentication_error", + * "message": "missing authentication token" + * } + * } + */ + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; + }; + /** @description Payment required - insufficient funds */ + 402: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "payment_required", + * "message": "insufficient funds" + * } + * } + */ + "application/json": components["schemas"]["market-api_PaymentRequiredError"]; + }; + }; + /** @description Forbidden - account frozen */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "forbidden", + * "message": "Account is frozen" + * } + * } + */ + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Procurement not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "not_found", + * "message": "procurement proc_xyz123 not found" + * } + * } + */ + "application/json": components["schemas"]["market-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "api_error", + * "message": "An internal server error occurred" + * } + * } + */ + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - "node-api_VmList": { - /** @example list */ - object: string; - data: components["schemas"]["node-api_Vm"][]; + }; + getAccountMe: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** @enum {string} */ - "node-api_VmStatus": - | "Pending" - | "Running" - | "Destroyed" - | "NodeFailure" - | "Unspecified"; - "node-api_ZoneInfo": { - object: string; - name: string; - /** @description User-facing zone name (e.g., "Hayes Valley", "Land's End") */ - display_name?: string | null; - /** - * @description The available capacity on this cluster, in the - * shape of consecutive "availability rectangles". - */ - available_capacity: components["schemas"]["node-api_AvailabilityRectangle"][]; - region: components["schemas"]["node-api_Region"]; - hardware_type: components["schemas"]["node-api_AcceleratorType"]; - interconnect_type: components["schemas"]["node-api_InterconnectType"]; - delivery_type: components["schemas"]["node-api_DeliveryType"]; + requestBody?: never; + responses: { + /** @description Account information retrieved successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "gmail-com-name", + * "role": "user", + * "is_frozen": false, + * "kyc": "basic", + * "submitted_waitlist": true, + * "waitlist": false, + * "kycb_form_submitted": false, + * "created_at": "2024-01-15T10:30:00Z" + * } + */ + "application/json": components["schemas"]["market-api_AccountMeResponse"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Account not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "not_found", + * "message": "account not found", + * "details": [], + * "request_id": "req_550e8400-e29b-41d4-a716-446655440000" + * } + * } + */ + "application/json": components["schemas"]["market-api_NotFoundError"]; + }; + }; }; - /** @description Response body for the account/me endpoint. */ - "market-api_AccountMeResponse": { - /** - * @description The unique identifier for the account - * @example gmail-com-name - */ - id: string; - /** - * @description The role assigned to this account - * @example user - */ - role: string; - /** - * @description Whether the account is currently frozen - * @example false - */ - is_frozen: boolean; - /** - * @description The KYC (Know Your Customer) verification level - * @example basic - */ - kyc: string; - /** - * @description Whether the user has submitted the waitlist form - * @example true - */ - submitted_waitlist: boolean; - /** - * @description Whether the user is on the waitlist - * @example false - */ - waitlist: boolean; - /** - * @description Whether the KYC-B form has been submitted - * @example false - */ - kycb_form_submitted: boolean; - /** - * Format: u-int64 - * @description When the account was created as a epoch unix timestamp - * @example 1749704176 - */ - created_at: number; + }; + getBalance: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - "market-api_AddressPayload": { - country: string; - postal_code?: string | null; - state?: string | null; - city?: string | null; - line1?: string | null; - line2?: string | null; + requestBody?: never; + responses: { + /** @description Successfully retrieved balance */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "balance", + * "available_cents": 150000, + * "current_cents": 180000, + * "current_overage_cents": 150000, + * "current_hold_cents": 180000, + * "updated_at": 1640995200 + * } + */ + "application/json": components["schemas"]["market-api_GetBalanceResponse"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; - "market-api_BaseCapacityDetails": { - /** - * @example capacity - * @enum {string} - */ - object: "capacity"; - id: components["schemas"]["market-api_CapacityId"]; - name?: null | components["schemas"]["market-api_Name"]; - node_template?: null | components["schemas"]["market-api_NodeTemplateId"]; - /** @description Automatically start and stop nodes when this capacity has compute available. Requires a node template. */ - start_nodes_automatically: boolean; - /** @description Zone requirements for this capacity. */ - requirements: { - zones: components["schemas"]["market-api_ZoneName"][]; - /** @enum {string} */ - type: "zones"; + }; + migrateAccount: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Migration request specifying the desired migration method */ + requestBody: { + content: { + "application/json": components["schemas"]["market-api_MigrateAccountRequest"]; + }; + }; + responses: { + /** @description Account successfully migrated */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "status": "migrated" + * } + */ + "application/json": components["schemas"]["market-api_MigrateAccountResponse"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Account already migrated */ + 409: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "account_already_migrated", + * "message": "Account has already been migrated", + * "details": [], + * "request_id": "req_550e8400-e29b-41d4-a716-446655440000" + * } + * } + */ + "application/json": components["schemas"]["market-api_ConflictError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "error": { + * "type": "internal_server_error", + * "message": "An internal server error occurred", + * "details": [], + * "request_id": "req_550e8400-e29b-41d4-a716-446655440000" + * } + * } + */ + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; }; - created_at: components["schemas"]["market-api_UnixEpoch"]; - }; - "market-api_CalculateInvoicePricingRequest": { - invoice_id: string; - payment_method_type: string; - /** Format: int64 */ - credit_amount_cents?: number | null; - address?: null | components["schemas"]["market-api_AddressPayload"]; - /** @default false */ - should_update_customer_address: boolean; - }; - "market-api_CalculateInvoicePricingResponse": { - /** - * @example pricing - * @enum {string} - */ - object: "pricing"; - /** Format: int64 */ - credit_amount_cents: number; - /** Format: int64 */ - platform_fee_cents: number; - /** Format: int64 */ - actual_fee_cents: number; - /** Format: int64 */ - adjustment_cents: number; - /** Format: int64 */ - subtotal_cents: number; - /** Format: int64 */ - tax_cents: number; - /** Format: int64 */ - total_with_tax_cents: number; - payment_method_type: string; - updated: boolean; }; - "market-api_CancelOrderResponse": { - object: components["schemas"]["market-api_CancelOrderStatus"]; + }; + list_events: { + parameters: { + query?: { + starting_after?: components["schemas"]["market-api_EventsCursor"]; + limit?: number; + action?: string; + target?: string; + /** @description Filter by target type (e.g. "node", "order") */ + target_type?: string; + /** @description Unix timestamp. Only return events that occurred at or after this time. */ + since?: number; + /** @description Unix timestamp. Only return events that occurred at or before this time. */ + until?: number; + }; + header?: never; + path?: never; + cookie?: never; }; - /** @enum {string} */ - "market-api_CancelOrderStatus": "pending"; - /** - * @description Opaque pagination cursor for CapacitiesCursor. Wire format: `capc_{base64url}`. - * @example capc_gqXR7s0Kj5mHvE2wNpLc4Q - */ - "market-api_CapacitiesCursor": string; - "market-api_CapacityDetails": { - /** - * @example capacity - * @enum {string} - */ - object: "capacity"; - id: components["schemas"]["market-api_CapacityId"]; - name?: null | components["schemas"]["market-api_Name"]; - node_template?: null | components["schemas"]["market-api_NodeTemplateId"]; - /** @description Automatically start and stop nodes when this capacity has compute available. Requires a node template. */ - start_nodes_automatically: boolean; - /** @description Zone requirements for this capacity. */ - requirements: { - zones: components["schemas"]["market-api_ZoneName"][]; - /** @enum {string} */ - type: "zones"; + requestBody?: never; + responses: { + /** @description Paginated list of events. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_ListEventsResponse"]; + }; }; - created_at: components["schemas"]["market-api_UnixEpoch"]; - } & { - /** @description Compute schedule for this capacity, per zone and aggregated. */ - schedule_info: { - /** @description Future schedule of allocated compute per zone. Does not include historical data. */ - zone_schedules: { - [key: string]: components["schemas"]["market-api_Schedule"]; + /** @description Validation failed. */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_BadRequestError"]; }; - /** @description Combined schedule across all zones. */ - total_schedule: components["schemas"]["market-api_Schedule"]; }; - /** @description Scheduler configuration for this capacity. */ - scheduler: components["schemas"]["market-api_SchedulerDetails"]; - }; - /** - * @description Unique identifier with prefix 'cap_'. - * @example cap_k3R-nX9vLm7Qp2Yw5Jd8F - */ - "market-api_CapacityId": string; - "market-api_CapacityListEntry": { - /** - * @example capacity - * @enum {string} - */ - object: "capacity"; - id: components["schemas"]["market-api_CapacityId"]; - name?: null | components["schemas"]["market-api_Name"]; - node_template?: null | components["schemas"]["market-api_NodeTemplateId"]; - /** @description Automatically start and stop nodes when this capacity has compute available. Requires a node template. */ - start_nodes_automatically: boolean; - /** @description Zone requirements for this capacity. */ - requirements: { - zones: components["schemas"]["market-api_ZoneName"][]; - /** @enum {string} */ - type: "zones"; + /** @description Unauthorized. */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; }; - created_at: components["schemas"]["market-api_UnixEpoch"]; - } & { - /** @description Whether an active scheduler exists for this capacity */ - scheduler_enabled: boolean; - }; - /** - * @description Unique identifier with prefix 'clus_' that references a resource. - * @example clus_k3R-nX9vLm7Qp2Yw5Jd8F - */ - "market-api_ClusterId": string; - "market-api_ColocationStrategy": - | { - /** @enum {string} */ - type: "anywhere"; - } - | { - /** @enum {string} */ - type: "colocate"; - } - | { - /** @enum {string} */ - type: "colocate-pinned"; - } - | { - cluster_name: components["schemas"]["market-api_ZoneName"]; - /** @enum {string} */ - type: "pinned"; + /** @description Forbidden. */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Cursor references a deleted event. */ + 410: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_GoneError"]; + }; + }; + /** @description Internal server error. */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_InternalServerError"]; }; - /** - * @description Unique identifier with prefix 'cont_' that references a resource. - * @example cont_k3R-nX9vLm7Qp2Yw5Jd8F - */ - "market-api_ContractId": string; - "market-api_ContractResponse": { - /** - * @example contract - * @enum {string} - */ - object: "contract"; - status: components["schemas"]["market-api_ContractStatus"]; - id: components["schemas"]["market-api_ContractId"]; - created_at: components["schemas"]["market-api_ISO8601DateTime"]; - instance_type: components["schemas"]["market-api_Ticker"]; - shape: components["schemas"]["market-api_ExternalShape"]; - /** @deprecated */ - colocate_with?: components["schemas"]["market-api_ContractId"][]; - cluster_id?: null | components["schemas"]["market-api_ClusterId"]; - zone?: null | components["schemas"]["market-api_ZoneName"]; - state: components["schemas"]["market-api_ContractState"]; - /** - * @description Specifies whether this contract is managed by the Nodes API - * @example true - */ - is_node: boolean; - /** - * @description The procurement which ordered this contract, if any - * @example proc_1234567890abcdef - */ - procurement_id?: string | null; - }; - /** @enum {string} */ - "market-api_ContractState": "Upcoming" | "Active" | "Expired"; - /** @enum {string} */ - "market-api_ContractStatus": "active" | "pending"; - /** @description Create a new capacity to hold and manage compute. */ - "market-api_CreateCapacityRequest": { - name?: null | components["schemas"]["market-api_Name"]; - /** @description Requirements applied to compute acquired into this capacity (from orders or the scheduler). */ - requirements: { - zones: components["schemas"]["market-api_ZoneName"][]; - /** @enum {string} */ - type: "zones"; }; - /** - * @description Default node template (ID, name, or inline definition). Used when starting nodes automatically or when no template is specified during node creation. - * It is the caller's responsibility to ensure the node template supports all zones listed in `requirements`. - */ - node_template?: components["schemas"]["market-api_ResourceRef_NodeTemplateId"]; - /** @description Automatically start and stop nodes when this capacity has compute available. Requires `node_template`. */ - start_nodes_automatically: boolean; - /** @description Scheduler that automatically places buy and sell orders for this capacity. */ - scheduler?: components["schemas"]["market-api_SchedulerDetails"]; - }; - "market-api_CreateDraftInvoiceRequest": { - /** Format: int64 */ - credit_amount_cents: number; - idempotency_key: string; - }; - "market-api_CreateDraftInvoiceResponse": { - /** - * @example invoice_draft - * @enum {string} - */ - object: "invoice_draft"; - invoice_id: string; - }; - /** @description Create a new node template defining the image and cloud-init config for nodes. */ - "market-api_CreateNodeTemplateRequest": { - /** @description User-defined name for the node template. Must be unique per owner. */ - name: components["schemas"]["market-api_Name"]; - /** @description Image ID or name for VMs using this template. */ - image: string; - /** - * Format: byte - * @description Cloud-init user data for VMs using this template. - * Data should be base64 encoded. - */ - cloud_init_user_data?: string; - }; - "market-api_CreateOrderRequest": { - /** @description Order side: "buy" or "sell" */ - side: components["schemas"]["market-api_Side"]; - instance_type?: null | components["schemas"]["market-api_Ticker"]; - /** - * Format: int32 - * @example 10 - */ - quantity: number; - start_at: components["schemas"]["market-api_NowOrISO8601DateTime"]; - end_at: components["schemas"]["market-api_NowOrISO8601DateTime"]; - /** - * Format: int64 - * @description Price in cents - * @example 1600 - */ - price: number; - flags?: components["schemas"]["market-api_OrderFlags"]; - /** @description A contract to colocate with. This overrides the instance_type if specified. */ - colocate_with?: components["schemas"]["market-api_ContractId"][]; - cluster?: null | components["schemas"]["market-api_ZoneName"]; - }; - /** - * @example { - * "object": "order", - * "status": "pending", - * "id": "order_xyz789", - * "idempotency_key": "key_123" - * } - */ - "market-api_CreateOrderResponse": { - /** - * @example order - * @enum {string} - */ - object: "order"; - status: components["schemas"]["market-api_CreateOrderStatus"]; - id: components["schemas"]["market-api_OrderId"]; - /** @example key_123 */ - idempotency_key?: string | null; - }; - /** @enum {string} */ - "market-api_CreateOrderStatus": "pending" | "filled" | "cancelled"; - "market-api_CreateProcurementRequest": { - /** @description Procurement status (active or disabled) */ - status?: components["schemas"]["market-api_ProcurementStatus"]; - /** @description Instance type to procure */ - instance_type: components["schemas"]["market-api_Ticker"]; - /** - * Format: int32 - * @description Desired quantity of nodes - * @example 5 - */ - desired_quantity: number; - /** - * Format: int32 - * @description Maximum price per GPU hour in cents - * @example 250 - */ - buy_limit_price_per_gpu_hour?: number; - /** - * Format: int32 - * @description Minimum price per GPU hour in cents when selling back - * @example 25 - */ - sell_limit_price_per_gpu_hour?: number; - /** - * Format: int32 - * @description Planning horizon in minutes - * @example 60 - */ - horizon?: number; - /** @description Colocation strategy for the procurement */ - colocation_strategy?: components["schemas"]["market-api_ColocationStrategy"]; }; - /** - * @description Price rate in dollars per node-hour, encoded as a decimal string. Must contain a decimal point (e.g. "1.50"). Returns 6 decimal places of precision (e.g. "1.500000"). - * @example 2.500000 - */ - "market-api_DollarsPerNodeHour": string; - "market-api_ErrorContent": { - type: components["schemas"]["market-api_ErrorType"]; - message: string; - details?: components["schemas"]["market-api_ErrorDetail"][]; + }; + post_calculate_invoice_pricing: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - "market-api_ErrorDetail": { - /** @description The field that caused the error (for validation errors) */ - field?: string | null; - /** @description Specific error code for this detail */ - code: string; - /** @description Human-readable error message */ - message: string; + requestBody: { + content: { + "application/json": components["schemas"]["market-api_CalculateInvoicePricingRequest"]; + }; }; - "market-api_ErrorObject": { - error: components["schemas"]["market-api_ErrorContent"]; + responses: { + /** @description Invoice pricing recalculated */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_CalculateInvoicePricingResponse"]; + }; + }; + /** @description Bad request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_BadRequestError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Invoice not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - /** @enum {string} */ - "market-api_ErrorType": - | "api_error" - | "invalid_request_error" - | "authentication_error" - | "idempotency_error" - | "conflict" - | "not_found" - | "request_timed_out" - | "forbidden" - | "not_implemented" - | "upgrade_required" - | "payment_required" - | "service_unavailable" - | "unprocessable_entity"; - /** - * @description A schedule representing a change of a quantity over time. The schedule changes at - * intervals[i] to quantity[i]. Intervals are sorted from first to last change. - */ - "market-api_ExternalShape": { - /** @description The times at which changes in quantity occur */ - intervals: components["schemas"]["market-api_ISO8601DateTime"][]; - /** @description The quantity changed to at that time */ - quantities: number[]; + }; + post_create_draft_invoice: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - "market-api_FinalizeInvoiceRequest": { - invoice_id: string; + requestBody: { + content: { + "application/json": components["schemas"]["market-api_CreateDraftInvoiceRequest"]; + }; }; - "market-api_FinalizeInvoiceResponse": { - /** - * @example payment - * @enum {string} - */ - object: "payment"; - success: boolean; - invoice_id: string; - payment_intent_id: string; - client_secret: string; - status: string; + responses: { + /** @description Draft invoice created */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_CreateDraftInvoiceResponse"]; + }; + }; + /** @description Bad request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_BadRequestError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - /** - * @description Response body for getting account balance from the credit ledger. - * @example { - * "object": "balance", - * "available_cents": 150000, - * "current_cents": 180000, - * "current_overage_cents": 0, - * "current_hold_cents": 0, - * "updated_at": 1640995200 - * } - */ - "market-api_GetBalanceResponse": { - /** - * @example balances - * @enum {string} - */ - object: "balances"; - /** - * Format: u-int64 - * @description Available balance in cents: sum(credit) - sum(debit) - sum(committed holds) - * @example 150000 - */ - available_balance_cents: number; - /** - * Format: u-int64 - * @description Reserved balance in cents: sum(credit) - sum(debit) - * @example 180000 - */ - current_balance_cents: number; - /** - * Format: u-int64 - * @description Total spend that hasn't been paid for yet, in cents. - * @example 0 - */ - current_overage_cents: number; - /** - * Format: u-int64 - * @description The maximum amount of overages the account can incur before they are blocked from buying compute. - * @example 0 - */ - overage_limit_cents: number; - /** - * Format: int64 - * @description When the balance was last updated as a unix timestamp - * @example 1640995200 - */ - updated_at: number; + }; + post_finalize_invoice: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** @description string with format 'txc_base62_encoded_id' used for paginating a query to GET /v1/transactions */ - "market-api_GetTransactionsCursor": string; - /** - * Format: date-time - * @description An ISO 8601 datetime string - * @example 2025-07-11T20:41:37.423Z - */ - "market-api_ISO8601DateTime": string; - /** - * @description Unique identifier with prefix 'image_'. - * @example image_k3R-nX9vLm7Qp2Yw5Jd8F - */ - "market-api_ImageId": string; - "market-api_KubernetesClusterResponse": { - /** - * @example kubernetes_cluster - * @enum {string} - */ - object: "kubernetes_cluster"; - /** @example https://cluster.example.com */ - kubernetes_api_url?: string | null; - name: components["schemas"]["market-api_ZoneName"]; - /** @example sf-user123 */ - kubernetes_namespace: string; - /** @example -----BEGIN CERTIFICATE-----... */ - kubernetes_ca_cert?: string | null; - contract?: null | components["schemas"]["market-api_ContractResponse"]; + requestBody: { + content: { + "application/json": components["schemas"]["market-api_FinalizeInvoiceRequest"]; + }; + }; + responses: { + /** @description Invoice finalized */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_FinalizeInvoiceResponse"]; + }; + }; + /** @description Bad request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_BadRequestError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Invoice not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - "market-api_ListCapacitiesResponse": { - /** - * @example list - * @enum {string} - */ - object: "list"; - cursor?: null | components["schemas"]["market-api_CapacitiesCursor"]; - has_more: boolean; - data: components["schemas"]["market-api_CapacityListEntry"][]; + }; + get_node_ids: { + parameters: { + query?: { + /** @description Optional provider identifier filter */ + provider_id?: string; + /** @description Include source details (VM or Kubernetes) */ + details?: boolean; + }; + header?: never; + path?: never; + cookie?: never; }; - "market-api_ListClustersResponse": { - /** - * @example list - * @enum {string} - */ - object: "list"; - data: components["schemas"]["market-api_KubernetesClusterResponse"][]; - has_more: boolean; + requestBody?: never; + responses: { + /** @description Node assignment list */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_NodeIdResponse"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden - not a vendor */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - "market-api_ListContractsResponse": { - /** - * @example list - * @enum {string} - */ - object: "list"; - data: components["schemas"]["market-api_ContractResponse"][]; - has_more: boolean; + }; + list_provider_orders: { + parameters: { + query?: { + /** @description Optional provider identifier (admins only) */ + provider_id?: string; + /** @description Inclusive start of the time window (ISO8601, UTC) */ + start_time?: string; + /** @description Exclusive end of the time window (ISO8601, UTC). Defaults to now. */ + end_time?: string; + /** @description Number of orders to return (1-500, default 50) */ + limit?: number; + /** @description Cursor for forward pagination */ + starting_after?: components["schemas"]["market-api_ProviderOrdersCursor"]; + /** @description Cursor for backward pagination */ + ending_before?: components["schemas"]["market-api_ProviderOrdersCursor"]; + }; + header?: never; + path?: never; + cookie?: never; }; - "market-api_ListNodeTemplatesResponse": { - /** - * @example list - * @enum {string} - */ - object: "list"; - cursor?: null | components["schemas"]["market-api_NodeTemplatesCursor"]; - has_more: boolean; - data: components["schemas"]["market-api_NodeTemplateDetails"][]; + requestBody?: never; + responses: { + /** @description Successfully retrieved provider orders */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "list", + * "data": [ + * { + * "object": "provider_order", + * "cursor": "poc_3kTh9P2mN8xQ7vB1dF5wE", + * "id": "ordr_Y3qN8pL2kX9vB1dF5wE4Z", + * "quantity": "2", + * "tcv": "500.00", + * "executed": true, + * "cancelled": false + * } + * ], + * "summary": { + * "object": "provider_orders_summary", + * "total_revenue_cents": 50000, + * "total_revenue_usd": "500.00", + * "order_count": 1 + * }, + * "has_more": false + * } + */ + "application/json": components["schemas"]["market-api_ProviderOrdersResponse"]; + }; + }; + /** @description Invalid request parameters */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_BadRequestError"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden - not a vendor or admin */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_ForbiddenError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - "market-api_ListOrdersResponse": { - /** - * @example list - * @enum {string} - */ - object: "list"; - data: components["schemas"]["market-api_OrderResponse"][]; - has_more: boolean; + }; + getTransactions: { + parameters: { + query?: { + /** @description Number of transactions to return (1-100, default 10) */ + limit?: number; + /** + * @description Filter for transactions after this UNIX timestamp (exclusive) + * @example 1640995200 + */ + after_time?: number; + /** + * @description Filter for transactions before this UNIX timestamp (exclusive) + * @example 1640995200 + */ + before_time?: number; + /** + * @description Cursor for forward pagination + * @example 1640995200 + */ + starting_after_cursor?: components["schemas"]["market-api_GetTransactionsCursor"]; + /** + * @description Cursor for backward pagination + * @example 1640995200 + */ + ending_before_cursor?: components["schemas"]["market-api_GetTransactionsCursor"]; + sort?: "transaction_time" | "-transaction_time" | "amount" | "-amount"; + /** + * @description Filter transactions by type (e.g. `buy_order`) + * @example buy_order + */ + transaction_type?: components["schemas"]["market-api_TransactionTypeFilter"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully retrieved transactions */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "object": "list", + * "data": [ + * { + * "object": "transaction", + * "transaction_time": 1640995200, + * "amount_cents": 25000, + * "details": { + * "object": "transaction_details", + * "type": "credit_grant", + * "memo": "Promotional credit" + * } + * } + * ], + * "has_more": false + * } + */ + "application/json": components["schemas"]["market-api_ListTransactionsResponse"]; + }; + }; + /** @description Invalid request parameters */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_BadRequestError"]; + }; + }; + /** @description Unauthorized - missing or invalid authentication token */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_UnauthorizedError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["market-api_InternalServerError"]; + }; + }; }; - "market-api_ListProcurementsResponse": { - /** - * @example list - * @enum {string} - */ - object: "list"; - data: components["schemas"]["market-api_ProcurementResponse"][]; - has_more: boolean; + }; + adminUpdateFeatureFlag: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - "market-api_ListTransactionsResponse": { - /** - * @example list - * @enum {string} - */ - object: "list"; - has_more: boolean; - data: components["schemas"]["market-api_TransactionResponse"][]; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_UpdateFeatureFlagRequest"]; + }; }; - /** - * @description Request body for migrating an account to the new billing system. - * @example { - * "type": "withdraw", - * "column_counterparty_id": "cpty_2n4f8bxg3qj5p6r7s9t1v" - * } - */ - "market-api_MigrateAccountRequest": - | { - /** - * @description The identifier for your external bank account where funds will be transferred - * @example cpty_2n4f8bxg3qj5p6r7s9t1v - */ - column_counterparty_id: string; - /** @enum {string} */ - type: "withdraw"; - } - | { - /** @enum {string} */ - type: "convert_to_credits"; + responses: { + /** @description Feature flag updated */ + 200: { + headers: { + [name: string]: unknown; }; - /** - * @description Response body for account migration requests. - * @example { - * "status": "migrated" - * } - * @enum {string} - */ - "market-api_MigrateAccountResponse": - | "migrated" - | "requires_manual_migration"; - /** - * @description A validated resource name. Must start with alphanumeric, followed by alphanumeric, '.', '_', or '-'. Max 255 characters. - * @example my-resource-name - */ - "market-api_Name": string; - "market-api_NodeIdEntry": { - current_status: string; - product_uuid?: string | null; - internal_ipv4?: string | null; - source?: null | components["schemas"]["market-api_NodeSource"]; + content: { + "application/json": components["schemas"]["sfc-api_UpdateFeatureFlagResponse"]; + }; + }; + /** @description No fields provided to update */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Feature flag not found for this id */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; - "market-api_NodeIdResponse": { - /** Format: u-int32 */ - count: number; - /** Format: date-time */ - request_timestamp: string; - data: components["schemas"]["market-api_NodeIdEntry"][]; + }; + adminCreateFeatureFlag: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** @enum {string} */ - "market-api_NodeSource": "vm"; - "market-api_NodeTemplateDetails": { - /** - * @example node_template - * @enum {string} - */ - object?: "node_template"; - id: components["schemas"]["market-api_NodeTemplateId"]; - /** @description User-defined name for this node template. */ - name: components["schemas"]["market-api_Name"]; - /** @description Image ID for VMs using this template. */ - image: components["schemas"]["market-api_ImageId"]; - /** - * Format: byte - * @description Cloud-init user data for VMs using this template. - * Data should be base64 encoded. - */ - cloud_init_user_data?: string; - created_at: components["schemas"]["market-api_UnixEpoch"]; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_CreateFeatureFlagRequest"]; + }; }; - /** - * @description Unique identifier with prefix 'ntmpl_'. - * @example ntmpl_k3R-nX9vLm7Qp2Yw5Jd8F - */ - "market-api_NodeTemplateId": string; - /** - * @description Opaque pagination cursor for NodeTemplatesCursor. Wire format: `ntplc_{base64url}`. - * @example ntplc_gqXR7s0Kj5mHvE2wNpLc4Q - */ - "market-api_NodeTemplatesCursor": string; - /** - * @description A date/time value that can be either "NOW" or an ISO 8601 datetime string - * @example NOW - * @example 2025-07-11T20:41:37.423Z - */ - "market-api_NowOrISO8601DateTime": string; - /** @description Configure more fine grained order behavior. */ - "market-api_OrderFlags": { - /** - * @description If true, the order will be automatically cancelled if it doesn't - * immediately fill when being placed. - */ - ioc?: boolean; - /** - * @description If true, places the order straight into the book without trying to match - * against existing orders. - */ - post_only?: boolean; - /** @description If true, ignores the set limit price and matches any price that is available. */ - market?: boolean; - /** - * @description If the order start time should be automatically changed to "now" once - * start time < "now", proportionally changing it's limit price to reflect - * it's shorter duration. - */ - prorate?: boolean; + responses: { + /** @description Feature flag created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_CreateFeatureFlagResponse"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Feature flag already exists for this account */ + 409: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; - /** - * @description Unique identifier with prefix 'ordr_' that references a resource. - * @example ordr_k3R-nX9vLm7Qp2Yw5Jd8F - */ - "market-api_OrderId": string; - "market-api_OrderResponse": { - /** - * @example order - * @enum {string} - */ - object: "order"; - id: components["schemas"]["market-api_OrderId"]; - side: components["schemas"]["market-api_OrderSide"]; - status: components["schemas"]["market-api_OrderStatus"]; - instance_type: components["schemas"]["market-api_Ticker"]; - /** - * Format: int32 - * @example 4 - */ - quantity: number; - start_at: components["schemas"]["market-api_ISO8601DateTime"]; - end_at: components["schemas"]["market-api_ISO8601DateTime"]; - /** - * Format: int64 - * @description Price in cents - * @example 2850000 - */ - price: number; - flags: components["schemas"]["market-api_OrderFlags"]; - executed: boolean; - executed_at?: null | components["schemas"]["market-api_ISO8601DateTime"]; - /** Format: int64 */ - execution_price?: number | null; - cancelled: boolean; - cancelled_at?: null | components["schemas"]["market-api_ISO8601DateTime"]; - colocate_with?: components["schemas"]["market-api_ContractId"][]; - created_at: components["schemas"]["market-api_ISO8601DateTime"]; - rejected: boolean; - rejected_reason?: string | null; - cluster?: null | components["schemas"]["market-api_ZoneName"]; - duration: components["schemas"]["market-api_UnixEpoch"]; + }; + adminDeleteFeatureFlag: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** @enum {string} */ - "market-api_OrderSide": "buy" | "sell"; - /** @enum {string} */ - "market-api_OrderStatus": "open" | "filled" | "cancelled" | "rejected"; - /** - * @description Opaque pagination cursor for OrdersCursor. Wire format: `orc_{base64url}`. - * @example orc_gqXR7s0Kj5mHvE2wNpLc4Q - */ - "market-api_OrdersCursor": string; - "market-api_PatchCapacityRequest": { - /** @description Human-readable name for the capacity. Must be unique per owner. Set to null to clear. */ - name?: string | null; - /** @description Requirements applied to compute acquired into this capacity. Replaces existing requirements. */ - requirements?: null | { - zones: components["schemas"]["market-api_ZoneName"][]; - /** @enum {string} */ - type: "zones"; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_DeleteFeatureFlagRequest"]; + }; + }; + responses: { + /** @description Feature flag deleted */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_DeleteFeatureFlagResponse"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Feature flag not found for this id */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content?: never; }; - /** @description Default node template (ID or name). Must belong to the same owner. */ - node_template?: string | null; - /** @description Automatically start and stop nodes when this capacity has compute available. Requires `node_template`. */ - start_nodes_automatically?: boolean | null; - /** @description Scheduler that automatically places buy and sell orders for this capacity. Replaces the existing scheduler. Omit to leave unchanged. */ - scheduler?: components["schemas"]["market-api_SchedulerDetails"]; }; - /** @enum {string} */ - "market-api_ProcurementMessage": "insufficient_balance" | "running"; - "market-api_ProcurementResponse": { - /** - * @example procurement - * @enum {string} - */ - object: "procurement"; - /** @example proc_W9TRG */ - id: string; - instance_type: components["schemas"]["market-api_Ticker"]; - status: components["schemas"]["market-api_ProcurementStatus"]; - /** - * Format: int32 - * @example 1 - */ - desired_quantity: number; - /** - * Format: int32 - * @example 250 - */ - buy_limit_price_per_gpu_hour: number; - /** - * Format: int32 - * @example 25 - */ - sell_limit_price_per_gpu_hour: number; - /** - * Format: int32 - * @example 60 - */ - horizon: number; - colocation_strategy: components["schemas"]["market-api_ColocationStrategy"]; - last_message: components["schemas"]["market-api_ProcurementMessage"]; + }; + publish_image: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Image ID */ + id: components["schemas"]["sfc-api_ImageId"]; + }; + cookie?: never; }; - /** @enum {string} */ - "market-api_ProcurementStatus": "active" | "disabled"; - "market-api_ProviderOrderResource": { - /** - * @example provider_order - * @enum {string} - */ - object: "provider_order"; - cursor: components["schemas"]["market-api_ProviderOrdersCursor"]; - id: string; - /** Format: date-time */ - start_time: string; - /** Format: date-time */ - end_time: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - executed_at?: string | null; - /** Format: date-time */ - cancelled_at?: string | null; - executed: boolean; - cancelled: boolean; - quantity: string; - duration_hours: string; - tcv: string; - executed_gpu_hour_price?: string | null; - market: string; - accelerator_type: string; - sender: string; - was_repriced?: boolean | null; + requestBody?: never; + responses: { + /** @description Image published */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ImageListEntry"]; + }; + }; + /** @description Unauthorized request */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; + }; + /** @description Admin access required */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; + }; + }; + /** @description Image not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Image is already published */ + 409: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ConflictError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; }; - /** @description Opaque cursor string with format 'poc_base62_encoded_data' used for paginating provider orders */ - "market-api_ProviderOrdersCursor": string; - "market-api_ProviderOrdersResponse": { - /** - * @example list - * @enum {string} - */ - object: "list"; - data: components["schemas"]["market-api_ProviderOrderResource"][]; - summary: components["schemas"]["market-api_ProviderOrdersSummary"]; - has_more: boolean; + }; + set_default_image: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Image ID */ + id: components["schemas"]["sfc-api_ImageId"]; + }; + cookie?: never; }; - "market-api_ProviderOrdersSummary": { - /** - * @example provider_orders_summary - * @enum {string} - */ - object: "provider_orders_summary"; - /** Format: int64 */ - total_revenue_cents: number; - total_revenue_usd: string; - order_count: number; - /** Format: double */ - average_gpu_hour_price_cents?: number | null; - average_gpu_hour_price_usd?: string | null; - /** Format: date-time */ - period_start: string; - /** Format: date-time */ - period_end: string; - /** Format: date-time */ - generated_at: string; + requestBody?: never; + responses: { + /** @description Default image set */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_SetDefaultImageResponse"]; + }; + }; + /** @description Unauthorized request */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; + }; + /** @description Admin access required */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; + }; + }; + /** @description Image not found or not public */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; }; - "market-api_Requirements": { - zones: components["schemas"]["market-api_ZoneName"][]; - /** @enum {string} */ - type: "zones"; + }; + listInstanceSkuPropertyKeys: { + parameters: { + query?: { + limit?: number; + starting_after?: components["schemas"]["sfc-api_AdminInstanceSkuPropertyKeysCursor"]; + ending_before?: components["schemas"]["sfc-api_AdminInstanceSkuPropertyKeysCursor"]; + }; + header?: never; + path?: never; + cookie?: never; }; - /** @description Pass an ID or name string to reference an existing resource. Pass an object to create a new resource inline. */ - "market-api_ResourceRef_CapacityId": - | string - | { - name?: null | components["schemas"]["market-api_Name"]; - /** @description Requirements applied to compute acquired into this capacity (from orders or the scheduler). */ - requirements: { - zones: components["schemas"]["market-api_ZoneName"][]; - /** @enum {string} */ - type: "zones"; - }; - /** - * @description Default node template (ID, name, or inline definition). Used when starting nodes automatically or when no template is specified during node creation. - * It is the caller's responsibility to ensure the node template supports all zones listed in `requirements`. - */ - node_template?: components["schemas"]["market-api_ResourceRef_NodeTemplateId"]; - /** @description Automatically start and stop nodes when this capacity has compute available. Requires `node_template`. */ - start_nodes_automatically: boolean; - /** @description Scheduler that automatically places buy and sell orders for this capacity. */ - scheduler?: components["schemas"]["market-api_SchedulerDetails"]; - }; - /** @description Pass an ID or name string to reference an existing resource. Pass an object to create a new resource inline. */ - "market-api_ResourceRef_NodeTemplateId": - | string - | { - /** @description User-defined name for the node template. Must be unique per owner. */ - name: components["schemas"]["market-api_Name"]; - /** @description Image ID or name for VMs using this template. */ - image: string; - /** - * Format: byte - * @description Cloud-init user data for VMs using this template. - * Data should be base64 encoded. - */ - cloud_init_user_data?: string; + requestBody?: never; + responses: { + /** @description Paginated list of property keys */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ListAdminInstanceSkuPropertyKeysResponse"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Validation failed */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; - /** @description Denotes previous and upcoming capacity availability over time. */ - "market-api_Schedule": { - object: components["schemas"]["market-api_ScheduleDiscriminator"]; - data: components["schemas"]["market-api_ScheduleEntry"][]; + }; }; - /** - * @example schedule - * @enum {string} - */ - "market-api_ScheduleDiscriminator": "schedule"; - "market-api_ScheduleEntry": { - timestamp: components["schemas"]["market-api_UnixEpoch"]; - /** Format: int32 */ - quantity: number; + }; + createInstanceSkuPropertyKey: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** @description Scheduler that automatically places buy and sell orders for this capacity. */ - "market-api_SchedulerDetails": { - spot_scaler: components["schemas"]["market-api_SpotScalerConfig"]; - /** @enum {string} */ - type: "spot_scaler"; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_CreateAdminInstanceSkuPropertyKeyRequest"]; + }; }; - /** @description SFC standard error response */ - "market-api_SerdeErrorProxy": { - /** @description The error type identifier */ - type: components["schemas"]["market-api_ErrorType"]; - /** @description Human-readable error message */ - message: string; - /** @description Array of detailed error information when applicable */ - details: components["schemas"]["market-api_ErrorDetail"][]; + responses: { + /** @description Property key created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_AdminInstanceSkuPropertyKeyDetail"]; + }; + }; + /** @description Validation error or duplicate key */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_BadRequestError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; }; - /** @enum {string} */ - "market-api_Side": "sell" | "buy"; - /** - * @description Sort field for listing orders - * @example created_at - * @example start_time - * @enum {string} - */ - "market-api_SortBy": "created_at" | "start_time"; - /** - * @description Sort direction for listing orders - * @example ASC - * @example DESC - * @enum {string} - */ - "market-api_SortDirection": "ASC" | "DESC"; - "market-api_SpotScalerConfig": { - /** @description Floor price for selling compute out of this capacity (dollars/node-hour). */ - min_sell_price_dollars_per_node_hour: components["schemas"]["market-api_DollarsPerNodeHour"]; - /** @description Ceiling price for buying compute into this capacity (dollars/node-hour). */ - max_buy_price_dollars_per_node_hour: components["schemas"]["market-api_DollarsPerNodeHour"]; - /** - * Format: u-int64 - * @description Target number of nodes to maintain in this capacity. - */ - desired_quantity: number; - /** - * Format: u-int64 - * @description Maximum time ahead (in minutes) the scheduler buys and sells compute for this capacity. Higher values secure compute further in advance but commit to longer windows that may need to be sold when scaling down, potentially at a loss. Lower values reduce waste but increase the risk of desired compute being unavailable. Orders are placed in 1-hour blocks within this window, so the furthest hour is secured up to `managed_window_minutes - 60` minutes before it begins. Range: 60 -- 1440. - */ - managed_window_minutes: number; - /** @description Whether the scheduler actively places orders */ - enabled: boolean; + }; + getInstanceSkuPropertyKey: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Property key, e.g. accelerator */ + key: components["schemas"]["sfc-api_Name"]; + }; + cookie?: never; }; - /** - * @example h100i - * @example h100v - * @example h200ki - */ - "market-api_Ticker": string; - "market-api_TransactionDetails": - | { - /** - * @example transaction_details - * @enum {string} - */ - object: "transaction_details"; - card_last4: string; - card_brand: string; - card_funding: string; - receipt_url: string; - /** @enum {string} */ - type: "stripe_card_payment"; - } - | { - /** - * @example transaction_details - * @enum {string} - */ - object: "transaction_details"; - description: string; - /** @enum {string} */ - type: "manual_payment"; - } - | { - /** - * @example transaction_details - * @enum {string} - */ - object: "transaction_details"; - memo: string; - /** @enum {string} */ - type: "credit_grant"; - } - | { - /** - * @example transaction_details - * @enum {string} - */ - object: "transaction_details"; - /** @enum {string} */ - type: "refund"; - } - | { - /** - * @example transaction_details - * @enum {string} - */ - object: "transaction_details"; - order_id: components["schemas"]["market-api_OrderId"]; - order?: null | { - /** - * @example order - * @enum {string} - */ - object: "order"; - id: components["schemas"]["market-api_OrderId"]; - side: components["schemas"]["market-api_OrderSide"]; - status: components["schemas"]["market-api_OrderStatus"]; - instance_type: components["schemas"]["market-api_Ticker"]; - /** - * Format: int32 - * @example 4 - */ - quantity: number; - start_at: components["schemas"]["market-api_ISO8601DateTime"]; - end_at: components["schemas"]["market-api_ISO8601DateTime"]; - /** - * Format: int64 - * @description Price in cents - * @example 2850000 - */ - price: number; - flags: components["schemas"]["market-api_OrderFlags"]; - executed: boolean; - executed_at?: - | null - | components["schemas"]["market-api_ISO8601DateTime"]; - /** Format: int64 */ - execution_price?: number | null; - cancelled: boolean; - cancelled_at?: - | null - | components["schemas"]["market-api_ISO8601DateTime"]; - colocate_with?: components["schemas"]["market-api_ContractId"][]; - created_at: components["schemas"]["market-api_ISO8601DateTime"]; - rejected: boolean; - rejected_reason?: string | null; - cluster?: null | components["schemas"]["market-api_ZoneName"]; - duration: components["schemas"]["market-api_UnixEpoch"]; - }; - /** @enum {string} */ - type: "buy_order"; - } - | { - /** - * @example transaction_details - * @enum {string} - */ - object: "transaction_details"; - order_id: components["schemas"]["market-api_OrderId"]; - order?: null | { - /** - * @example order - * @enum {string} - */ - object: "order"; - id: components["schemas"]["market-api_OrderId"]; - side: components["schemas"]["market-api_OrderSide"]; - status: components["schemas"]["market-api_OrderStatus"]; - instance_type: components["schemas"]["market-api_Ticker"]; - /** - * Format: int32 - * @example 4 - */ - quantity: number; - start_at: components["schemas"]["market-api_ISO8601DateTime"]; - end_at: components["schemas"]["market-api_ISO8601DateTime"]; - /** - * Format: int64 - * @description Price in cents - * @example 2850000 - */ - price: number; - flags: components["schemas"]["market-api_OrderFlags"]; - executed: boolean; - executed_at?: - | null - | components["schemas"]["market-api_ISO8601DateTime"]; - /** Format: int64 */ - execution_price?: number | null; - cancelled: boolean; - cancelled_at?: - | null - | components["schemas"]["market-api_ISO8601DateTime"]; - colocate_with?: components["schemas"]["market-api_ContractId"][]; - created_at: components["schemas"]["market-api_ISO8601DateTime"]; - rejected: boolean; - rejected_reason?: string | null; - cluster?: null | components["schemas"]["market-api_ZoneName"]; - duration: components["schemas"]["market-api_UnixEpoch"]; - }; - /** @enum {string} */ - type: "sell_order"; + requestBody?: never; + responses: { + /** @description Property key detail */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_AdminInstanceSkuPropertyKeyDetail"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; }; - "market-api_TransactionResponse": { - /** - * @example transaction - * @enum {string} - */ - object: "transaction"; - /** @description Opaque cursor for use in pagination */ - cursor: components["schemas"]["market-api_GetTransactionsCursor"]; - /** - * Format: int64 - * @description Time the transaction took place as UNIX timestamp in seconds. - * @example 1640995200 - */ - transaction_time: number; - /** - * Format: int64 - * @description Transaction amount in cents (e.g., 50000 = $500.00) - * @example 50000 - */ - amount_cents: number; - /** - * Format: int64 - * @description Balance immediately after this transaction took place, in cents (e.g., 50000 = $500.00). - */ - balance: number; - /** @description Transaction details */ - details: components["schemas"]["market-api_TransactionDetails"]; + content?: never; + }; + /** @description Key not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; }; - /** @enum {string} */ - "market-api_TransactionTypeFilter": - | "stripe_card_payment" - | "manual_payment" - | "credit_grant" - | "refund" - | "buy_order" - | "sell_order"; - /** - * Format: int64 - * @description Unix timestamp in seconds since epoch - * @example 1738972800 - */ - "market-api_UnixEpoch": number; - "market-api_UpdateProcurementRequest": { - status?: null | components["schemas"]["market-api_ProcurementStatus"]; - instance_type?: null | components["schemas"]["market-api_Ticker"]; - /** - * Format: int32 - * @description Desired quantity of nodes - * @example 5 - */ - desired_quantity?: number | null; - /** - * Format: int32 - * @description Maximum price per GPU hour in cents - * @example 350 - */ - buy_limit_price_per_gpu_hour?: number | null; - /** - * Format: int32 - * @description Minimum price per GPU hour in cents when selling back - * @example 50 - */ - sell_limit_price_per_gpu_hour?: number | null; - /** - * Format: int32 - * @description Planning horizon in minutes. The procurement will try to buy compute - * ahead of time as to always have at least this amount of time ahead - * scheduled at a minimum. - * @example 120 - */ - horizon?: number | null; + }; + patchInstanceSkuPropertyKey: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Property key to patch */ + key: components["schemas"]["sfc-api_Name"]; + }; + cookie?: never; }; - /** - * @description A physically colocated datacenter. - * @example hayesvalley - */ - "market-api_ZoneName": string; - "market-api_v2.CreateOrderRequest": { - /** @description The capacity to place the order for. Either a capacity ID or an inline capacity definition. */ - capacity: components["schemas"]["market-api_ResourceRef_CapacityId"]; - /** @description Order side: "buy" or "sell" */ - side: components["schemas"]["market-api_Side"]; - /** - * @description If true, allow the order to remain on the book if not immediately filled. - * If false (default), the order is immediate-or-cancel. - */ - allow_standing: boolean; - /** - * Format: int32 - * @description Number of nodes to order. - */ - quantity_nodes: number; - /** - * Format: int64 - * @description Order start time as a unix timestamp (seconds). - * Must be approximately now or on a future hour boundary. - */ - start_at: number; - /** - * Format: int64 - * @description Order end time as a unix timestamp (seconds). Must be on an hour boundary. - */ - end_at: number; - /** @description Limit price in dollars per node-hour. */ - limit_price_dollars_per_node_hour: components["schemas"]["market-api_DollarsPerNodeHour"]; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_PatchAdminInstanceSkuPropertyKeyRequest"]; + }; }; - "market-api_v2.ListOrdersResponse": { - /** - * @example list - * @enum {string} - */ - object: "list"; - cursor?: null | components["schemas"]["market-api_OrdersCursor"]; - has_more: boolean; - data: components["schemas"]["market-api_v2.OrderResponse"][]; + responses: { + /** @description Updated property key */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_AdminInstanceSkuPropertyKeyDetail"]; + }; + }; + /** @description Invariant violation */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_BadRequestError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Key not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; }; - "market-api_v2.OrderResponse": { - /** - * @example order - * @enum {string} - */ - object: "order"; - /** @description The order ID. */ - id: components["schemas"]["market-api_OrderId"]; - /** @description The capacity this order is for. */ - capacity: components["schemas"]["market-api_CapacityId"]; - /** @description Order side: "buy" or "sell". */ - side: components["schemas"]["market-api_Side"]; - /** - * @description If true, the order can remain on the book if not immediately filled. - * If false (default), the order is immediate-or-cancel. - */ - allow_standing: boolean; - /** @description Order requirements. */ - requirements: { - zones: components["schemas"]["market-api_ZoneName"][]; - /** @enum {string} */ - type: "zones"; + }; + listInstanceSkuPropertyValues: { + parameters: { + query?: { + limit?: number; + starting_after?: components["schemas"]["sfc-api_AdminInstanceSkuPropertyValuesCursor"]; + ending_before?: components["schemas"]["sfc-api_AdminInstanceSkuPropertyValuesCursor"]; }; - /** - * Format: int32 - * @description Number of nodes. - */ - quantity_nodes: number; - /** - * Format: int64 - * @description Order start time as a unix timestamp (seconds). - */ - start_at: number; - /** - * Format: int64 - * @description Order end time as a unix timestamp (seconds). - */ - end_at: number; - /** @description Limit price in dollars per node-hour. */ - limit_price_dollars_per_node_hour: components["schemas"]["market-api_DollarsPerNodeHour"]; - /** @description Order status. */ - status: components["schemas"]["market-api_v2.OrderStatus"]; - /** - * Format: int64 - * @description Unix timestamp when the order was placed. Present only if not pending or rejected. - */ - placed_at?: number | null; - /** - * Format: int64 - * @description Unix timestamp when the order was filled. Present only if filled. - */ - filled_at?: number | null; - fill_price_dollars_per_node_hour?: - | null - | components["schemas"]["market-api_DollarsPerNodeHour"]; - /** - * Format: int64 - * @description Unix timestamp when the order was cancelled. Present only if cancelled. - */ - cancelled_at?: number | null; + header?: never; + path: { + /** @description Property key to list values for */ + key: components["schemas"]["sfc-api_Name"]; + }; + cookie?: never; }; - /** @enum {string} */ - "market-api_v2.OrderStatus": - | "pending" - | "filled" - | "rejected" - | "cancelled" - | "standing"; - /** - * @example { - * "id": "batch_bea1aa2c-fa2f-4ea5-b84f-d41320f2ec51", - * "account_id": "sfcompute-com-waylon", - * "object": "batch", - * "endpoint": "/v1/chat/completions", - * "errors": null, - * "input_file_uri": "https://add-input-file-uri.com", - * "completion_window": "7d", - * "status": "accepted", - * "output_file_uri": "https://add-output-file-uri.com", - * "created_at": "2025-07-28T19:48:54.687148Z", - * "in_progress_at": null, - * "expires_at": null, - * "finalizing_at": null, - * "completed_at": null, - * "failed_at": null, - * "cancelling_at": null, - * "expired_at": null, - * "cancelled_at": null, - * "request_counts": { - * "total": 0, - * "completed": 0, - * "failed": 0 - * }, - * "metadata": { - * "input_token_usage": null, - * "output_token_usage": null - * }, - * "deadline_at": "2025-07-29T19:48:54.687148Z", - * "model_id": "Qwen/Qwen2.5-VL-32B-Instruct", - * "retry_count": 0, - * "is_retry": false - * } - */ - large_scale_inference_Batch: { - id: string; - account_id: string; - object: string; - endpoint: string; - errors?: - | null - | components["schemas"]["large_scale_inference_BatchErrors"]; - input_file_uri: string; - completion_window: string; - status: components["schemas"]["large_scale_inference_BatchStatus"]; - output_file_uri: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - in_progress_at?: string | null; - /** Format: date-time */ - expires_at?: string | null; - /** Format: date-time */ - finalizing_at?: string | null; - /** Format: date-time */ - completed_at?: string | null; - /** Format: date-time */ - failed_at?: string | null; - /** Format: date-time */ - cancelling_at?: string | null; - /** Format: date-time */ - expired_at?: string | null; - /** Format: date-time */ - cancelled_at?: string | null; - request_counts: components["schemas"]["large_scale_inference_RequestCounts"]; - metadata: { - [key: string]: string; + requestBody?: never; + responses: { + /** @description Paginated list of enumeration values */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ListAdminInstanceSkuPropertyValuesResponse"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Key not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Validation failed */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; }; - /** Format: date-time */ - deadline_at: string; - model_id: string; - /** Format: int32 */ - retry_count: number; - is_retry: boolean; - }; - large_scale_inference_BatchErrorData: { - code: string; - /** Format: u-int32 */ - line?: number | null; - message: string; - param?: string | null; - }; - large_scale_inference_BatchErrors: { - data: components["schemas"]["large_scale_inference_BatchErrorData"][]; - object: string; }; - /** - * @example { - * "input_file_uri": "https://add-input-file-uri.com", - * "output_file_uri": "https://add-output-file-uri.com", - * "endpoint": "/v1/chat/completions", - * "model_id": "Qwen/Qwen2.5-VL-32B-Instruct", - * "completion_window": "7d", - * "store": "s3" - * } - */ - large_scale_inference_BatchRequest: { - input_file_uri: string; - output_file_uri: string; - endpoint: string; - model_id: string; - store: string; - completion_window: string; - metadata?: { - [key: string]: string; + }; + createInstanceSkuPropertyValue: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Property key */ + key: components["schemas"]["sfc-api_Name"]; }; + cookie?: never; }; - large_scale_inference_BatchRequests: - | components["schemas"]["large_scale_inference_BatchRequest"] - | components["schemas"]["large_scale_inference_BatchRequest"][]; - /** @enum {string} */ - large_scale_inference_BatchStatus: - | "accepted" - | "compute_purchased" - | "not_started" - | "started" - | "validating" - | "failed" - | "in_progress" - | "finalizing" - | "completed" - | "expired" - | "cancelling" - | "cancelled" - | "waiting" - | "retrying"; - large_scale_inference_ErrorDetail: { - /** @description The field that caused the error (for validation errors) */ - field?: string | null; - /** @description Specific error code for this detail */ - code: string; - /** @description Human-readable error message */ - message: string; - }; - /** @enum {string} */ - large_scale_inference_ErrorType: - | "api_error" - | "invalid_request_error" - | "authentication_error" - | "idempotency_error" - | "conflict" - | "not_found" - | "request_timed_out" - | "forbidden" - | "not_implemented" - | "upgrade_required" - | "payment_required" - | "service_unavailable" - | "unprocessable_entity"; - large_scale_inference_Model: { - id: string; - display_name: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - retired_at?: string | null; - retired: boolean; - size: string; - }; - large_scale_inference_RequestCounts: { - /** Format: u-int32 */ - total: number; - /** Format: u-int32 */ - completed: number; - /** Format: u-int32 */ - failed: number; - }; - /** @description SFC standard error response */ - large_scale_inference_SerdeErrorProxy: { - /** @description The error type identifier */ - type: components["schemas"]["large_scale_inference_ErrorType"]; - /** @description Human-readable error message */ - message: string; - /** @description Array of detailed error information when applicable */ - details: components["schemas"]["large_scale_inference_ErrorDetail"][]; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_CreateAdminInstanceSkuPropertyValueRequest"]; + }; }; - /** - * @description Quote details with side-specific fields - * - * The response structure differs based on order side: - * - Buy orders include `instance_type` - * - Sell orders include `contract_id` - */ - quoter_ApiQuoteDetails: { - /** - * Format: u-int64 - * @description Total price in cents (USD) - */ - price: number; - /** - * Format: u-int64 - * @description Number of nodes - */ - quantity: number; - /** @description Start time: ISO 8601 or "NOW" */ - start_at: components["schemas"]["quoter_NowOrISO8601DateTime"]; - /** @description End time: ISO 8601 */ - end_at: components["schemas"]["quoter_NowOrISO8601DateTime"]; - /** @description Instance type being quoted */ - instance_type: string; - zone: string; + responses: { + /** @description Value created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_AdminInstanceSkuEnumerationValue"]; + }; + }; + /** @description Validation error or duplicate value */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_BadRequestError"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Key not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; }; - /** - * @description Response format for GET /v0/quote - * - * Returns a quote object with side-specific details. - * If no quote is available, the `quote` field will be `None`. - */ - quoter_ApiQuoteResponse: { - /** @description Always "quote" */ - object: string; - /** @description Matches the requested side: "buy" or "sell" */ - side: string; - quote?: null | components["schemas"]["quoter_ApiQuoteDetails"]; - no_quote_reason?: null | components["schemas"]["quoter_NoQuoteReason"]; + }; + getInstanceSkuPropertyValue: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Property key */ + key: components["schemas"]["sfc-api_Name"]; + /** @description Enumeration value */ + value: components["schemas"]["sfc-api_Name"]; + }; + cookie?: never; }; - /** - * @description Unique identifier with prefix 'cont_' that references a resource. - * @example cont_k3R-nX9vLm7Qp2Yw5Jd8F - */ - quoter_ContractId: string; - /** @enum {string} */ - quoter_ErrorType: - | "api_error" - | "invalid_request_error" - | "authentication_error" - | "idempotency_error" - | "conflict" - | "not_found" - | "request_timed_out" - | "forbidden" - | "not_implemented" - | "upgrade_required" - | "payment_required" - | "service_unavailable" - | "unprocessable_entity"; - /** - * @description Reason why a quote could not be provided. - * @enum {string} - */ - quoter_NoQuoteReason: - | "no_matching_clusters" - | "no_availability" - | "bid_price_too_low" - | "ask_price_too_high" - | "internal_solver_error"; - /** - * @description A date/time value that can be either "NOW" or an ISO 8601 datetime string - * @example NOW - * @example 2025-07-11T20:41:37.423Z - */ - quoter_NowOrISO8601DateTime: string; - /** - * @description Query parameters for GET /v0/quote - * - * # Validation Rules - * - * ## Required Fields - * - `side`: Must be "buy" or "sell" - * - `quantity`: Must be a positive integer (1-1024) - * - * ## Date Constraints - * - `min_start_date` and `max_start_date` accept: - * - "NOW" (literal string for current time) - * - ISO 8601 date string - * - If neither provided, defaults to "NOW" - * - `max_start_date` must be >= `min_start_date` - * - * ## Duration Constraints (mutually exclusive) - * - EITHER provide `duration` (in seconds) - * - OR provide both `min_duration` AND `max_duration` (in seconds) - * - All durations must be positive - * - Maximum duration: 3 years (94,608,000 seconds) - * - When `duration` is provided, it expands to a range: - * - min = duration - * - max = duration + 59 minutes - * - * ## Side-Specific Constraints - * - * ### Buy Orders - * - **Required**: `instance_type` (must be one of: "h100i", "h100v", "h200ki") - * - **Optional**: `colocate_with` (contract ID), `cluster` - * - **Forbidden**: `contract_id` - * - * ### Sell Orders - * - **Required**: `contract_id` (must be owned by authenticated user) - * - **Forbidden**: `instance_type`, `cluster`, `colocate_with` - */ - quoter_QuoteRequestParams: { - side: components["schemas"]["quoter_Side"]; - /** @description Instance type for buy orders: "h100i", "h100v", or "h200ki" */ - instance_type?: string | null; - colocate_with?: null | components["schemas"]["quoter_ContractId"]; - /** @description Cluster constraint (optional) - hostname to resolve to cluster_id */ - cluster?: string | null; - min_start_date?: - | null - | components["schemas"]["quoter_NowOrISO8601DateTime"]; - max_start_date?: - | null - | components["schemas"]["quoter_NowOrISO8601DateTime"]; - /** - * Format: u-int64 - * @description Number of nodes (1-1024) - */ - quantity: number; - /** - * Format: u-int64 - * @description Exact duration in seconds (mutually exclusive with min_duration/max_duration) - */ - duration?: number | null; - /** - * Format: u-int64 - * @description Minimum duration in seconds (must be used with max_duration) - */ - min_duration?: number | null; - /** - * Format: u-int64 - * @description Maximum duration in seconds (must be used with min_duration) - */ - max_duration?: number | null; + requestBody?: never; + responses: { + /** @description Enumeration value */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_AdminInstanceSkuEnumerationValue"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Key or value not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Internal error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; }; - /** @enum {string} */ - quoter_Side: "sell" | "buy"; }; - responses: never; - parameters: never; - requestBodies: never; - headers: never; - pathItems: never; -} -export type $defs = Record; -export interface operations { - get_vms_instances: { + patchInstanceSkuPropertyValue: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** @description Property key */ + key: components["schemas"]["sfc-api_Name"]; + /** @description Enumeration value to patch */ + value: components["schemas"]["sfc-api_Name"]; + }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_PatchAdminInstanceSkuPropertyValueRequest"]; + }; + }; responses: { + /** @description Updated value */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_GetInstancesResponse"]; + "application/json": components["schemas"]["sfc-api_AdminInstanceSkuEnumerationValue"]; }; }; - 401: { + /** @description Invariant violation */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_BadRequestError"]; + }; + }; + /** @description Forbidden */ + 403: { headers: { [name: string]: unknown; }; content?: never; }; + /** @description Key or value not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ 500: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; }; }; }; - get_vms_logs2: { + listInstanceSkus: { parameters: { - query: { - instance_id: string; - before_seqnum?: number; - since_seqnum?: number; - before_realtime_timestamp?: string; - since_realtime_timestamp?: string; - order_by: "seqnum_asc" | "seqnum_desc"; + query?: { limit?: number; + starting_after?: components["schemas"]["sfc-api_AdminInstanceSkusCursor"]; + ending_before?: components["schemas"]["sfc-api_AdminInstanceSkusCursor"]; + /** + * @description How many minutes of past schedule to include in + * `total_scheduled_supply` for each SKU. + */ + schedule_history_minutes?: number; }; header?: never; path?: never; @@ -4538,169 +10184,423 @@ export interface operations { }; requestBody?: never; responses: { + /** @description Paginated list of instance SKUs */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_VmsLogsResponse"]; + "application/json": components["schemas"]["sfc-api_ListAdminInstanceSkusResponse"]; }; }; - 400: { + /** @description Forbidden */ + 403: { headers: { [name: string]: unknown; }; content?: never; }; - 401: { + /** @description Validation failed */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; + }; + }; + createInstanceSku: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_CreateAdminInstanceSkuRequest"]; + }; + }; + responses: { + /** @description Instance SKU created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_AdminInstanceSku"]; + }; + }; + /** @description Validation failure */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_BadRequestError"]; + }; + }; + /** @description Forbidden */ + 403: { headers: { [name: string]: unknown; }; content?: never; }; + /** @description Owner account not found */ 404: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; }; + /** @description Internal server error */ 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; + }; + }; + getInstanceSku: { + parameters: { + query?: { + /** + * @description How many minutes of past schedule to include in + * `total_scheduled_supply`. + */ + schedule_history_minutes?: number; + }; + header?: never; + path: { + /** @description Instance SKU ID */ + id: components["schemas"]["sfc-api_InstanceSkuId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Instance SKU with registry-enriched properties */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_AdminInstanceSku"]; + }; + }; + /** @description Forbidden */ + 403: { headers: { [name: string]: unknown; }; content?: never; }; + /** @description Not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; }; }; - post_vms_replace: { + putInstanceSku: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** @description Instance SKU ID */ + id: components["schemas"]["sfc-api_InstanceSkuId"]; + }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["vmorch_PostReplaceRequest"]; + "application/json": components["schemas"]["sfc-api_PutAdminInstanceSkuRequest"]; }; }; responses: { + /** @description Updated instance SKU */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_PostReplaceResponse"]; + "application/json": components["schemas"]["sfc-api_AdminInstanceSku"]; }; }; + /** @description Properties failed validation */ 400: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_BadRequestError"]; + }; }; - 401: { + /** @description Forbidden */ + 403: { headers: { [name: string]: unknown; }; content?: never; }; + /** @description Not found */ 404: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; }; + /** @description Internal server error */ 500: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; }; }; }; - get_vms_user_data: { + deleteInstanceSku: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** @description Instance SKU ID */ + id: components["schemas"]["sfc-api_InstanceSkuId"]; + }; cookie?: never; }; requestBody?: never; responses: { + /** @description Instance SKU destroyed */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Instance SKU has active capacities and cannot be destroyed */ + 409: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ConflictError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; + /** @description Trading engine halted */ + 503: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ServiceUnavailableError"]; + }; + }; + }; + }; + patchInstanceSku: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Instance SKU ID */ + id: components["schemas"]["sfc-api_InstanceSkuId"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_PatchAdminInstanceSkuRequest"]; + }; + }; + responses: { + /** @description Updated instance SKU */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_GetUserDataResponse"]; + "application/json": components["schemas"]["sfc-api_AdminInstanceSku"]; }; }; - 401: { + /** @description Forbidden */ + 403: { headers: { [name: string]: unknown; }; content?: never; }; + /** @description Not found */ 404: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Name conflict */ + 409: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ConflictError"]; + }; }; + /** @description Internal server error */ 500: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; }; }; }; - post_vms_user_data: { + adminCreateInvoice: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** @description The account identifier to create an invoice for */ + account_id: string; + }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["vmorch_PostUserDataRequest"]; + "application/json": components["schemas"]["sfc-api_AdminCreateInvoiceRequest"]; }; }; responses: { + /** @description Invoice created and sent */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_PostUserDataResponse"]; + "application/json": components["schemas"]["sfc-api_AdminCreateInvoiceResponse"]; }; }; + /** @description Bad request */ 400: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_BadRequestError"]; + }; }; + /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; - 500: { + /** @description Forbidden */ + 403: { headers: { [name: string]: unknown; }; content?: never; }; + /** @description Account not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; }; }; - get_vms_ssh: { + list_availability: { parameters: { - query: { - vm_id: string; + query?: { + /** + * @description Filter SKUs before grouping. Semicolon-separated `key:value[,value...]` + * pairs (e.g. `accelerator:H100`). Use keys and values from + * `/v2/instance_sku_property_catalog`. + */ + requirements?: string; + /** + * @description Property keys to group by. Repeatable: `?group_by=accelerator`. Each + * key must be a public registry key. Empty `group_by` → a single + * aggregate group. + */ + group_by?: components["schemas"]["sfc-api_Name"][]; }; header?: never; path?: never; @@ -4708,62 +10608,114 @@ export interface operations { }; requestBody?: never; responses: { + /** @description Grouped availability schedules. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_GetSshResponse"]; + "application/json": components["schemas"]["sfc-api_ListAvailabilityResponse"]; }; }; + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; }; - 404: { + /** @description Validation failed. */ + 422: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; }; }; }; - list_vms_images: { + list_capacities: { parameters: { - query?: never; + query: { + /** @description Filter by workspace. */ + workspace: components["schemas"]["sfc-api_ResourcePathOrId_WorkspaceId"]; + /** @description Filter by capacity ID, resource path, or name (repeatable). */ + id?: components["schemas"]["sfc-api_ResourcePathOrId_CapacityId"][]; + limit?: number; + /** @description Set to the response's `cursor` to fetch the next page. */ + starting_after?: components["schemas"]["sfc-api_CapacitiesCursor"]; + /** @description Set to the response's `cursor` to fetch the previous page. */ + ending_before?: components["schemas"]["sfc-api_CapacitiesCursor"]; + /** @description How many minutes of past schedule to include. */ + schedule_history_minutes?: number; + /** + * @description Filter by tag key-value pair (repeatable). Format: `key=value` + * (the `=` between key and value must be percent-encoded in the URL). + */ + tag?: string[]; + /** + * @description Filter by tag key existence (repeatable). Returns resources that have + * a tag with this key, regardless of the value. + */ + tag_key?: string[]; + }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - /** @description List of images */ + /** @description Paginated list of capacities. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_ListImagesResponse"]; + "application/json": components["schemas"]["sfc-api_ListCapacitiesResponse"]; }; }; - /** @description Node API features not enabled */ - 403: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; + }; + /** @description Validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error. */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; }; }; }; - start_image_upload: { + create_capacity: { parameters: { query?: never; header?: never; @@ -4772,226 +10724,252 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["vmorch_StartMultipartUploadRequest"]; + "application/json": components["schemas"]["sfc-api_CreateCapacityRequest"]; }; }; responses: { - /** @description Image upload started successfully */ - 200: { + /** @description Capacity created. */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_StartMultipartUploadResponse"]; - }; - }; - 400: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["sfc-api_CapacityResponse"]; }; - content?: never; }; + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; }; + /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; + }; }; - 409: { + /** @description Validation failed. */ + 422: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; }; }; }; - download_image: { + fetch_capacity: { parameters: { - query?: never; + query?: { + /** @description How many minutes of past schedule to include. */ + schedule_history_minutes?: number; + }; header?: never; path: { - /** @description VM image ID */ - image_id: string; + id: string; }; cookie?: never; }; requestBody?: never; responses: { + /** @description Capacity details. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_ImageDownloadResponse"]; + "application/json": components["schemas"]["sfc-api_CapacityResponse"]; }; }; + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; - content?: never; - }; - 403: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; - content?: never; }; + /** @description Capacity not found. */ 404: { headers: { [name: string]: unknown; }; - content?: never; - }; - 409: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; - content?: never; }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; }; }; }; - complete_image_upload: { + delete_capacity: { parameters: { query?: never; header?: never; path: { - /** @description VM image ID */ - image_id: string; + id: string; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["vmorch_CompleteUploadRequest"]; - }; - }; + requestBody?: never; responses: { - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["vmorch_CompleteUploadResponse"]; - }; - }; - 400: { + /** @description Capacity deleted. */ + 204: { headers: { [name: string]: unknown; }; content?: never; }; + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; }; - 403: { + /** @description Capacity not found. */ + 404: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; }; - 404: { + /** @description Capacity has active dependencies. */ + 422: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; }; }; }; - create_image_upload_url: { + update_capacity: { parameters: { query?: never; header?: never; path: { - /** @description VM image ID */ - image_id: string; + id: string; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["vmorch_ImageUploadRequest"]; + "application/json": components["schemas"]["sfc-api_PatchCapacityRequest"]; }; }; responses: { + /** @description Capacity updated. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_ImageUploadResponse"]; + "application/json": components["schemas"]["sfc-api_CapacityResponse"]; }; }; - 400: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; }; - 401: { + /** @description Forbidden. */ + 403: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; + }; }; - 403: { + /** @description Capacity not found. */ + 404: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; }; - 404: { + /** @description Validation failed. */ + 422: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; }; }; }; - list_images_v2: { + list_capacity_transfers: { parameters: { query?: { - /** @description Maximum number of results to return (1-200, default 50). */ + /** + * @description Filter by source or destination capacity (repeatable). Returns + * transfers where `from_capacity_id` or `to_capacity_id` is any of the + * supplied capacities. + */ + capacity?: components["schemas"]["sfc-api_ResourcePathOrId_CapacityId"][]; + /** @description Filter by transfer status. */ + status?: components["schemas"]["sfc-api_CapacityTransferStatus"]; limit?: number; - /** @description Cursor for forward pagination (from a previous response's `cursor` field). */ - starting_after?: components["schemas"]["vmorch_ImagesCursor"]; - /** @description Cursor for backward pagination. */ - ending_before?: components["schemas"]["vmorch_ImagesCursor"]; - /** @description Workspace URN (e.g. sfc:workspace:{account_id}:default). */ - workspace?: string; + /** @description Set to the response's `cursor` to fetch the next page. */ + starting_after?: components["schemas"]["sfc-api_CapacityTransfersCursor"]; + /** @description Set to the response's `cursor` to fetch the previous page. */ + ending_before?: components["schemas"]["sfc-api_CapacityTransfersCursor"]; }; header?: never; path?: never; @@ -4999,192 +10977,311 @@ export interface operations { }; requestBody?: never; responses: { - /** @description List of images */ + /** @description Paginated list of capacity transfers. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_ListImagesResponse"]; + "application/json": components["schemas"]["sfc-api_v2.ListCapacityTransfersResponse"]; }; }; - /** @description Features not enabled */ - 403: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; + }; + /** @description Validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error. */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - start_upload: { + create_capacity_transfer: { parameters: { query?: never; - header?: never; + header?: { + /** @description Unique key for idempotent transfer creation. */ + "Idempotency-Key"?: string | null; + }; path?: never; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["vmorch_StartUploadRequest"]; + "application/json": components["schemas"]["sfc-api_v2.CreateCapacityTransferRequest"]; }; }; responses: { - 201: { + /** @description Capacity transfer accepted. */ + 202: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_ImageResponse"]; + "application/json": components["schemas"]["sfc-api_v2.CapacityTransferResponse"]; }; }; - 400: { + /** @description Unauthorized. */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden. */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; + }; + }; + /** @description Not found. */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error. */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; + /** @description Service temporarily unavailable. Try again later. */ + 503: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_ServiceUnavailableError"]; }; }; - 401: { + }; + }; + fetch_capacity_transfer: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description Capacity transfer ID + * @example cxfr_abc123 + */ + id: components["schemas"]["sfc-api_CapacityTransferId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Capacity transfer details. */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_v2.CapacityTransferResponse"]; }; }; - 403: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - 409: { + /** @description Capacity transfer not found. */ + 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - get_image: { + list_deployments: { parameters: { - query?: never; - header?: never; - path: { - id: string; + query: { + /** @description Filter by workspace. */ + workspace: components["schemas"]["sfc-api_ResourcePathOrId_WorkspaceId"]; + capacity?: components["schemas"]["sfc-api_ResourcePathOrId_CapacityId"]; + limit?: number; + starting_after?: components["schemas"]["sfc-api_DeploymentsCursor"]; + ending_before?: components["schemas"]["sfc-api_DeploymentsCursor"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { + /** @description Paginated list of deployments. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_ImageResponse"]; + "application/json": components["schemas"]["sfc-api_ListDeploymentsResponse"]; }; }; + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - 404: { + /** @description Validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error. */ + 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - complete_upload: { + create_deployment: { parameters: { query?: never; header?: never; - path: { - id: string; - }; + path?: never; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["vmorch_CompleteUploadRequest"]; + "application/json": components["schemas"]["sfc-api_CreateDeploymentRequest"]; }; }; responses: { - 200: { + /** @description Deployment created. */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_CompleteUploadResponse"]; + "application/json": components["schemas"]["sfc-api_DeploymentResponse"]; }; }; + /** @description Deployment with this name already exists. */ 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; + /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; + /** @description Capacity or node template not found. */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - download_image_v2: { + get_deployment: { parameters: { query?: never; header?: never; @@ -5195,49 +11292,45 @@ export interface operations { }; requestBody?: never; responses: { + /** @description Deployment details. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_ImageDownloadResponse"]; + "application/json": components["schemas"]["sfc-api_DeploymentResponse"]; }; }; + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; + /** @description Deployment not found. */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; - }; - }; - 409: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - upload_part: { + delete_deployment: { parameters: { query?: never; header?: never; @@ -5246,462 +11339,376 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["vmorch_UploadPartRequest"]; - }; - }; + requestBody?: never; responses: { - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["vmorch_UploadPartResponse"]; - }; - }; - 400: { + /** @description Deployment deleted. */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; - }; + content?: never; }; + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; + /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; + /** @description Deployment not found. */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - list_nodes: { + patch_deployment: { parameters: { - query?: { - /** @description Filter by node ID (can be repeated, e.g. `?id=&id=`). */ - id?: components["schemas"]["vmorch_NodeId"][]; - capacity?: components["schemas"]["vmorch_CapacityId"]; - /** @description Filter by node status. When not specified, destroyed nodes are excluded. */ - status?: components["schemas"]["vmorch_NodeStatus"][]; - /** @description Maximum number of results to return (1–200, default 50). */ - limit?: number; - /** @description Cursor for forward pagination (from a previous response's `cursor` field). */ - starting_after?: components["schemas"]["vmorch_NodesCursor"]; - /** @description Cursor for backward pagination. */ - ending_before?: components["schemas"]["vmorch_NodesCursor"]; - }; + query?: never; header?: never; - path?: never; + path: { + id: string; + }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_PatchDeploymentRequest"]; + }; + }; responses: { - /** @description List of nodes */ + /** @description Deployment updated. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_ListNodesResponse"]; + "application/json": components["schemas"]["sfc-api_DeploymentResponse"]; }; }; - /** @description Invalid request */ + /** @description Deployment with this name already exists. */ 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; - /** @description Unauthorized */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - }; - }; - get_node: { - parameters: { - query?: never; - header?: never; - path: { - /** @description Node ID */ - id: components["schemas"]["vmorch_NodeId"]; + /** @description Forbidden. */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; + }; }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Node details */ - 200: { + /** @description Deployment not found. */ + 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_NodeResponse"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Unauthorized */ - 401: { + /** @description Validation failed. */ + 422: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Node not found */ - 404: { + /** @description Internal server error. */ + 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - get_node_logs: { + list_grants_handler: { parameters: { query?: { - /** @description Return logs with seqnum <= this value. */ - before_seqnum?: number; - /** @description Return logs with seqnum >= this value. */ - since_seqnum?: number; - /** - * @description Return logs before this unix timestamp (seconds). Due to clock synchronization, - * some earlier log messages may have a realtime timestamp after this value. - */ - before_realtime_timestamp?: components["schemas"]["vmorch_UnixEpoch"]; - /** - * @description Return logs after this unix timestamp (seconds). Due to clock synchronization, - * some later log messages may have a realtime timestamp before this value. - */ - since_realtime_timestamp?: components["schemas"]["vmorch_UnixEpoch"]; - sort_by?: "seqnum" | "-seqnum"; - limit?: number; + workspace_id?: components["schemas"]["sfc-api_WorkspaceId"]; + /** @description Either a `usr_*` / legacy user id or a `tokn_*` token id. */ + principal_id?: string; }; header?: never; - path: { - /** @description Node ID */ - id: components["schemas"]["vmorch_NodeId"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - /** @description Log chunks */ + /** @description Grants listed. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_NodeLogsResponse"]; + "application/json": components["schemas"]["sfc-api_ListGrantsResponse"]; }; }; - /** @description Invalid request */ - 400: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Unauthorized */ - 401: { + /** @description Forbidden. */ + 403: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; - /** @description Node not found */ - 404: { + /** @description Internal server error. */ + 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - replace_node: { + create_grant_handler: { parameters: { query?: never; header?: never; - path: { - /** @description Node ID */ - id: components["schemas"]["vmorch_NodeId"]; - }; + path?: never; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["vmorch_ReplaceNodeRequest"]; + "application/json": components["schemas"]["sfc-api_CreateGrantRequest"]; }; }; responses: { - /** @description Replacement node */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["vmorch_NodeResponse"]; - }; - }; - /** @description Unauthorized */ - 401: { + /** @description Grant created. */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_GrantResponse"]; }; }; - /** @description Feature not enabled */ - 403: { + /** @description Invalid request. */ + 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; - /** @description Node not found */ - 404: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - }; - }; - get_node_ssh: { - parameters: { - query?: never; - header?: never; - path: { - /** @description Node ID */ - id: components["schemas"]["vmorch_NodeId"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description SSH connection details */ - 200: { + /** @description Forbidden. */ + 403: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_NodeSshInfo"]; + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; - /** @description Unauthorized */ - 401: { + /** @description Grant already exists. */ + 409: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_ConflictError"]; }; }; - /** @description SSH details not available */ - 404: { + /** @description Internal server error. */ + 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["vmorch_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - list_zones_handler: { + get_grant_handler: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** @description Grant ID */ + id: components["schemas"]["sfc-api_GrantId"]; + }; cookie?: never; }; requestBody?: never; responses: { - /** @description List of zones */ + /** @description Grant found. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ListResponse_ZoneInfo"]; + "application/json": components["schemas"]["sfc-api_GrantResponse"]; }; }; - /** @description Unauthorized request */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Internal server error */ + /** @description Grant not found. */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - get_zone_handler: { + delete_grant_handler: { parameters: { query?: never; header?: never; path: { - /** @description Zone ID */ - id: string; + /** @description Grant ID */ + id: components["schemas"]["sfc-api_GrantId"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Zone information */ - 200: { + /** @description Grant deleted. */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["node-api_ZoneInfo"]; - }; + content?: never; }; - /** @description Unauthorized request */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Forbidden */ + /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; - /** @description Zone not found */ + /** @description Grant not found. */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; - }; - }; - /** @description Internal server error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; - }; - }; - }; - }; - health_handler: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Health check successful */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "text/plain": string; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Health check failed */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "text/plain": string; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - list_nodes_handler: { + list_images: { parameters: { - query?: { - /** - * @description Filter nodes by node_id - * Use ?id=n_b1dc52505c6db142&id=n_b1dc52505c6db133 to specify multiple IDs. - * Cannot combine with name or node_type - */ - id?: string[]; - /** - * @description Filter nodes by their names - * Use ?name=val1&name=val2 to specify multiple names. - * Cannot combine with id or node_type - */ - name?: string[]; + query: { /** - * @description Filter nodes by their type - * Cannot combine with id or name - * @example autoreserved + * @description Filter by workspace. Pass `sfc:workspace:sfcompute:public` to list + * sfc-provided public images. */ - type?: components["schemas"]["node-api_NodeType"]; + workspace: components["schemas"]["sfc-api_ResourcePathOrId_WorkspaceId"]; + /** @description Filter by image ID (repeatable). */ + id?: components["schemas"]["sfc-api_ImageId"][]; + /** @description Maximum number of results to return (1-200, default 50). */ + limit?: number; + /** @description Cursor for forward pagination (from a previous response's `cursor` field). */ + starting_after?: components["schemas"]["sfc-api_ImagesCursor"]; + /** @description Cursor for backward pagination. */ + ending_before?: components["schemas"]["sfc-api_ImagesCursor"]; }; header?: never; path?: never; @@ -5709,22 +11716,22 @@ export interface operations { }; requestBody?: never; responses: { - /** @description List of nodes */ + /** @description Paginated list of images */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ListResponse_Node"]; + "application/json": components["schemas"]["sfc-api_ListImagesResponse"]; }; }; - /** @description Bad request */ + /** @description Bad request. */ 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; /** @description Unauthorized request */ @@ -5733,16 +11740,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; - }; - }; - /** @description Forbidden */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; /** @description Internal server error */ @@ -5751,12 +11749,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - create_nodes_handler: { + create_image: { parameters: { query?: never; header?: never; @@ -5765,26 +11763,26 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["node-api_CreateNodesRequest"]; + "application/json": components["schemas"]["sfc-api_StartUploadRequest"]; }; }; responses: { - /** @description Nodes created successfully */ + /** @description Image created */ 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ListResponse_Node"]; + "application/json": components["schemas"]["sfc-api_ImageUploadResponse"]; }; }; - /** @description Bad request */ + /** @description Validation failed */ 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; /** @description Unauthorized request */ @@ -5793,25 +11791,16 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; - }; - }; - /** @description Payment Required */ - 402: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Forbidden */ - 403: { + /** @description Image already exists */ + 409: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_ConflictError"]; }; }; /** @description Internal server error */ @@ -5820,39 +11809,30 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - get_node_handler: { + fetch_image: { parameters: { query?: never; header?: never; path: { - /** @description Node ID or name */ + /** @description Image ID or resource path */ id: string; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Node details */ + /** @description Image details */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_Node"]; - }; - }; - /** @description Bad request */ - 400: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_ImageListEntry"]; }; }; /** @description Unauthorized request */ @@ -5861,25 +11841,16 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; - }; - }; - /** @description Forbidden */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Node not found */ + /** @description Image not found */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; /** @description Internal server error */ @@ -5888,37 +11859,30 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - delete_node_handler: { + delete_image: { parameters: { query?: never; header?: never; path: { - /** @description Node ID or name */ + /** @description Image ID, name, or resource path */ id: string; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Node deleted successfully */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Bad request */ - 400: { + /** @description Image deleted */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_DeleteImageResponse"]; }; }; /** @description Unauthorized request */ @@ -5927,25 +11891,34 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Forbidden */ + /** @description Image cannot be deleted via this endpoint (e.g. default images) */ 403: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; - /** @description Node not found */ + /** @description Image not found */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Image is referenced by an instance template or in use by an active instance */ + 409: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ConflictError"]; }; }; /** @description Internal server error */ @@ -5954,43 +11927,43 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - extend_node_handler: { + complete_image_upload: { parameters: { query?: never; header?: never; path: { - /** @description Node ID or name */ + /** @description Image ID, name, or resource path */ id: string; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["node-api_ExtendNodeRequest"]; + "application/json": components["schemas"]["sfc-api_CompleteUploadRequest"]; }; }; responses: { - /** @description Node extended successfully */ + /** @description Upload completed */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_Node"]; + "application/json": components["schemas"]["sfc-api_ImageUploadResponse"]; }; }; - /** @description Bad request */ + /** @description Validation failed */ 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; /** @description Unauthorized request */ @@ -5999,34 +11972,75 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Forbidden */ - 403: { + /** @description Image not found */ + 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Node not found */ + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; + }; + }; + download_image: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Image ID, name, or resource path */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Download URL generated */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ImageDownloadResponse"]; + }; + }; + /** @description Unauthorized request */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; + }; + /** @description Image not found */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Extension failed due to capacity */ - 422: { + /** @description Image upload not completed */ + 409: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_ConflictError"]; }; }; /** @description Internal server error */ @@ -6035,43 +12049,43 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - redeploy_node_handler: { + create_image_upload_part_url: { parameters: { query?: never; header?: never; path: { - /** @description Node ID or name */ + /** @description Image ID, name, or resource path */ id: string; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["node-api_RedeployNodeRequest"]; + "application/json": components["schemas"]["sfc-api_UploadPartRequest"]; }; }; responses: { - /** @description Node redeployed successfully */ + /** @description Upload URL generated */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_Node"]; + "application/json": components["schemas"]["sfc-api_UploadPartResponse"]; }; }; - /** @description Bad request */ + /** @description Validation failed */ 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; /** @description Unauthorized request */ @@ -6080,34 +12094,16 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; - }; - }; - /** @description Forbidden */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Node not found */ + /** @description Image not found */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; - }; - }; - /** @description Redeploy failed due to invalid state */ - 422: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; /** @description Internal server error */ @@ -6116,66 +12112,66 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - release_node_handler: { + revoke_image: { parameters: { query?: never; header?: never; path: { - /** @description Node ID or name */ + /** @description Image ID, name, or resource path */ id: string; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Node released successfully */ + /** @description Image revoked */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_Node"]; + "application/json": components["schemas"]["sfc-api_ImageListEntry"]; }; }; - /** @description Bad request */ - 400: { + /** @description Unauthorized request */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Unauthorized request */ - 401: { + /** @description Public images can't be revoked */ + 403: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; - /** @description Forbidden */ - 403: { + /** @description Image not found */ + 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Node not found */ - 404: { + /** @description Image isn't in completed status */ + 409: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_ConflictError"]; }; }; /** @description Internal server error */ @@ -6184,151 +12180,74 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["node-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - listClusters: { + list_instance_sku_property_catalog: { parameters: { - query?: never; + query?: { + /** @description Maximum number of results to return (1-200, default 50). */ + limit?: number; + /** @description Cursor for forward pagination (from a previous response's `cursor` field). */ + starting_after?: string; + /** @description Cursor for backward pagination. */ + ending_before?: string; + }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - /** @description List of Kubernetes clusters */ + /** @description Paginated property catalog. */ 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "object": "list", - * "data": [ - * { - * "object": "kubernetes_cluster", - * "name": "starlight", - * "kubernetes_namespace": "sf-user123", - * "kubernetes_api_url": "https://starlight.sf-k8s.com", - * "kubernetes_ca_cert": "-----BEGIN CERTIFICATE-----...", - * "contract": { - * "object": "contract", - * "status": "active", - * "id": "cont_xyz123", - * "created_at": "2024-07-15T22:30:17.426Z", - * "instance_type": "h100i", - * "shape": { - * "intervals": [ - * "2024-07-16T00:00:00Z", - * "2024-07-17T00:00:00Z" - * ], - * "quantities": [ - * 4, - * 0 - * ] - * }, - * "colocate_with": [], - * "cluster_id": "clstr_abc456", - * "state": "Active", - * "is_node": false - * } - * } - * ], - * "has_more": false - * } - */ - "application/json": components["schemas"]["market-api_ListClustersResponse"]; + "application/json": components["schemas"]["sfc-api_ListInstanceSkuPropertyCatalogResponse"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "authentication_error", - * "message": "missing authentication token" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Forbidden - account frozen */ - 403: { + /** @description Validation failed. */ + 422: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "forbidden", - * "message": "Account is frozen" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "api_error", - * "message": "An internal server error occurred" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - listContracts: { + list_instance_skus: { parameters: { query?: { - /** - * @description Filter by instance type - * @example h100i - */ - instance_type?: components["schemas"]["market-api_Ticker"]; - /** - * @description Start of interval to find active contracts. Must be used with active_within_interval_end - * @example 2024-01-01T00:00:00Z - */ - active_within_interval_start?: components["schemas"]["market-api_ISO8601DateTime"]; - /** - * @description End of interval to find active contracts. Must be used with active_within_interval_start - * @example 2024-01-02T00:00:00Z - */ - active_within_interval_end?: components["schemas"]["market-api_ISO8601DateTime"]; - /** - * @description Filter by contract state. Options: "All", "Upcoming", "Active", "Expired". Default excludes expired contracts - * @example Active - */ - state?: string; - /** - * @description Include contracts managed by the Nodes API - * @example true - */ - include_nodes?: boolean; - /** - * @description Include contracts associated with procurements - * @example true - */ - include_procurements?: boolean; + /** @description Maximum number of results to return (1-200, default 50). */ + limit?: number; + /** @description Cursor for forward pagination (from a previous response's `cursor` field). */ + starting_after?: components["schemas"]["sfc-api_InstanceSkusCursor"]; + /** @description Cursor for backward pagination. */ + ending_before?: components["schemas"]["sfc-api_InstanceSkusCursor"]; }; header?: never; path?: never; @@ -6336,1941 +12255,1517 @@ export interface operations { }; requestBody?: never; responses: { - /** @description List of contracts */ + /** @description Paginated list of instance SKUs. */ 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "object": "list", - * "data": [ - * { - * "object": "contract", - * "status": "active", - * "id": "cont_xyz789", - * "created_at": "2024-07-15T22:30:17.426Z", - * "instance_type": "h100i", - * "shape": { - * "intervals": [ - * "2024-07-16T00:00:00Z", - * "2024-07-17T00:00:00Z" - * ], - * "quantities": [ - * 10, - * 0 - * ] - * }, - * "state": "Active", - * "is_node": false, - * "procurement_id": "proc_1234567890abcdef" - * } - * ], - * "has_more": false - * } - */ - "application/json": components["schemas"]["market-api_ListContractsResponse"]; - }; - }; - /** @description Bad request - invalid query parameters */ - 400: { - headers: { - [name: string]: unknown; - }; - content: { - /** - * @example { - * "error": { - * "type": "invalid_request_error", - * "message": "must provide both active_within_interval_start and active_within_interval_end or none of them" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_ListInstanceSkusResponse"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "authentication_error", - * "message": "missing authentication token" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Forbidden - account frozen */ - 403: { + /** @description Validation failed. */ + 422: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "forbidden", - * "message": "Account is frozen" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "api_error", - * "message": "An internal server error occurred" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - getContract: { + get_instance_sku: { parameters: { query?: never; header?: never; path: { - /** - * @description Contract ID - * @example cont_xyz789 - */ - id: components["schemas"]["market-api_ContractId"]; + /** @description Instance SKU ID */ + id: components["schemas"]["sfc-api_InstanceSkuId"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Contract details */ + /** @description Instance SKU details. */ 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "object": "contract", - * "status": "active", - * "id": "cont_xyz789", - * "created_at": "2024-07-15T22:30:17.426Z", - * "instance_type": "h100i", - * "shape": { - * "intervals": [ - * "2024-07-16T22:30:16Z", - * "2024-07-17T22:30:16Z", - * "2024-07-18T22:30:16Z" - * ], - * "quantities": [ - * 10, - * 20, - * 0 - * ] - * }, - * "colocate_with": [ - * "cont_abc456" - * ], - * "cluster_id": "clus_xyz123", - * "state": "Active", - * "is_node": false, - * "procurement_id": "proc_1234567890abcdef" - * } - */ - "application/json": components["schemas"]["market-api_ContractResponse"]; + "application/json": components["schemas"]["sfc-api_InstanceSku"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "authentication_error", - * "message": "missing authentication token" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; - }; - }; - /** @description Forbidden - account frozen */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - /** - * @example { - * "error": { - * "type": "forbidden", - * "message": "Account is frozen" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Contract not found */ + /** @description Instance SKU not found. */ 404: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "not_found", - * "message": "Contract not found" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "api_error", - * "message": "An internal server error occurred" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - listOrders: { + list_instance_templates: { parameters: { - query?: { - /** @description Filter by order side (buy or sell) */ - side?: components["schemas"]["market-api_OrderSide"]; - /** @description Filter by instance type */ - instance_type?: components["schemas"]["market-api_Ticker"]; - /** @description Minimum price in cents */ - min_price?: number; - /** @description Maximum price in cents */ - max_price?: number; - /** @description Minimum start date */ - min_start_date?: components["schemas"]["market-api_ISO8601DateTime"]; - /** @description Maximum start date */ - max_start_date?: components["schemas"]["market-api_ISO8601DateTime"]; - /** @description Minimum duration in seconds */ - min_duration?: components["schemas"]["market-api_UnixEpoch"]; - /** @description Maximum duration in seconds */ - max_duration?: components["schemas"]["market-api_UnixEpoch"]; - /** @description Minimum quantity */ - min_quantity?: number; - /** @description Maximum quantity */ - max_quantity?: number; - /** @description Filter by contract ID */ - contract_id?: components["schemas"]["market-api_ContractId"]; - /** @description Show only open orders */ - only_open?: boolean; - /** @description Exclude filled orders */ - exclude_filled?: boolean; - /** @description Show only filled orders */ - only_filled?: boolean; - /** @description Minimum filled at date */ - min_filled_at?: components["schemas"]["market-api_ISO8601DateTime"]; - /** @description Maximum filled at date */ - max_filled_at?: components["schemas"]["market-api_ISO8601DateTime"]; - /** @description Minimum fill price in cents */ - min_fill_price?: number; - /** @description Maximum fill price in cents */ - max_fill_price?: number; - /** @description Exclude cancelled orders */ - exclude_cancelled?: boolean; - /** @description Show only cancelled orders */ - only_cancelled?: boolean; - /** @description Minimum cancelled at date */ - min_cancelled_at?: components["schemas"]["market-api_ISO8601DateTime"]; - /** @description Maximum cancelled at date */ - max_cancelled_at?: components["schemas"]["market-api_ISO8601DateTime"]; - /** @description Minimum placed at date */ - min_placed_at?: components["schemas"]["market-api_ISO8601DateTime"]; - /** @description Maximum placed at date */ - max_placed_at?: components["schemas"]["market-api_ISO8601DateTime"]; - /** @description Maximum number of results to return (default: 100, max: 100) */ + query: { + /** @description Filter by workspace. */ + workspace: components["schemas"]["sfc-api_ResourcePathOrId_WorkspaceId"]; + /** @description Filter by instance template ID or name (repeatable). */ + id?: components["schemas"]["sfc-api_ResourcePathOrId_InstanceTemplateId"][]; limit?: number; - /** @description Number of results to skip */ - offset?: number; - /** @description Sort field */ - sort_by?: components["schemas"]["market-api_SortBy"]; - /** @description Sort direction */ - sort_direction?: components["schemas"]["market-api_SortDirection"]; - include_public?: unknown; + /** @description Set to the response's `cursor` to fetch the next page. */ + starting_after?: components["schemas"]["sfc-api_InstanceTemplatesCursor"]; + /** @description Set to the response's `cursor` to fetch the previous page. */ + ending_before?: components["schemas"]["sfc-api_InstanceTemplatesCursor"]; + /** @description Additional fields to include in the response. */ + include?: components["schemas"]["sfc-api_InstanceTemplateInclude"][]; }; header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description List of orders */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - /** - * @example { - * "object": "list", - * "data": [ - * { - * "object": "order", - * "id": "ordr_xyz123", - * "side": "buy", - * "instance_type": "h100i", - * "price": 1600, - * "quantity": 2, - * "status": "open", - * "created_at": "2024-07-15T22:30:17.426Z", - * "start_at": "2024-07-16T00:00:00Z", - * "end_at": "2024-07-17T00:00:00Z", - * "flags": { - * "ioc": false, - * "post_only": false, - * "market": false, - * "prorate": false - * } - * } - * ], - * "has_more": false - * } - */ - "application/json": components["schemas"]["market-api_ListOrdersResponse"]; - }; - }; - /** @description Invalid request parameters */ - 400: { + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Paginated list of instance templates. */ + 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "invalid_request_error", - * "message": "Cannot specify both 'only_filled' and 'only_cancelled'" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_ListInstanceTemplatesResponse"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "authentication_error", - * "message": "missing authentication token" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Forbidden - account frozen */ - 403: { + /** @description Validation failed. */ + 422: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "forbidden", - * "message": "Account is frozen" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "api_error", - * "message": "An internal server error occurred" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - createOrder: { + create_instance_template: { parameters: { query?: never; - header?: { - /** @description Optional key to ensure idempotent order creation */ - "Idempotency-Key"?: string | null; - }; + header?: never; path?: never; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["market-api_CreateOrderRequest"]; + "application/json": components["schemas"]["sfc-api_CreateInstanceTemplateRequest"]; }; }; responses: { - /** @description Order created successfully */ + /** @description Instance template created. */ 201: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "object": "order", - * "status": "pending", - * "id": "order_xyz789", - * "idempotency_key": "key_123" - * } - */ - "application/json": components["schemas"]["market-api_CreateOrderResponse"]; + "application/json": components["schemas"]["sfc-api_InstanceTemplateResponse"]; }; }; - /** @description Invalid request parameters */ - 400: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "invalid_request_error", - * "message": "Start time must be within +/- 1 minute of now, on a future hour, or the string literal 'NOW'", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ - 401: { + /** @description Validation failed. */ + 422: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "authentication_error", - * "message": "missing authentication token", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Forbidden - account frozen, insufficient credits, unauthorized seller, or trading halted */ - 403: { + /** @description Internal server error. */ + 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "forbidden", - * "message": "Account is frozen", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; - /** @description Not found - contract or cluster not found */ - 404: { + }; + }; + fetch_instance_template: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Instance template details. */ + 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "not_found", - * "message": "Contract not found", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InstanceTemplateResponse"]; }; }; - /** @description Upgrade required - legacy account needs migration */ - 426: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "invalid_request_error", - * "message": "Legacy account must be upgraded before placing orders", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Internal server error */ + /** @description Instance template not found. */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "api_error", - * "message": "An internal server error occurred", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - getOrder: { + delete_instance_template: { parameters: { query?: never; header?: never; path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Instance template deleted. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Unauthorized. */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; + }; + /** @description Instance template not found. */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Instance template is in use. */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error. */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; + }; + }; + list_instances: { + parameters: { + query: { + /** @description Filter by workspace. */ + workspace: components["schemas"]["sfc-api_ResourcePathOrId_WorkspaceId"]; /** - * @description Order ID - * @example order_xyz789 + * @description Filter by instance ID (repeatable). + * @example inst_k3R-nX9vLm7Qp2Yw5Jd8F */ - id: components["schemas"]["market-api_OrderId"]; + id?: components["schemas"]["sfc-api_InstanceId"][]; + /** @description Filter by capacity. */ + capacity?: components["schemas"]["sfc-api_ResourcePathOrId_CapacityId"]; + /** @description Filter by instance status (repeatable). */ + status?: components["schemas"]["sfc-api_InstanceStatus"][]; + limit?: number; + /** @description Cursor for forward pagination (from a previous response's `cursor` field). */ + starting_after?: components["schemas"]["sfc-api_InstancesCursor"]; + /** @description Cursor for backward pagination. */ + ending_before?: components["schemas"]["sfc-api_InstancesCursor"]; + /** @description Additional fields to include in the response. */ + include?: components["schemas"]["sfc-api_InstanceInclude"][]; + /** + * @description Filter by tag key-value pair (repeatable). Format: `key=value` + * (the `=` between key and value must be percent-encoded in the URL). + */ + tag?: string[]; + /** + * @description Filter by tag key existence (repeatable). Returns resources that have + * a tag with this key, regardless of the value. + */ + tag_key?: string[]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - /** @description Order details */ + /** @description Paginated list of instances. */ 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "object": "order", - * "id": "order_xyz789", - * "side": "buy", - * "status": "open", - * "instance_type": "h100i", - * "quantity": 4, - * "start_at": "2021-01-01T00:00:00Z", - * "end_at": "2021-01-01T01:00:00Z", - * "price": 2850000, - * "flags": { - * "market": false, - * "post_only": false, - * "ioc": false - * }, - * "executed": false, - * "cancelled": false, - * "colocate_with": [], - * "created_at": "2021-01-01T00:00:00Z", - * "rejected": false - * } - */ - "application/json": components["schemas"]["market-api_OrderResponse"]; + "application/json": components["schemas"]["sfc-api_ListInstancesResponse"]; + }; + }; + /** @description Unauthorized. */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; + }; + /** @description Capacity not found. */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error. */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; + }; + }; + create_instance: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_CreateInstanceRequest"]; + }; + }; + responses: { + /** @description Instance created. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InstanceResponse"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "authentication_error", - * "message": "missing authentication token", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Forbidden - user not authorized to view this order */ + /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "forbidden", - * "message": "User not authorized to view this order", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; - /** @description Order not found */ + /** @description Capacity not found. */ 404: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "not_found", - * "message": "Order not found", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Internal server error */ + /** @description Validation error (e.g. capacity limit reached). */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "api_error", - * "message": "An internal server error occurred", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - cancelOrder: { + batch_patch_instances: { parameters: { query?: never; header?: never; - path: { - /** - * @description Order ID - * @example ordr_xyz789 - */ - id: components["schemas"]["market-api_OrderId"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_BatchPatchInstancesRequest"]; + }; + }; responses: { - /** @description Order cancelled successfully */ + /** @description Instances updated. */ 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "object": "pending" - * } - */ - "application/json": components["schemas"]["market-api_CancelOrderResponse"]; + "application/json": components["schemas"]["sfc-api_BatchPatchInstancesResponse"]; }; }; - /** @description Order already cancelled */ - 400: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "validation_error", - * "message": "Order already cancelled", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Order not found */ - 404: { + /** @description Unknown instance, cross-workspace batch, or batch over the entry cap. */ + 422: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "not_found", - * "message": "Order not found", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "api_error", - * "message": "An internal server error occurred", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - getOrderClusters: { + fetch_instance: { parameters: { query?: never; header?: never; path: { - /** - * @description Order ID - * @example ordr_W9TRG - */ - id: components["schemas"]["market-api_OrderId"]; + id: string; }; cookie?: never; }; requestBody?: never; responses: { - /** @description List of clusters associated with the order */ + /** @description Instance details. */ 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "object": "list", - * "data": [ - * { - * "object": "kubernetes_cluster", - * "name": "starlight", - * "kubernetes_namespace": "sf-user123", - * "kubernetes_api_url": "https://starlight.sf-k8s.com", - * "kubernetes_ca_cert": "-----BEGIN CERTIFICATE-----...", - * "contract": { - * "object": "contract", - * "status": "active", - * "id": "cont_xyz123", - * "created_at": "2024-07-15T22:30:17.426Z", - * "instance_type": "h100i", - * "shape": { - * "intervals": [ - * "2024-07-16T00:00:00Z", - * "2024-07-17T00:00:00Z" - * ], - * "quantities": [ - * 4, - * 0 - * ] - * }, - * "colocate_with": [], - * "cluster_id": "clstr_abc456", - * "state": "Active", - * "is_node": false - * } - * } - * ], - * "has_more": false - * } - */ - "application/json": components["schemas"]["market-api_ListClustersResponse"]; + "application/json": components["schemas"]["sfc-api_InstanceResponse"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "authentication_error", - * "message": "missing authentication token" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; - }; - }; - /** @description Forbidden - account frozen */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - /** - * @example { - * "error": { - * "type": "forbidden", - * "message": "Account is frozen" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Order not found */ + /** @description Instance not found. */ 404: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "not_found", - * "message": "Order not found" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "api_error", - * "message": "An internal server error occurred" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - listProcurements: { + delete_instance: { parameters: { query?: never; header?: never; - path?: never; + path: { + id: string; + }; cookie?: never; }; requestBody?: never; responses: { - /** @description List of procurements */ - 200: { + /** @description Instance deleted. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "object": "list", - * "data": [ - * { - * "object": "procurement", - * "id": "proc_test123", - * "status": "active", - * "instance_type": "h100i", - * "desired_quantity": 5, - * "buy_limit_price_per_gpu_hour": 250, - * "sell_limit_price_per_gpu_hour": 25, - * "horizon": 60, - * "colocation_strategy": "colocate_pinned", - * "actual_quantity": 5, - * "active_order_count": 2, - * "last_message": "Running" - * } - * ], - * "has_more": false - * } - */ - "application/json": components["schemas"]["market-api_ListProcurementsResponse"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ - 401: { + /** @description Instance not found. */ + 404: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "authentication_error", - * "message": "missing authentication token" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Forbidden - account frozen */ - 403: { + /** @description Instance must be terminated before deletion. */ + 409: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "forbidden", - * "message": "Account is frozen" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_ConflictError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "api_error", - * "message": "An internal server error occurred" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - createProcurement: { + update_instance: { parameters: { query?: never; header?: never; - path?: never; + path: { + id: string; + }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["market-api_CreateProcurementRequest"]; + "application/json": components["schemas"]["sfc-api_PatchInstanceRequest"]; }; }; responses: { - /** @description Successfully created procurement */ - 201: { + /** @description Instance updated. */ + 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "object": "procurement", - * "id": "proc_xyz123", - * "status": "active", - * "instance_type": "h100i", - * "desired_quantity": 5, - * "buy_limit_price_per_gpu_hour": 250, - * "sell_limit_price_per_gpu_hour": 25, - * "horizon": 60, - * "colocation_strategy": "colocate_pinned", - * "actual_quantity": 0, - * "active_order_count": 0 - * } - */ - "application/json": components["schemas"]["market-api_ProcurementResponse"]; + "application/json": components["schemas"]["sfc-api_InstanceResponse"]; }; }; - /** @description Bad request - invalid field values */ + /** @description Validation error (e.g. duplicate name). */ 400: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "invalid_request_error", - * "message": "desired_quantity must be non-negative" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "authentication_error", - * "message": "missing authentication token" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; - }; - }; - /** @description Payment required - insufficient funds */ - 402: { - headers: { - [name: string]: unknown; - }; - content: { - /** - * @example { - * "error": { - * "type": "payment_required", - * "message": "insufficient funds" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Forbidden - account frozen */ + /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "forbidden", - * "message": "Account is frozen" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; - /** @description Not found - cluster not found */ + /** @description Instance not found. */ 404: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "not_found", - * "message": "cluster starlight not found" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "api_error", - * "message": "An internal server error occurred" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - getProcurement: { + get_instance_logs: { parameters: { - query?: never; - header?: never; - path: { + query?: { + /** @description Return logs with `seqnum` less than or equal to this value. */ + seqnum_before?: number; + /** @description Return logs with `seqnum` greater than or equal to this value. */ + seqnum_after?: number; /** - * @description Procurement ID - * @example proc_xyz123 + * @description Due to clock synchronization, some earlier log messages may have a + * realtime timestamp after this value. + */ + realtime_timestamp_before?: components["schemas"]["sfc-api_UnixEpoch"]; + /** + * @description Due to clock synchronization, some later log messages may have a + * realtime timestamp before this value. */ + realtime_timestamp_after?: components["schemas"]["sfc-api_UnixEpoch"]; + sort_by?: "seqnum" | "-seqnum"; + limit?: number; + }; + header?: never; + path: { id: string; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Procurement details */ + /** @description Log chunks. */ 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "object": "procurement", - * "id": "proc_xyz123", - * "status": "active", - * "instance_type": "h100i", - * "desired_quantity": 5, - * "buy_limit_price_per_gpu_hour": 250, - * "sell_limit_price_per_gpu_hour": 25, - * "horizon": 60, - * "colocation_strategy": "colocate_pinned", - * "actual_quantity": 5, - * "active_order_count": 2, - * "last_message": "Running" - * } - */ - "application/json": components["schemas"]["market-api_ProcurementResponse"]; + "application/json": components["schemas"]["sfc-api_InstanceLogsResponse"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "authentication_error", - * "message": "missing authentication token" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Forbidden - account frozen */ - 403: { + /** @description Instance not found. */ + 404: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "forbidden", - * "message": "Account is frozen" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Procurement not found */ - 404: { + /** @description Validation failed. */ + 422: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "not_found", - * "message": "Procurement proc_xyz123 not found" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "api_error", - * "message": "An internal server error occurred" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - updateProcurement: { + get_instance_ssh: { parameters: { query?: never; header?: never; path: { - /** - * @description Procurement ID - * @example proc_xyz123 - */ id: string; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["market-api_UpdateProcurementRequest"]; + requestBody?: never; + responses: { + /** @description SSH connection details. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InstanceSshInfo"]; + }; + }; + /** @description Unauthorized. */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; + }; + /** @description SSH details not available. */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Internal server error. */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; + }; + }; + terminate_instance: { + parameters: { + query?: never; + header?: never; + path: { + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successfully updated procurement */ + /** @description Instance terminated. */ 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "object": "procurement", - * "id": "proc_xyz123", - * "status": "disabled", - * "instance_type": "h100i", - * "desired_quantity": 5, - * "buy_limit_price_per_gpu_hour": 400, - * "sell_limit_price_per_gpu_hour": 100, - * "horizon": 120, - * "colocation_strategy": "colocate_pinned", - * "actual_quantity": 3, - * "active_order_count": 1 - * } - */ - "application/json": components["schemas"]["market-api_ProcurementResponse"]; + "application/json": components["schemas"]["sfc-api_InstanceResponse"]; }; }; - /** @description Bad request - invalid field values */ - 400: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "invalid_request_error", - * "message": "desired_quantity must be non-negative" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ - 401: { + /** @description Instance not found or already terminated. */ + 404: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "authentication_error", - * "message": "missing authentication token" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; + }; + }; + /** @description Internal server error. */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; - /** @description Payment required - insufficient funds */ - 402: { + }; + }; + get_order_preview: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_v2.OrderPreviewRequest"]; + }; + }; + responses: { + /** @description Estimate result. */ + 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "payment_required", - * "message": "insufficient funds" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_v2.OrderPreviewResponse"]; }; }; - /** @description Forbidden - account frozen */ - 403: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "forbidden", - * "message": "Account is frozen" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Procurement not found */ - 404: { + /** @description Validation failed. */ + 422: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "not_found", - * "message": "procurement proc_xyz123 not found" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "api_error", - * "message": "An internal server error occurred" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - getAccountMe: { + get_orderbook_depth: { parameters: { - query?: never; + query: { + /** + * @description URL-safe `field[:op]:value` triples joined by `;`. + * @example accelerator:H100 + */ + requirements?: string; + /** + * @description Start of the delivery window. + * @example 1746057600 + */ + start_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** + * @description End of the delivery window. + * @example 1746662400 + */ + end_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** @description Maximum levels returned per side. Clamped to [1, 100]. Default 20. */ + depth?: number; + }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - /** @description Account information retrieved successfully */ + /** @description Market depth. */ 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "id": "gmail-com-name", - * "role": "user", - * "is_frozen": false, - * "kyc": "basic", - * "submitted_waitlist": true, - * "waitlist": false, - * "kycb_form_submitted": false, - * "created_at": "2024-01-15T10:30:00Z" - * } - */ - "application/json": components["schemas"]["market-api_AccountMeResponse"]; + "application/json": components["schemas"]["sfc-api_OrderbookDepthResponse"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; }; - /** @description Account not found */ - 404: { + /** @description Validation failed. */ + 422: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "not_found", - * "message": "account not found", - * "details": [], - * "request_id": "req_550e8400-e29b-41d4-a716-446655440000" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error. */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - getBalance: { + list_orderbook_fills: { parameters: { - query?: never; + query: { + /** + * @description URL-safe `field[:op]:value` triples joined by `;`. + * @example accelerator:H100 + */ + requirements?: string; + /** + * @description Start of the delivery window. + * @example 1746057600 + */ + start_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** + * @description End of the delivery window. + * @example 1746662400 + */ + end_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** + * @description Lower bound on the contract's `created_at` (when the fill was + * recorded). Unix epoch seconds. Defaults to `now - 7d`; clamped to at + * most 90 days before `now` to bound scan cost. + * @example 1745452800 + */ + since_at?: components["schemas"]["sfc-api_UnixEpoch"]; + /** @description Maximum results to return. Clamped to [1, 200]. Default 50. */ + limit?: number; + /** @description Set to the response's `cursor` to fetch the next (older) page. */ + starting_after?: components["schemas"]["sfc-api_OrderbookFillsCursor"]; + }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - /** @description Successfully retrieved balance */ + /** @description Paginated list of fills. */ 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "object": "balance", - * "available_cents": 150000, - * "current_cents": 180000, - * "current_overage_cents": 150000, - * "current_hold_cents": 180000, - * "updated_at": 1640995200 - * } - */ - "application/json": components["schemas"]["market-api_GetBalanceResponse"]; + "application/json": components["schemas"]["sfc-api_ListOrderbookFillsResponse"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; + }; + /** @description Validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error. */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; }; }; }; - migrateAccount: { + get_orderbook_quote: { parameters: { - query?: never; + query: { + /** + * @description URL-safe `field[:op]:value` triples joined by `;`. + * @example accelerator:H100 + */ + requirements?: string; + /** + * @description Start of the delivery window. + * @example 1746057600 + */ + start_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** + * @description End of the delivery window. + * @example 1746662400 + */ + end_at: components["schemas"]["sfc-api_UnixEpoch"]; + }; header?: never; path?: never; cookie?: never; }; - /** @description Migration request specifying the desired migration method */ - requestBody: { - content: { - "application/json": components["schemas"]["market-api_MigrateAccountRequest"]; - }; - }; + requestBody?: never; responses: { - /** @description Account successfully migrated */ + /** @description Market quote. */ 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "status": "migrated" - * } - */ - "application/json": components["schemas"]["market-api_MigrateAccountResponse"]; + "application/json": components["schemas"]["sfc-api_OrderbookQuoteResponse"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; }; - /** @description Account already migrated */ - 409: { + /** @description Validation failed. */ + 422: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "account_already_migrated", - * "message": "Account has already been migrated", - * "details": [], - * "request_id": "req_550e8400-e29b-41d4-a716-446655440000" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "error": { - * "type": "internal_server_error", - * "message": "An internal server error occurred", - * "details": [], - * "request_id": "req_550e8400-e29b-41d4-a716-446655440000" - * } - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - post_calculate_invoice_pricing: { + list_orderbook_windows: { parameters: { - query?: never; + query: { + /** + * @description URL-safe `field[:op]:value` triples joined by `;`. + * @example accelerator:H100 + */ + requirements?: string; + /** + * @description Start of the delivery-window range to browse. Unix epoch seconds, + * minute-aligned. + * @example 1746057600 + */ + range_start_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** + * @description End of the delivery-window range to browse. Unix epoch seconds, + * minute-aligned, must be > `range_start_at`. + * @example 1748649600 + */ + range_end_at: components["schemas"]["sfc-api_UnixEpoch"]; + /** @description Maximum results to return. Clamped to [1, 200]. Default 50. */ + limit?: number; + /** @description Set to the response's `cursor` to fetch the next page. */ + starting_after?: components["schemas"]["sfc-api_OrderbookWindowsCursor"]; + }; header?: never; path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["market-api_CalculateInvoicePricingRequest"]; - }; - }; + requestBody?: never; responses: { - /** @description Invoice pricing recalculated */ + /** @description Active windows in the range. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_CalculateInvoicePricingResponse"]; - }; - }; - /** @description Bad request */ - 400: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_ListOrderbookWindowsResponse"]; }; }; - /** @description Forbidden */ - 403: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Invoice not found */ - 404: { + /** @description Validation failed. */ + 422: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - post_create_draft_invoice: { + list_orders: { parameters: { - query?: never; + query?: { + /** @description Filter by order ID (repeatable). */ + id?: components["schemas"]["sfc-api_OrderId"][]; + /** @description Filter by capacity. */ + capacity?: components["schemas"]["sfc-api_ResourcePathOrId_CapacityId"]; + side?: components["schemas"]["sfc-api_Side"]; + /** @description Filter by status (repeatable). */ + status?: components["schemas"]["sfc-api_OrderStatus"][]; + created_after?: components["schemas"]["sfc-api_UnixEpoch"]; + created_before?: components["schemas"]["sfc-api_UnixEpoch"]; + /** + * @description Filter to one procurement's orders (ID or resource path). + * Without it, the list omits procurement orders. + */ + procurement?: components["schemas"]["sfc-api_ResourcePathOrId_ProcurementId"]; + /** @description Prefix with `-` for descending. */ + sort_by?: components["schemas"]["sfc-api_v2.OrderSortBy"]; + limit?: number; + /** @description Set to the response's `cursor` to fetch the next page. */ + starting_after?: components["schemas"]["sfc-api_OrdersCursor"]; + /** @description Set to the response's `cursor` to fetch the previous page. */ + ending_before?: components["schemas"]["sfc-api_OrdersCursor"]; + }; header?: never; path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["market-api_CreateDraftInvoiceRequest"]; - }; - }; + requestBody?: never; responses: { - /** @description Draft invoice created */ + /** @description Paginated list of orders. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_CreateDraftInvoiceResponse"]; + "application/json": components["schemas"]["sfc-api_v2.ListOrdersResponse"]; }; }; - /** @description Bad request */ - 400: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Forbidden */ - 403: { + /** @description Validation failed. */ + 422: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - post_finalize_invoice: { + create_order: { parameters: { query?: never; - header?: never; + header?: { + /** @description Unique key to ensure idempotent order creation. If provided, duplicate requests with the same key will not place a new order and return the original order. */ + "Idempotency-Key"?: string | null; + }; path?: never; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["market-api_FinalizeInvoiceRequest"]; + "application/json": components["schemas"]["sfc-api_v2.CreateOrderRequest"]; }; }; responses: { - /** @description Invoice finalized */ - 200: { + /** @description Order created. */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_FinalizeInvoiceResponse"]; + "application/json": components["schemas"]["sfc-api_v2.OrderResponse"]; }; }; - /** @description Bad request */ - 400: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Forbidden */ + /** @description Insufficient balance. */ + 402: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_PaymentRequiredError"]; + }; + }; + /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; - /** @description Invoice not found */ + /** @description Not found. */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Internal server error */ + /** @description Validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; + }; + }; + /** @description Service temporarily unavailable. Try again later. */ + 503: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ServiceUnavailableError"]; }; }; }; }; - get_node_ids: { + fetch_order: { parameters: { - query?: { - /** @description Optional provider identifier filter */ - provider_id?: string; - /** @description Include source details (VM or Kubernetes) */ - details?: boolean; - }; + query?: never; header?: never; - path?: never; + path: { + /** + * @description Order ID + * @example ordr_xyz789 + */ + id: components["schemas"]["sfc-api_OrderId"]; + }; cookie?: never; }; requestBody?: never; responses: { - /** @description Node assignment list */ + /** @description Order details. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_NodeIdResponse"]; + "application/json": components["schemas"]["sfc-api_v2.OrderResponse"]; }; }; - /** @description Unauthorized */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Forbidden - not a vendor */ - 403: { + /** @description Order not found. */ + 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - list_provider_orders: { + cancel_order: { parameters: { - query?: { - /** @description Optional provider identifier (admins only) */ - provider_id?: string; - /** @description Inclusive start of the time window (ISO8601, UTC) */ - start_time?: string; - /** @description Exclusive end of the time window (ISO8601, UTC). Defaults to now. */ - end_time?: string; - /** @description Number of orders to return (1-500, default 50) */ - limit?: number; - /** @description Cursor for forward pagination */ - starting_after?: components["schemas"]["market-api_ProviderOrdersCursor"]; - /** @description Cursor for backward pagination */ - ending_before?: components["schemas"]["market-api_ProviderOrdersCursor"]; - }; + query?: never; header?: never; - path?: never; + path: { + /** + * @description Order ID + * @example ordr_xyz789 + */ + id: components["schemas"]["sfc-api_OrderId"]; + }; cookie?: never; }; requestBody?: never; responses: { - /** @description Successfully retrieved provider orders */ - 200: { + /** @description Order cancellation initiated. */ + 204: { headers: { [name: string]: unknown; }; - content: { - /** - * @example { - * "object": "list", - * "data": [ - * { - * "object": "provider_order", - * "cursor": "poc_3kTh9P2mN8xQ7vB1dF5wE", - * "id": "ordr_Y3qN8pL2kX9vB1dF5wE4Z", - * "quantity": "2", - * "tcv": "500.00", - * "executed": true, - * "cancelled": false - * } - * ], - * "summary": { - * "object": "provider_orders_summary", - * "total_revenue_cents": 50000, - * "total_revenue_usd": "500.00", - * "order_count": 1 - * }, - * "has_more": false - * } - */ - "application/json": components["schemas"]["market-api_ProviderOrdersResponse"]; - }; + content?: never; }; - /** @description Invalid request parameters */ - 400: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Unauthorized */ - 401: { + /** @description Order not found. */ + 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Forbidden - not a vendor or admin */ - 403: { + /** @description Order cannot be cancelled. */ + 422: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - getTransactions: { + check_permission_handler: { parameters: { - query?: { - /** @description Number of transactions to return (1-100, default 10) */ - limit?: number; - /** - * @description Filter for transactions after this UNIX timestamp (exclusive) - * @example 1640995200 - */ - after_time?: number; - /** - * @description Filter for transactions before this UNIX timestamp (exclusive) - * @example 1640995200 - */ - before_time?: number; - /** - * @description Cursor for forward pagination - * @example 1640995200 - */ - starting_after_cursor?: components["schemas"]["market-api_GetTransactionsCursor"]; - /** - * @description Cursor for backward pagination - * @example 1640995200 - */ - ending_before_cursor?: components["schemas"]["market-api_GetTransactionsCursor"]; - sort?: "transaction_time" | "-transaction_time" | "amount" | "-amount"; - /** - * @description Filter transactions by type (e.g. `buy_order`) - * @example buy_order - */ - transaction_type?: components["schemas"]["market-api_TransactionTypeFilter"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_CheckPermissionRequest"]; + }; + }; responses: { - /** @description Successfully retrieved transactions */ + /** @description Permission evaluated. */ 200: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "object": "list", - * "data": [ - * { - * "object": "transaction", - * "transaction_time": 1640995200, - * "amount_cents": 25000, - * "details": { - * "object": "transaction_details", - * "type": "credit_grant", - * "memo": "Promotional credit" - * } - * } - * ], - * "has_more": false - * } - */ - "application/json": components["schemas"]["market-api_ListTransactionsResponse"]; + "application/json": components["schemas"]["sfc-api_PermissionCheckResponse"]; }; }; - /** @description Invalid request parameters */ + /** @description Bad request. */ 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - list_capacities_handler: { + list_procurements: { parameters: { - query?: { - /** @description Maximum number of results to return (1–200, default 50). */ + query: { + /** @description Filter by workspace. */ + workspace: components["schemas"]["sfc-api_ResourcePathOrId_WorkspaceId"]; + capacity?: components["schemas"]["sfc-api_ResourcePathOrId_CapacityId"]; limit?: number; - /** @description Cursor for forward pagination (from a previous response's `cursor` field). */ - starting_after?: components["schemas"]["market-api_CapacitiesCursor"]; - /** @description Cursor for backward pagination. */ - ending_before?: components["schemas"]["market-api_CapacitiesCursor"]; - /** @description Include deleted capacities. Defaults to false. */ - include_deleted?: boolean; + starting_after?: components["schemas"]["sfc-api_ProcurementsCursor"]; + ending_before?: components["schemas"]["sfc-api_ProcurementsCursor"]; }; header?: never; path?: never; @@ -8278,36 +13773,45 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Paginated list of capacities */ + /** @description Paginated list of procurements. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ListCapacitiesResponse"]; + "application/json": components["schemas"]["sfc-api_ListProcurementsResponse"]; }; }; - /** @description Unauthorized request */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Internal server error */ + /** @description Validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - create_capacity_handler: { + create_procurement: { parameters: { query?: never; header?: never; @@ -8316,49 +13820,76 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["market-api_CreateCapacityRequest"]; + "application/json": components["schemas"]["sfc-api_CreateProcurementRequest"]; }; }; responses: { - /** @description Capacity created successfully */ + /** @description Procurement created. */ 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_CapacityDetails"]; + "application/json": components["schemas"]["sfc-api_ProcurementResponse"]; }; }; - /** @description Validation failed (e.g., duplicate name or missing node template) */ + /** @description Validation error (e.g. duplicate name). */ 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; - /** @description Unauthorized request */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Internal server error */ + /** @description Forbidden. */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; + }; + }; + /** @description Capacity already has a procurement. */ + 409: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ConflictError"]; + }; + }; + /** @description Validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - get_capacity_handler: { + get_procurement: { parameters: { query?: never; header?: never; @@ -8369,45 +13900,45 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Capacity details */ + /** @description Procurement details. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_CapacityDetails"]; + "application/json": components["schemas"]["sfc-api_ProcurementResponse"]; }; }; - /** @description Unauthorized request */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Capacity not found */ + /** @description Procurement not found. */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - delete_capacity_handler: { + delete_procurement: { parameters: { query?: never; header?: never; @@ -8418,52 +13949,52 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Capacity deleted successfully */ + /** @description Procurement deleted. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; - /** @description Capacity is not empty or has an enabled scheduler */ - 400: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Unauthorized request */ - 401: { + /** @description Forbidden. */ + 403: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; - /** @description Capacity not found */ + /** @description Procurement not found. */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - patch_capacity_handler: { + patch_procurement: { parameters: { query?: never; header?: never; @@ -8474,68 +14005,80 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["market-api_PatchCapacityRequest"]; + "application/json": components["schemas"]["sfc-api_PatchProcurementRequest"]; }; }; responses: { - /** @description Capacity updated successfully */ + /** @description Procurement updated. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_CapacityDetails"]; + "application/json": components["schemas"]["sfc-api_ProcurementResponse"]; }; }; - /** @description Validation failed (e.g., duplicate name or missing node template) */ + /** @description Validation error (e.g. duplicate name). */ 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; - /** @description Unauthorized request */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden. */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; - /** @description Capacity or referenced node template not found */ + /** @description Procurement not found. */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Internal server error */ + /** @description Validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; + }; + }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - list_node_templates_handler: { + list_roles_handler: { parameters: { query?: { - /** @description Maximum number of results to return (1-200, default 50). */ - limit?: number; - /** @description Cursor for forward pagination (from a previous response's `cursor` field). */ - starting_after?: components["schemas"]["market-api_NodeTemplatesCursor"]; - /** @description Cursor for backward pagination. */ - ending_before?: components["schemas"]["market-api_NodeTemplatesCursor"]; - /** @description Include deleted node templates. Defaults to false. */ - include_deleted?: boolean; + /** @description Filter by role ID, resource path, or name (repeatable). */ + id?: components["schemas"]["sfc-api_ResourcePathOrId_RoleId"][]; }; header?: never; path?: never; @@ -8543,36 +14086,54 @@ export interface operations { }; requestBody?: never; responses: { - /** @description List of node templates */ + /** @description List of roles. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ListNodeTemplatesResponse"]; + "application/json": components["schemas"]["sfc-api_ListRolesResponse"]; }; }; - /** @description Unauthorized request */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden. */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; + }; + }; + /** @description Validation error. */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - create_node_template_handler: { + create_role_handler: { parameters: { query?: never; header?: never; @@ -8581,437 +14142,419 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["market-api_CreateNodeTemplateRequest"]; + "application/json": components["schemas"]["sfc-api_CreateRoleRequest"]; }; }; responses: { - /** @description Node template created */ + /** @description Role created. */ 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_NodeTemplateDetails"]; + "application/json": components["schemas"]["sfc-api_RoleResponse"]; }; }; - /** @description Invalid request */ + /** @description Invalid policy. */ 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; - /** @description Unauthorized request */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Internal server error */ + /** @description Forbidden. */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; + }; + }; + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - get_node_template_handler: { + get_role_handler: { parameters: { query?: never; header?: never; path: { + /** @description Role ID, resource path, or name */ id: string; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Node template information */ + /** @description Role details. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_NodeTemplateDetails"]; + "application/json": components["schemas"]["sfc-api_RoleResponse"]; }; }; - /** @description Unauthorized request */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden. */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; - /** @description Node template not found */ + /** @description Role not found. */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - delete_node_template_handler: { + update_role_handler: { parameters: { query?: never; header?: never; path: { + /** @description Role ID, resource path, or name */ id: string; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_UpdateRoleRequest"]; + }; + }; responses: { - /** @description Node template deleted successfully */ - 204: { + /** @description Role updated. */ + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["sfc-api_RoleResponse"]; + }; }; - /** @description Node template cannot be deleted (in use by a capacity) */ + /** @description Invalid policy. */ 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; - /** @description Unauthorized request */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; + }; + }; + /** @description Forbidden. */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; - /** @description Node template not found */ + /** @description Role not found. */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - list_orders: { + delete_role_handler: { parameters: { - query?: { - /** @description Filter by capacity. */ - capacity?: components["schemas"]["market-api_CapacityId"]; - /** @description Filter by status (can be repeated, e.g. `?status=filled&status=cancelled`). */ - status?: components["schemas"]["market-api_v2.OrderStatus"][]; - /** @description Only return orders placed at or after this Unix timestamp (seconds). */ - placed_after?: number; - /** @description Only return orders placed at or before this Unix timestamp (seconds). */ - placed_before?: number; - /** @description Sort field and direction. Prefix with `-` for descending. One of: `placed_at`, `-placed_at`, `start_time`, `-start_time`, `total_price_cents`, `-total_price_cents`. Default: `-placed_at`. */ - sort_by?: string; - /** @description Maximum number of results to return (1–200, default 50). */ - limit?: number; - /** @description Cursor for forward pagination (from a previous response's `cursor` field). */ - starting_after?: components["schemas"]["market-api_OrdersCursor"]; - /** @description Cursor for backward pagination. */ - ending_before?: components["schemas"]["market-api_OrdersCursor"]; - }; + query?: never; header?: never; - path?: never; + path: { + /** @description Role ID, name, or resource path */ + id: string; + }; cookie?: never; }; requestBody?: never; responses: { - /** @description List of orders */ - 200: { + /** @description Role deleted. */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["market-api_v2.ListOrdersResponse"]; - }; + content?: never; }; - /** @description Unauthorized */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Internal server error */ - 500: { + /** @description Forbidden. */ + 403: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; - }; - }; - post_order: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["market-api_v2.CreateOrderRequest"]; - }; - }; - responses: { - /** @description Order created */ - 201: { + /** @description Role not found. */ + 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_v2.OrderResponse"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Invalid request */ - 400: { + /** @description Internal server error. */ + 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; - /** @description Unauthorized */ - 401: { + }; + }; + list_users_handler: { + parameters: { + query?: { + /** @description Filter by user ID or resource path (repeatable). */ + id?: components["schemas"]["sfc-api_ResourcePathOrId_UserId"][]; + limit?: number; + /** @description Set to the response's `cursor` to fetch the next page. */ + starting_after?: components["schemas"]["sfc-api_UsersCursor"]; + /** @description Set to the response's `cursor` to fetch the previous page. */ + ending_before?: components["schemas"]["sfc-api_UsersCursor"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description A paginated list of users. */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_ListUsersResponse"]; }; }; - /** @description Insufficient balance */ - 402: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Forbidden */ + /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; }; }; - /** @description Capacity not found */ - 404: { + /** @description Validation error. */ + 422: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_ErrorObject"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - get_order: { + get_user_handler: { parameters: { query?: never; header?: never; path: { - /** - * @description Order ID - * @example ordr_xyz789 - */ - id: components["schemas"]["market-api_OrderId"]; + /** @description User ID or resource path */ + id: string; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Order details */ + /** @description User details. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_v2.OrderResponse"]; + "application/json": components["schemas"]["sfc-api_UserResponse"]; }; }; - /** @description Unauthorized - missing or invalid authentication token */ + /** @description Unauthorized. */ 401: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "authentication_error", - * "message": "missing authentication token", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Order not found */ + /** @description Forbidden. */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_ForbiddenError"]; + }; + }; + /** @description User not found. */ 404: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "not_found", - * "message": "Order not found", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - /** - * @example { - * "type": "api_error", - * "message": "An internal server error occurred", - * "details": [] - * } - */ - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - cancel_order: { + list_workspaces_handler: { parameters: { - query?: never; - header?: never; - path: { - /** - * @description Order ID - * @example ordr_xyz789 - */ - id: components["schemas"]["market-api_OrderId"]; + query?: { + /** @description Filter by workspace ID, resource path, or name (repeatable). */ + id?: components["schemas"]["sfc-api_ResourcePathOrId_WorkspaceId"][]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - /** @description Order cancellation initiated */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Order cannot be cancelled */ - 400: { + /** @description List of workspaces. */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_ListWorkspacesResponse"]; }; }; - /** @description Order not found */ - 404: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Internal server error */ - 500: { + /** @description Validation error. */ + 422: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["market-api_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - }; - }; - list_batches: { - parameters: { - query: { - /** @description Maximum number of items to return */ - limit: number; - /** @description Pagination offset */ - after: number; - }; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description List of batches */ - 200: { + /** @description Internal server error. */ + 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_Batch"][]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - create_batches: { + create_workspace_handler: { parameters: { query?: never; header?: never; @@ -9020,255 +14563,214 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["large_scale_inference_BatchRequest"]; + "application/json": components["schemas"]["sfc-api_CreateWorkspaceRequest"]; }; }; responses: { - /** @description Batches created */ + /** @description Workspace created. */ 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_Batch"][]; + "application/json": components["schemas"]["sfc-api_WorkspaceResponse"]; }; }; - /** @description Invalid request */ + /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; - /** @description Rate limit exceeded */ - 429: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - get_batch: { + get_workspace_handler: { parameters: { query?: never; header?: never; path: { - /** @description The batch identifier */ - batch_id: string; + /** @description Workspace name or ID */ + workspace: string; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Batch found */ + /** @description Workspace details. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_Batch"]; + "application/json": components["schemas"]["sfc-api_WorkspaceResponse"]; + }; + }; + /** @description Unauthorized. */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - /** @description Batch not found */ + /** @description Workspace not found. */ 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - archive_batch: { + delete_workspace_handler: { parameters: { query?: never; header?: never; path: { - /** @description The batch identifier */ - batch_id: string; + /** @description Workspace name or ID */ + workspace: string; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Batch archived */ + /** @description Workspace deleted. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; - /** @description Batch not found */ - 404: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["large_scale_inference_SerdeErrorProxy"]; - }; - }; - /** @description Internal server error */ - 500: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - }; - }; - cancel_batch: { - parameters: { - query?: never; - header?: never; - path: { - /** @description Batch identifier */ - batch_id: string; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Batch cancelled */ - 200: { + /** @description Workspace not found. */ + 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_Batch"]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - /** @description Batch not found */ - 404: { + /** @description Workspace is not empty. */ + 422: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnprocessableEntityError"]; }; }; - /** @description Internal server error */ + /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; }; }; - retry_batch: { + patch_workspace_handler: { parameters: { query?: never; header?: never; path: { - /** @description The batch identifier */ - batch_id: string; + /** @description Workspace name or ID */ + workspace: string; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["sfc-api_PatchWorkspaceRequest"]; + }; + }; responses: { - /** @description Batch retried */ + /** @description Workspace updated. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_Batch"]; + "application/json": components["schemas"]["sfc-api_WorkspaceResponse"]; }; }; - /** @description Batch not found */ - 404: { + /** @description Invalid request. */ + 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_BadRequestError"]; }; }; - /** @description Internal server error */ - 500: { + /** @description Unauthorized. */ + 401: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_SerdeErrorProxy"]; + "application/json": components["schemas"]["sfc-api_UnauthorizedError"]; }; }; - }; - }; - get_models: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description List available models */ - 200: { + /** @description Workspace not found. */ + 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["large_scale_inference_Model"][]; + "application/json": components["schemas"]["sfc-api_NotFoundError"]; }; }; - }; - }; - get_feature_flag: { - parameters: { - query?: never; - header?: never; - path: { - feature_flag_id: string; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Feature flag status */ - 200: { - headers: { [name: string]: unknown }; - content: { - "application/json": { - enabled: boolean; - }; + /** @description Internal server error. */ + 500: { + headers: { + [name: string]: unknown; }; - }; - /** @description Feature flag not found */ - 404: { - headers: { [name: string]: unknown }; content: { - "application/json": unknown; + "application/json": components["schemas"]["sfc-api_InternalServerError"]; }; }; };