"/_next/static/chunks/16k68yzfto5r4.js"],"DocsDescription"] 69:I[292829,["/_next/static/chunks/33t46atd3n2zd.js","/_next/static/chunks/1yll_-x-eth39.js","/_next/static/chunks/3sfsff08wi9fv.js","/_next/static/chunks/064wjbm9rqm70.js","/_next/static/chunks/051o61eqnpuxf.js","/_next/static/chunks/1brwxob8gx5j0.js","/_next/static/chunks/0bwsarg3aysvv.js","/_next/static/chunks/2a5zgrtdr4f60.js","/_next/static/chunks/342nh_hekgb3n.js","/_next/static/chunks/0djs6l3q97srg.js","/_next/static/chunks/3jdk7veeg23zw.js","/_next/static/chunks/1zliw0b1iuj8m.js","/_next/static/chunks/16k68yzfto5r4.js"],"OpenAPIPage"] 78:I[27201,["/_next/static/chunks/33t46atd3n2zd.js"],"IconMark"] 12:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Create Workspace"] 13:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Workspace"] 14:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"List Workspaces"] 15:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-orange-600 dark:text-orange-400","data-method":"patch","children":"PATCH"}],"Update Workspace"] 16:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Execute Workflow"] 17:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Cancel Execution"] 18:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"List Workflows"] 19:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Workflow"] 1a:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Workflow Status"] 1b:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Workflow Definition"] 1c:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Job Status"] 1d:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Deployment Status"] 1e:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Deploy Workflow"] 1f:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-orange-600 dark:text-orange-400","data-method":"patch","children":"PATCH"}],"Update Deployment Settings"] 20:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-red-600 dark:text-red-400","data-method":"delete","children":"DELETE"}],"Undeploy Workflow"] 21:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"List Deployments"] 22:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Deployment Version"] 23:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-orange-600 dark:text-orange-400","data-method":"patch","children":"PATCH"}],"Update Deployment Version"] 24:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"List Paused Executions"] 25:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Paused Execution"] 26:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Pause Point"] 27:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Resume Execution"] 28:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Execution Details"] 29:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Log Details"] 2a:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Query Logs"] 2b:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Usage Limits"] 2c:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Audit Log Details"] 2d:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"List Audit Logs"] 2e:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Add Column"] 2f:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Claim a Row"] 30:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Create Table"] 31:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-red-600 dark:text-red-400","data-method":"delete","children":"DELETE"}],"Delete Column"] 32:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-red-600 dark:text-red-400","data-method":"delete","children":"DELETE"}],"Delete Row"] 33:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-red-600 dark:text-red-400","data-method":"delete","children":"DELETE"}],"Delete Rows"] 34:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-red-600 dark:text-red-400","data-method":"delete","children":"DELETE"}],"Delete Table"] 35:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Row"] 36:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Table"] 37:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Insert Rows"] 38:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"List Rows"] 39:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"List Tables"] 3a:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-orange-600 dark:text-orange-400","data-method":"patch","children":"PATCH"}],"Update Column"] 3b:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-orange-600 dark:text-orange-400","data-method":"patch","children":"PATCH"}],"Update Row"] 3c:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-yellow-600 dark:text-yellow-400","data-method":"put","children":"PUT"}],"Update Rows"] 3d:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-orange-600 dark:text-orange-400","data-method":"patch","children":"PATCH"}],"Update Table"] 3e:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Upsert Row"] 3f:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Create Doc Folder"] 40:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-red-600 dark:text-red-400","data-method":"delete","children":"DELETE"}],"Delete Doc"] 41:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-red-600 dark:text-red-400","data-method":"delete","children":"DELETE"}],"Delete Doc Folder"] 42:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Download Doc"] 43:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"List Doc Folders"] 44:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"List Docs"] 45:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-orange-600 dark:text-orange-400","data-method":"patch","children":"PATCH"}],"Update Doc"] 46:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-orange-600 dark:text-orange-400","data-method":"patch","children":"PATCH"}],"Update Doc Folder"] 47:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Upload Doc"] 48:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Create Knowledge Base"] 49:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-red-600 dark:text-red-400","data-method":"delete","children":"DELETE"}],"Delete Document"] 4a:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-red-600 dark:text-red-400","data-method":"delete","children":"DELETE"}],"Delete Knowledge Base"] 4b:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Document"] 4c:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Get Knowledge Base"] 4d:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"List Documents"] 4e:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"List Knowledge Bases"] 4f:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Reprocess Document"] 50:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Search Knowledge Base"] 51:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-yellow-600 dark:text-yellow-400","data-method":"put","children":"PUT"}],"Update Knowledge Base"] 52:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-orange-600 dark:text-orange-400","data-method":"patch","children":"PATCH"}],"Update Document"] 53:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Upload Document"] 54:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-blue-600 dark:text-blue-400","data-method":"post","children":"POST"}],"Send Chat Message"] 56:[["$","span",null,{"className":"font-mono font-medium me-1.5 text-[10px] text-nowrap text-green-600 dark:text-green-400","data-method":"get","children":"GET"}],"Discover MCP Servers"] 5a:["$","$L5c",null,{"className":"h-[36px] w-auto"}] 5b:["$","$L2",null,{"parallelRouterKey":"children","error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L3",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":[["$","$L5d",null,{"children":["$","$L5e",null,{"children":["$","div",null,{"className":"flex min-h-[60vh] flex-col items-center justify-center text-center","children":[["$","h1",null,{"className":"mb-4 bg-gradient-to-b from-[#74ceff] to-[#4874ff] bg-clip-text font-bold text-8xl text-transparent","children":"404"}],["$","h2",null,{"className":"mb-2 font-semibold text-2xl text-foreground","children":"Page Not Found"}],["$","p",null,{"className":"text-muted-foreground","children":"The page you're looking for doesn't exist or has been moved."}]]}]}]}],[]],"forbidden":"$undefined","unauthorized":"$undefined"}] 61:Ta09,# Delete Doc Folder `DELETE /api/v1/docs/folders/{folderId}` ## Description Delete a doc folder. As in the app, the folder, every folder inside it, and every doc inside any of them move to Recently Deleted together; non-empty folders are not rejected. ## Parameters - **folderId** (path) (required) — `string`: The folder ID. - **workspaceId** (query) (required) — `string`: The unique identifier of the workspace. ## Responses ### 200 — Folder deleted. ```json { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates whether the request was successful." }, "data": { "type": "object", "properties": { "message": { "type": "string" }, "descendantCount": { "type": "integer", "description": "Number of nested folders deleted with it." } }, "description": "Response payload." } } } ``` ### 400 — Invalid request parameters. Check the details array for specific validation errors. ```json { "type": "object", "properties": { "error": { "type": "string", "description": "Human-readable error message describing the validation failure." }, "details": { "type": "array", "description": "List of specific validation errors with field-level details.", "items": { "type": "object" } } } } ``` ### 401 — Invalid or missing API key. Ensure the X-API-Key header is set with a valid key. ```json { "type": "object", "properties": { "error": { "type": "string", "description": "Human-readable error message." } } } ``` ### 403 — Access denied. You do not have permission to access this resource. For audit log endpoints, this requires an Enterprise subscription and organization admin/owner role. ```json { "type": "object", "properties": { "error": { "type": "string", "description": "Human-readable error message." } } } ``` ### 404 — The requested resource was not found. Verify the ID is correct and belongs to your workspace. ```json { "type": "object", "properties": { "error": { "type": "string", "description": "Human-readable error message." } } } ``` ### 429 — Rate limit exceeded. Wait for the duration specified in the Retry-After header before retrying. ```json { "type": "object", "properties": { "error": { "type": "string", "description": "Human-readable error message with rate limit details." } } } ``` 5:[[["$","script",null,{"type":"application/ld+json","dangerouslySetInnerHTML":{"__html":"{\"@context\":\"https://schema.org\",\"@type\":\"TechArticle\",\"headline\":\"Delete Doc Folder\",\"description\":\"Delete a doc folder. As in the app, the folder, every folder inside it, and every doc inside any of them move to Recently Deleted together; non-empty folders are not rejected.\",\"url\":\"https://docs.steelengine.com/ja/api-reference/docs/deleteDocFolder\",\"author\":{\"@type\":\"Organization\",\"name\":\"SteelEngine Team\",\"url\":\"https://docs.steelengine.com\"},\"publisher\":{\"@type\":\"Organization\",\"name\":\"SteelEngine\",\"url\":\"https://docs.steelengine.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.steelengine.com/static/logo.png\"}},\"mainEntityOfPage\":{\"@type\":\"WebPage\",\"@id\":\"https://docs.steelengine.com/ja/api-reference/docs/deleteDocFolder\"},\"inLanguage\":\"ja\",\"isPartOf\":{\"@type\":\"WebSite\",\"name\":\"SteelEngine Documentation\",\"url\":\"https://docs.steelengine.com\"},\"potentialAction\":{\"@type\":\"ReadAction\",\"target\":\"https://docs.steelengine.com/ja/api-reference/docs/deleteDocFolder\"}}"}}],["$","script",null,{"type":"application/ld+json","dangerouslySetInnerHTML":{"__html":"{\"@context\":\"https://schema.org\",\"@type\":\"BreadcrumbList\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https://docs.steelengine.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Api Reference\",\"item\":\"https://docs.steelengine.com/ja/api-reference\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Docs\",\"item\":\"https://docs.steelengine.com/ja/api-reference/docs\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Delete Doc Folder\",\"item\":\"https://docs.steelengine.com/ja/api-reference/docs/deleteDocFolder\"}]}"}}],false],["$","$L5d",null,{"toc":[],"breadcrumb":{"enabled":false},"tableOfContent":{"style":"clerk","enabled":false},"tableOfContentPopover":{"style":"clerk","enabled":false},"footer":{"enabled":true,"component":["$","div",null,{"className":"mt-12","children":[["$","div",null,{"className":"h-px w-full bg-[rgba(0,0,0,0.08)] dark:bg-[rgba(255,255,255,0.08)]"}],"$undefined",["$","div",null,{"className":"h-px w-full bg-[rgba(0,0,0,0.08)] dark:bg-[rgba(255,255,255,0.08)]"}],["$","div",null,{"className":"flex items-center gap-4 pt-10 pb-6","children":[["$","$L5f","X (Twitter)",{"href":"#","target":"_blank","rel":"noopener noreferrer","aria-label":"X (Twitter)","children":["$","svg",null,{"viewBox":"0 0 24 24","className":"h-5 w-5 fill-gray-400 transition-colors hover:fill-gray-500 dark:fill-gray-500 dark:hover:fill-gray-400","children":["$","path",null,{"d":"M18.244 2.25h3.308l-7.227 8.26 8.502 11.24H16.17l-5.214-6.817L4.99 21.75H1.68l7.73-8.835L1.254 2.25H8.08l4.713 6.231zm-1.161 17.52h1.833L7.084 4.126H5.117z"}]}]}]]}]]}]},"children":[["$","div",null,{"className":"api-page-header relative mt-6 sm:mt-0","children":[["$","div",null,{"className":"absolute top-1 right-0 flex items-center gap-2","children":[["$","div",null,{"className":"hidden sm:flex","children":["$","$L60",null,{"content":"$61"}]}],"$L62"]}],"$L63","$L64"]}],"$L65"]}]] 62:["$","$L66",null,{"previous":"$undefined","next":"$undefined"}] 63:["$","$L67",null,{"className":"mb-2","children":"Delete Doc Folder"}] 64:["$","$L68",null,{"children":"Delete a doc folder. As in the app, the folder, every folder inside it, and every doc inside any of them move to Recently Deleted together; non-empty folders are not rejected."}] 6a:T4de,Send one message to Chat and wait for the complete reply. Chat runs with a workflow as context and can call its tools (edit blocks, read logs, query tables, and so on) on behalf of the API key's user. The request is synchronous: the response arrives once the turn finishes, which can take minutes for multi-step work. Pass the returned `chatId` on the next request to continue the same conversation. For a new chat, if `workflowId` is omitted, Chat uses the workflow named by `workflowName`, or else the user's first workflow. When continuing with `chatId`, Chat keeps that conversation's workflow and history; you do not need to repeat the workflow. An explicit workflow must match the chat's workflow. Chats without an attached workflow cannot be continued through this endpoint. Chat acts with the key owner's full access, so this endpoint needs an unrestricted personal API key with write access to the target workflow, in a workspace that allows personal API keys. Scoped, workspace and organization keys are rejected with `403` for now. Requests count against the same v1 API request limit as the workflows, logs, and audit logs endpoints. `/api/v1/copilot/chat` is a compatibility alias for this endpoint and accepts the same request.65:["$","$L5e",null,{"children":["$","$L69",null,{"payload":{"bundled":{"openapi":"3.2.0","info":{"title":"SteelEngine API","description":"API for executing workflows, querying logs, and managing resources in SteelEngine.","version":"1.0.0","contact":{"name":"SteelEngine Support","email":"support@steelengine.com","url":"https://www.steelengine.com"}},"servers":[{"url":"https://steelengine.com","description":"Production"}],"tags":[{"name":"Workspaces","description":"List, create, and update workspaces"},{"name":"Workflows","description":"Execute workflows and manage workflow resources"},{"name":"Logs","description":"Query execution logs and retrieve details"},{"name":"Usage","description":"Check rate limits and billing usage"},{"name":"Audit Logs","description":"View audit trail of workspace activity"},{"name":"Tables","description":"Manage tables and rows for structured data storage"},{"name":"Docs","description":"Upload, download, and manage workspace docs"},{"name":"Knowledge Bases","description":"Manage knowledge bases, documents, and vector search"},{"name":"Chat","description":"Send messages to Chat from your own code"},{"name":"MCP Servers","description":"Discover the workflow MCP servers an API key can use"}],"security":[{"apiKey":[]}],"paths":{"/api/v1/workspaces":{"get":{"operationId":"listWorkspaces","summary":"List Workspaces","description":"List workspaces the API key holder has access to. Supports pagination and scope filtering (active/archived/all). Returns each workspace with the caller's roleKey and roleKeys.","tags":["Workspaces"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/workspaces?scope=active&limit=50\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"scope","in":"query","required":false,"schema":{"type":"string","enum":["active","archived","all"],"default":"active"},"description":"Filter by archived state."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"minimum":1,"maximum":250},"description":"Page size. Capped at 250."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"minimum":0},"description":"Number of records to skip. Deprecated: use cursor. When both are sent, cursor wins.","deprecated":true},{"name":"cursor","in":"query","required":false,"description":"Pagination cursor returned in a previous response's nextCursor field.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of workspaces the caller has access to.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"workspaces":{"type":"array","items":{"$ref":"#/components/schemas/Workspace"}},"totalCount":{"type":"integer","description":"Total workspaces matching the filter, ignoring limit/offset."},"limit":{"type":"integer"},"offset":{"type":"integer"}}},"nextCursor":{"type":"string","nullable":true,"description":"Cursor for fetching the next page. null when there are no more results."}}},"example":{"success":true,"data":{"workspaces":[{"id":"wsp_abc123","name":"Engineering","slug":"engin3r2","color":"#3972F6","ownerId":"usr_x","organizationId":"org_y","billedAccountUserId":"usr_x","allowPersonalApiKeys":true,"createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:30:00Z","archivedAt":null,"roleKey":"workspace:admin","roleKeys":["workspace:admin"]}],"totalCount":1,"limit":50,"offset":0}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}},"post":{"operationId":"createWorkspace","summary":"Create Workspace","description":"Create a new workspace under the API key holder's organization. Only unscoped personal API keys can create workspaces. Workspace-scoped, scoped, and organization keys receive HTTP 403. A default agent workflow is created unless skipDefaultWorkflow is true.","tags":["Workspaces"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/v1/workspaces\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Engineering\",\n \"color\": \"#3972F6\",\n \"skipDefaultWorkflow\": false\n }'"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"description":"Workspace display name."},"color":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","description":"Optional hex color (#rrggbb). Defaults to a random color."},"skipDefaultWorkflow":{"type":"boolean","default":false,"description":"When true, do NOT create the default agent workflow."}}},"example":{"name":"Engineering","color":"#3972F6","skipDefaultWorkflow":false}}}},"responses":{"200":{"description":"Workspace created.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"workspace":{"$ref":"#/components/schemas/Workspace"}}}}}}}},"400":{"description":"Invalid request body (zod field errors in `details.fieldErrors`)."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"Workspace-scoped, scoped, and organization API keys cannot create workspaces. Use an unscoped personal API key."}}}},"/api/v1/workspaces/{id}":{"get":{"operationId":"getWorkspace","summary":"Get Workspace","description":"Get a workspace's metadata and the caller's roleKey and roleKeys. Returns 404 if the workspace is archived or the caller has no permission on it (the two cases are not distinguished for security).","tags":["Workspaces"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/workspaces/wsp_abc123\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Workspace ID."}],"responses":{"200":{"description":"Workspace metadata.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"workspace":{"$ref":"#/components/schemas/Workspace"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Workspace not found or access denied."}}},"patch":{"operationId":"updateWorkspace","summary":"Update Workspace","description":"Update workspace metadata. **Admin permission required.** Fields not present are left unchanged. Slug is immutable — renaming only changes the display name.","tags":["Workspaces"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X PATCH \\\n \"https://steelengine.com/api/v1/workspaces/wsp_abc123\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Engineering (renamed)\",\n \"color\": \"#FF0000\"\n }'"}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Workspace ID."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"color":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"billedAccountUserId":{"type":"string","description":"New billed account user. Must already be an admin on the workspace."},"allowPersonalApiKeys":{"type":"boolean"}}},"example":{"name":"Engineering (renamed)","color":"#FF0000"}}}},"responses":{"200":{"description":"Workspace updated. The returned workspace carries role: \"admin\" instead of roleKey and roleKeys.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"workspace":{"$ref":"#/components/schemas/Workspace"}}}}}}}},"400":{"description":"Invalid request body or billed account is not a workspace admin."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"Admin permission required to update workspace."},"404":{"description":"Workspace not found."}}}},"/api/workflows/{id}/execute":{"post":{"operationId":"executeWorkflow","summary":"Execute Workflow","description":"Execute a deployed workflow. Synchronous by default: the response is the execution result, or the body authored by the workflow's Response block. Send X-Execution-Mode: async to queue the run and get a jobId to poll, or set stream: true for Server-Sent Events. For API-key and public callers, every top-level body field that is not a control field listed below is passed to the workflow as input.","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/workflows/{id}/execute\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"query\": \"What is the weather in Tokyo?\"\n }'"}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the deployed workflow to execute.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}},{"name":"X-Execution-Mode","in":"header","required":false,"description":"Set to async to queue the execution and return HTTP 202 with a jobId. Async requests that also send useDraftState, selectedOutputs, stopAfterBlockId, includeFileBase64, or base64MaxBytes are rejected with HTTP 400. Async requests count against the async rate-limit bucket reported by Get Usage Limits.","schema":{"type":"string","enum":["async"]}},{"name":"X-Callback-Url","in":"header","required":false,"description":"Async only: send it with X-Execution-Mode: async and X-Callback-Secret. When the run completes, fails, or is cancelled, SteelEngine POSTs the run's Get Job Status body to this URL (see the executionCompleted callback). A run paused for human input does not trigger it; the callback fires when the resumed run finishes. The URL must use HTTPS and resolve to a public address. It is checked when the request arrives and again before every delivery, and redirects are not followed. The request is rejected with HTTP 400 when the URL is not HTTPS, resolves to a private, loopback, or link-local address, is longer than 2048 characters, is sent without X-Callback-Secret, or is sent without X-Execution-Mode: async.","schema":{"type":"string","format":"uri","maxLength":2048}},{"name":"X-Callback-Secret","in":"header","required":false,"description":"Required with X-Callback-Url, 16 to 256 characters. Each delivery is signed with it: steelengine-signature is t=,v1=.\" keyed with this secret>, where is Unix milliseconds. SteelEngine stores the secret encrypted and never logs it. A secret outside the length limits, or one sent without X-Callback-Url, is rejected with HTTP 400.","schema":{"type":"string","minLength":16,"maxLength":256}},{"name":"X-SteelEngine-Stream-Version","in":"header","required":false,"description":"Send 2 with stream: true to receive the current stream format, which ends with a done event carrying the execution result. Without it the stream ends with the legacy final (or error) event.","schema":{"type":"string","enum":["2"]}},{"name":"X-SteelEngine-Deployment-Version","in":"header","required":false,"description":"Pin the execution to one deployment version of the workflow. Public (unauthenticated) callers cannot pin versions and receive HTTP 403.","schema":{"type":"string","maxLength":255}}],"requestBody":{"description":"Workflow input plus optional control fields. Any field not listed here is passed to the workflow as input.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"input":{"description":"Workflow input. You can also send object fields at the top level of the body. The Start block unwraps a top-level input object, so both forms reach the workflow the same way. Send a string, number, boolean, or array as input."},"stream":{"type":"boolean","description":"When true, the response is a Server-Sent Events stream (text/event-stream). Combine with selectedOutputs and X-SteelEngine-Stream-Version: 2."},"selectedOutputs":{"type":"array","items":{"type":"string"},"description":"Block outputs to stream, as blockName.field (for example agent1.content) or blockId_field. Only used with stream: true. An entry that names no existing block or field returns HTTP 400 with code INVALID_SELECTED_OUTPUT."},"useDraftState":{"type":"boolean","description":"Execute the draft (unpublished) workflow state. Rejected with HTTP 400 for API-key callers and ignored for public callers, so REST callers always run the deployed state."},"includeFileBase64":{"type":"boolean","default":true,"description":"Include base64-encoded file content in file outputs."},"base64MaxBytes":{"type":"integer","minimum":1,"description":"Cap on the base64 payload per file, in bytes."},"stopAfterBlockId":{"type":"string","description":"Stop the execution after this block completes. Not accepted with X-Execution-Mode: async."}}},"example":{"query":"What is the weather in Tokyo?"}}}},"responses":{"200":{"description":"Synchronous execution finished successfully, or a stream was opened. The JSON body is the execution result. If the workflow ends in a Response block, the body is what that block authored, with its status code and headers. With stream: true the body is text/event-stream. It carries chunk events ({blockId, chunk, outputId, invocationId}), then a done event with the execution result, then data: [DONE].","headers":{"X-Execution-Id":{"description":"The execution ID.","schema":{"type":"string"}},"X-SteelEngine-Response-Type":{"description":"Which body shape was returned: execution, response (Response block body), async, pending, or stream.","schema":{"type":"string","enum":["execution","response","async","pending","stream"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionResult"},"example":{"success":true,"executionId":"exec_abc123","output":{"content":"The weather in Tokyo is sunny, 22°C."},"metadata":{"startTime":"2026-01-15T10:30:00Z","endTime":"2026-01-15T10:30:01Z","duration":1250}}},"text/event-stream":{"schema":{"type":"string"},"example":"data: {\"blockId\":\"7b7735b9-19e5-4bd6-818b-46aae2596e9f\",\"chunk\":\"One\",\"outputId\":\"7b7735b9-19e5-4bd6-818b-46aae2596e9f_content\",\"invocationId\":\"inv_1\"}\n\ndata: {\"event\":\"done\",\"executionId\":\"exec_abc123\",\"statusUrl\":\"https://steelengine.com/api/jobs/exec_abc123\",\"success\":true,\"status\":\"success\",\"output\":{},\"metadata\":{\"duration\":610}}\n\ndata: [DONE]\n\n"}}},"202":{"description":"Accepted. With X-Execution-Mode: async the body is an async receipt. A synchronous request whose result did not arrive in time returns a pending receipt for the same run. Poll statusUrl instead of resubmitting.","headers":{"X-Execution-Id":{"description":"The execution ID.","schema":{"type":"string"}},"X-SteelEngine-Response-Type":{"description":"Which body shape was returned: execution, response (Response block body), async, pending, or stream.","schema":{"type":"string","enum":["execution","response","async","pending","stream"]}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AsyncExecutionResult"},{"$ref":"#/components/schemas/PendingExecutionResult"}]},"example":{"success":true,"async":true,"jobId":"exec_abc123","executionId":"exec_abc123","message":"Workflow execution queued","statusUrl":"https://steelengine.com/api/jobs/exec_abc123"}}}},"400":{"description":"Invalid request. Schema violations return {error: \"Invalid request body\", details: [{path, message}]}. An async request that carries draft or override controls is rejected. Invalid X-Callback-Url or X-Callback-Secret headers, or a callback on a synchronous request, are rejected. An API-key request that sets useDraftState, isClientSession, or workflowStateOverride is rejected. A selectedOutputs entry that names no block or field returns code INVALID_SELECTED_OUTPUT. A file input that could not be processed is also rejected.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","description":"Present for INVALID_SELECTED_OUTPUT."},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"description":"The billed account has exceeded its usage limit for the current period.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"403":{"description":"Access denied. The key is not authorized for this workspace or workflow. Or the request needs write-level access that the key does not have. Or a public caller tried to pin a deployment version.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Conflict: the request's workflow call chain is invalid, or the workflow's environment promotion binding rejects this execution (body includes code).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string"}}}}}},"429":{"description":"Too many requests. When the caller's plan rate limit is exceeded, the body is {error} with no Retry-After header. Back off and check Get Usage Limits. When the server admission gate is at capacity, the body is {error, message, retryAfterSeconds} with Retry-After: 5.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"retryAfterSeconds":{"type":"integer"}}}}}},"500":{"description":"The execution failed (body has the ExecutionResult shape with success: false and error), or the request failed before execution started (body {error}).","headers":{"X-Execution-Id":{"description":"The execution ID.","schema":{"type":"string"}},"X-SteelEngine-Response-Type":{"description":"Which body shape was returned: execution, response (Response block body), async, pending, or stream.","schema":{"type":"string","enum":["execution","response","async","pending","stream"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionResult"}}}},"503":{"description":"The execution was admitted but its result could not be recovered. Poll statusUrl. Do not resubmit.","headers":{"X-Execution-Id":{"description":"The execution ID.","schema":{"type":"string"}},"X-SteelEngine-Response-Type":{"description":"Which body shape was returned: execution, response (Response block body), async, pending, or stream.","schema":{"type":"string","enum":["execution","response","async","pending","stream"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"code":{"type":"string","example":"RESULT_UNAVAILABLE"},"error":{"type":"string"},"executionId":{"type":"string"},"statusUrl":{"type":"string","format":"uri"}}}}}}},"callbacks":{"executionCompleted":{"{$request.header.X-Callback-Url}":{"post":{"summary":"Execution Completed Callback","description":"Sent to X-Callback-Url once an async run reaches completed, failed, or cancelled. It is not sent for a paused run; it fires when the resumed run finishes. The body is the Get Job Status response for the run, built from run history, so metadata.source is run-history and output is the size-capped copy with secrets removed. success is always true and describes the lookup; read status for the run's outcome. Verify steelengine-signature against the raw request body before trusting the payload. A delivery can arrive more than once, so deduplicate on Idempotency-Key or X-Execution-Id. Each attempt times out after 15 seconds and redirects are not followed. A timeout, network error, 408, 429, or 5xx is retried, up to 6 attempts in total, with exponential backoff starting at 5 seconds and capped at 1 minute. Any other non-2xx response ends delivery without a retry.","parameters":[{"name":"steelengine-signature","in":"header","required":true,"description":"t=,v1=. signature is the hex HMAC-SHA256 of \".\" keyed with X-Callback-Secret.","schema":{"type":"string"},"example":"t=1769251200000,v1=5d41402abc4b2a76b9719d911017c592a1f0c3e5b6d7e8f9a0b1c2d3e4f5a6b7"},{"name":"steelengine-timestamp","in":"header","required":true,"description":"Unix timestamp in milliseconds when this attempt was signed. Same value as t in steelengine-signature. Reject deliveries that are too old to limit replays.","schema":{"type":"string"},"example":"1769251200000"},{"name":"steelengine-event","in":"header","required":true,"description":"Event type. Always workflow.execution.completed.","schema":{"type":"string"},"example":"workflow.execution.completed"},{"name":"steelengine-delivery-id","in":"header","required":true,"description":"callback_. The same on every attempt for one run.","schema":{"type":"string"},"example":"callback_exec_abc123"},{"name":"Idempotency-Key","in":"header","required":true,"description":"Stable across retries of one delivery. Use it to ignore repeats.","schema":{"type":"string"},"example":"temporal-3f2a9c0d8e7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f2e1d0c9b8a7f6e5d4c3b2a1f"},{"name":"X-Execution-Id","in":"header","required":true,"description":"The execution ID of the run, as returned by the execute request.","schema":{"type":"string"},"example":"exec_abc123"}],"requestBody":{"required":true,"description":"The Get Job Status response for the finished run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobStatus"},"examples":{"completed":{"summary":"Completed run","value":{"success":true,"taskId":"exec_abc123","jobId":"exec_abc123","status":"completed","metadata":{"workflowId":"wf_1a2b3c4d5e","workspaceId":"wsp_abc123","executionId":"exec_abc123","source":"run-history"},"output":{"result":"Hello, world!"},"startedAt":"2026-01-15T10:30:00.000Z","completedAt":"2026-01-15T10:30:04.000Z"}},"failed":{"summary":"Failed run","value":{"success":true,"taskId":"exec_abc123","jobId":"exec_abc123","status":"failed","metadata":{"workflowId":"wf_1a2b3c4d5e","workspaceId":"wsp_abc123","executionId":"exec_abc123","source":"run-history"},"output":{"error":"Agent block failed: rate limited"},"error":"Agent block failed: rate limited","startedAt":"2026-01-15T10:30:00.000Z","completedAt":"2026-01-15T10:30:04.000Z"}}}}}},"responses":{"408":{"description":"Retried."},"429":{"description":"Retried."},"2XX":{"description":"Delivered. The body of your response is ignored."},"5XX":{"description":"Retried. A timeout or network error is retried the same way."},"default":{"description":"Any other status, including 3xx, ends delivery without a retry and marks the callback failed."}}}}}}}},"/api/workflows/{id}/executions/{executionId}/cancel":{"post":{"operationId":"cancelExecution","summary":"Cancel Execution","description":"Cancel a running or queued execution. Requires write-level access to the workflow. Scoped and organization keys need a write grant. success is true when the cancellation was durably recorded, aborted an in-process run, or cancelled the durable workflow.","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/workflows/{id}/executions/{executionId}/cancel\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}},{"name":"executionId","in":"path","required":true,"description":"The unique identifier of the execution to cancel.","schema":{"type":"string","example":"exec_9f8e7d6c5b"}}],"responses":{"200":{"description":"Cancellation processed. Check success: false means the request was accepted but no cancellation could be recorded.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the cancellation took effect through at least one mechanism."},"executionId":{"type":"string","description":"The execution that was cancelled."},"redisAvailable":{"type":"boolean","description":"Whether the cancellation store was reachable."},"durablyRecorded":{"type":"boolean","description":"Whether the cancellation was recorded durably."},"locallyAborted":{"type":"boolean","description":"Whether an in-process run on this server was aborted."},"temporalCancelled":{"type":"boolean","description":"Whether the durable workflow was cancelled. Present only when the execution is bound to one."},"reason":{"type":["string","null"],"description":"Why the cancellation was not durably recorded, for example redis_unavailable."}}},"example":{"success":true,"executionId":"exec_abc123","redisAvailable":true,"durablyRecorded":true,"locallyAborted":false,"temporalCancelled":true}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"The caller lacks write access to the workflow, or the key is not authorized for its workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"The execution does not belong to this workflow.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}},"/api/workflows/{id}/deploy":{"get":{"operationId":"getDeploymentStatus","summary":"Get Deployment Status","description":"Return whether the workflow is deployed, when, and whether the saved workflow has changed since. Requires read access; scoped keys need a read grant.","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/workflows/{id}/deploy\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}}],"responses":{"200":{"description":"Deployment status.","content":{"application/json":{"schema":{"type":"object","properties":{"isDeployed":{"type":"boolean","description":"Whether the workflow has an active deployment."},"deployedAt":{"type":["string","null"],"format":"date-time","description":"When the active deployment was created."},"apiKey":{"type":["string","null"],"description":"Which API keys can execute the deployment: `Workspace API keys` or `Personal API keys`. Never a key value."},"needsRedeployment":{"type":"boolean","description":"Whether the saved workflow differs from the active deployment."},"isPublicApi":{"type":"boolean","description":"Whether the deployment can be executed without an API key."}}},"example":{"isDeployed":true,"deployedAt":"2026-10-21T15:04:05.000Z","apiKey":"Workspace API keys","needsRedeployment":false,"isPublicApi":false}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"The key's owner lacks read access to the workflow in its workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}}}}}},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"operationId":"deployWorkflow","summary":"Deploy Workflow","description":"Deploy the workflow's saved state as a new active version. Trigger webhooks, schedules, and MCP tools are synced the same way as the Deploy button. The request has no body. Requires admin access to the workflow's workspace, the same permission the Deploy button needs. The key acts as its owner, so the owner's current workspace role must allow it. A scoped or organization key also needs an admin grant on the workspace or workflow; a key without one is rejected with 401.","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/workflows/{id}/deploy\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}}],"responses":{"200":{"description":"The workflow was deployed.","content":{"application/json":{"schema":{"type":"object","properties":{"isDeployed":{"type":"boolean"},"deployedAt":{"type":"string","format":"date-time"},"apiKey":{"type":["string","null"],"description":"Which API keys can execute the deployment: `Workspace API keys` or `Personal API keys`. Never a key value."},"warnings":{"type":"array","items":{"type":"string"},"description":"Non-fatal problems found while syncing triggers or schedules."}}},"example":{"apiKey":"Workspace API keys","isDeployed":true,"deployedAt":"2026-10-21T15:04:05.000Z","warnings":[]}}}},"400":{"description":"The workflow failed deploy validation, for example an invalid schedule.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"The key's owner lacks admin access to the workflow in its workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}}}}}},"404":{"$ref":"#/components/responses/NotFound"}}},"patch":{"operationId":"updateDeploymentSettings","summary":"Update Deployment Settings","description":"Turn public execution on or off. A public deployment can be executed without an API key. Turning it on returns 403 when public API access is turned off for the SteelEngine instance or for the owner's permission group. Successful updates record a `workflow.public_api_updated` audit event with the actor and previous/new `isPublicApi` values; API-key requests also record the key ID and type. Requires admin access to the workflow's workspace, the same permission the Deploy button needs. The key acts as its owner, so the owner's current workspace role must allow it. A scoped or organization key also needs an admin grant on the workspace or workflow; a key without one is rejected with 401.","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X PATCH \\\n \"https://steelengine.com/api/workflows/{id}/deploy\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"isPublicApi\": false}'"}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["isPublicApi"],"properties":{"isPublicApi":{"type":"boolean","description":"Whether the deployment can be executed without an API key."}}}}}},"responses":{"200":{"description":"The setting was saved.","content":{"application/json":{"schema":{"type":"object","properties":{"isPublicApi":{"type":"boolean"}}},"example":{"isPublicApi":false}}}},"400":{"description":"`isPublicApi` is missing or not a boolean.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"The key's owner lacks admin access to the workflow in its workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}}}}}},"404":{"$ref":"#/components/responses/NotFound"}}},"delete":{"operationId":"undeployWorkflow","summary":"Undeploy Workflow","description":"Remove the active deployment. API execution, schedules, and trigger webhooks stop; deployment versions stay in history. Requires admin access to the workflow's workspace, the same permission the Deploy button needs. The key acts as its owner, so the owner's current workspace role must allow it. A scoped or organization key also needs an admin grant on the workspace or workflow; a key without one is rejected with 401.","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X DELETE \\\n \"https://steelengine.com/api/workflows/{id}/deploy\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}}],"responses":{"200":{"description":"The workflow was undeployed.","content":{"application/json":{"schema":{"type":"object","properties":{"isDeployed":{"type":"boolean","description":"Whether the workflow has an active deployment."},"deployedAt":{"type":["string","null"],"format":"date-time","description":"When the active deployment was created."},"apiKey":{"type":["string","null"],"description":"Which API keys can execute the deployment: `Workspace API keys` or `Personal API keys`. Never a key value."},"needsRedeployment":{"type":"boolean","description":"Whether the saved workflow differs from the active deployment."},"isPublicApi":{"type":"boolean","description":"Whether the deployment can be executed without an API key."}}},"example":{"isDeployed":false,"deployedAt":null,"apiKey":null}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"The key's owner lacks admin access to the workflow in its workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}}}}}},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/workflows/{id}/deployments":{"get":{"operationId":"listDeployments","summary":"List Deployments","description":"List the workflow's deployment versions, newest first. Requires read access; scoped keys need a read grant.","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/workflows/{id}/deployments\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}}],"responses":{"200":{"description":"Deployment versions.","content":{"application/json":{"schema":{"type":"object","properties":{"versions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Deployment version ID."},"version":{"type":"integer","description":"Version number, increasing with each deploy."},"name":{"type":["string","null"],"description":"Optional label for the version."},"description":{"type":["string","null"],"description":"Optional notes for the version."},"isActive":{"type":"boolean","description":"Whether this version is the one that runs."},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":["string","null"],"description":"User ID that created the version."},"deployedBy":{"type":["string","null"],"description":"Display name of the deployer."},"sourceControlObjectId":{"type":["string","null"]},"sourceCommitSha":{"type":["string","null"]},"sourceBranch":{"type":["string","null"]}}}}}},"example":{"versions":[{"id":"dv_7h8i9j","version":3,"name":"Release 3","description":null,"isActive":true,"createdAt":"2026-10-21T15:04:05.000Z","createdBy":"user_123","deployedBy":"Ada Lovelace","sourceControlObjectId":null,"sourceCommitSha":null,"sourceBranch":null}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"The key's owner lacks read access to the workflow in its workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}}}}}},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/workflows/{id}/deployments/{version}":{"get":{"operationId":"getDeploymentVersion","summary":"Get Deployment Version","description":"Return the workflow state captured by one deployment version. Requires read access; scoped keys need a read grant.","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/workflows/{id}/deployments/3\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}},{"name":"version","in":"path","required":true,"description":"The deployment version number, as listed by List Deployments.","schema":{"type":"integer","example":3}}],"responses":{"200":{"description":"The deployed state.","content":{"application/json":{"schema":{"type":"object","properties":{"deployedState":{"type":"object","description":"Blocks, edges, loops, and parallels as deployed."}}}}}},"400":{"description":"`version` is not a number.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"The key's owner lacks read access to the workflow in its workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}}}}}},"404":{"$ref":"#/components/responses/NotFound"}}},"patch":{"operationId":"updateDeploymentVersion","summary":"Update Deployment Version","description":"Rename or describe a deployment version, or make it the active version with `isActive: true`. Activating rolls the deployment back or forward to that version without changing the saved workflow. Editing the name or description needs write access (a write grant for scoped keys). Activating needs admin access (an admin grant for scoped keys).","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X PATCH \\\n \"https://steelengine.com/api/workflows/{id}/deployments/3\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"isActive\": true}'"}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}},{"name":"version","in":"path","required":true,"description":"The deployment version number, as listed by List Deployments.","schema":{"type":"integer","example":3}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"At least one field is required.","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"description":{"type":["string","null"],"maxLength":2000},"isActive":{"type":"boolean","enum":[true],"description":"Send `true` to make this the active version."}}}}}},"responses":{"200":{"description":"Activation returns `success`, `deployedAt`, and `warnings`, plus `name` and `description` when they were also changed. A metadata-only update returns `name` and `description`.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"deployedAt":{"type":"string","format":"date-time"},"warnings":{"type":"array","items":{"type":"string"}},"name":{"type":["string","null"]},"description":{"type":["string","null"]}}},"example":{"success":true,"deployedAt":"2026-10-21T15:04:05.000Z","warnings":[]}}}},"400":{"description":"The body is empty or invalid, or `version` is not a number.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"The key's owner lacks write or admin access to the workflow in its workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}}}}}},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/workflows/{id}/status":{"get":{"operationId":"getWorkflowStatus","summary":"Get Workflow Status","tags":["Workflows"],"description":"Check whether a workflow is deployed and whether its draft has changed since the last deployment. Use it before executing a workflow.","x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/workflows/{id}/status\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}}],"responses":{"200":{"description":"Deployment status of the workflow.","content":{"application/json":{"schema":{"type":"object","properties":{"isDeployed":{"type":"boolean","description":"Whether the workflow has an active deployment."},"deployedAt":{"type":["string","null"],"format":"date-time","description":"When the workflow was last deployed. null when never deployed."},"isPublished":{"type":"boolean","description":"Whether the workflow is published."},"needsRedeployment":{"type":"boolean","description":"True when the draft differs from the deployed version. Always false for undeployed workflows."}}},"example":{"isDeployed":true,"deployedAt":"2026-01-15T10:30:00Z","isPublished":false,"needsRedeployment":false}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"The key is not authorized for this workflow's workspace, or the caller cannot read the workflow.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/workflows/{id}":{"get":{"operationId":"getWorkflowDefinition","summary":"Get Workflow Definition","tags":["Workflows"],"description":"Get a workflow's record together with its current draft graph (blocks, edges, loops, parallels) and variables. For deployment metadata only, use Get Workflow Status. For a summary that includes limits, use the /api/v1/workflows/{id} endpoint.","x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/workflows/{id}\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}}],"responses":{"200":{"description":"The workflow record and its draft graph.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":true,"description":"The workflow record (id, name, description, workspaceId, isDeployed, deployedAt, and other columns) plus the fields below.","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"workspaceId":{"type":"string"},"isDeployed":{"type":"boolean"},"deployedAt":{"type":["string","null"],"format":"date-time"},"state":{"type":"object","description":"The current draft graph.","properties":{"blocks":{"type":"object","additionalProperties":true,"description":"Blocks keyed by block ID."},"edges":{"type":"array","items":{"type":"object","additionalProperties":true}},"loops":{"type":"object","additionalProperties":true},"parallels":{"type":"object","additionalProperties":true},"wireTies":{"type":"array","description":"Layout-only wire ties that route groups of edges through one point. Never read by execution.","items":{"type":"object","additionalProperties":true}},"isDeployed":{"type":"boolean"},"deployedAt":{"type":["string","null"],"format":"date-time"},"lastSaved":{"type":"integer","description":"Unix timestamp in milliseconds of this read."},"metadata":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":["string","null"]}}}}},"variables":{"type":"object","additionalProperties":true,"description":"Workflow variables keyed by variable ID."}}}}},"example":{"data":{"id":"wf_1a2b3c4d5e","name":"Weather assistant","description":"Answers weather questions","workspaceId":"wsp_abc123","isDeployed":true,"deployedAt":"2026-01-15T10:30:00Z","state":{"blocks":{},"edges":[],"loops":{},"parallels":{},"isDeployed":true,"deployedAt":"2026-01-15T10:30:00Z","lastSaved":1768473000000,"metadata":{"name":"Weather assistant","description":"Answers weather questions"}},"variables":{}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"The key is not authorized for this workflow's workspace, or the caller cannot read the workflow.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/workflows":{"get":{"operationId":"listWorkflows","summary":"List Workflows","description":"Retrieve all workflows in a workspace with cursor-based pagination.","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/workflows?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"$ref":"#/components/parameters/WorkspaceId"},{"name":"folderId","in":"query","description":"Filter results to only include workflows within this folder.","schema":{"type":"string"}},{"name":"deployedOnly","in":"query","description":"When true, only return workflows that have been deployed. Useful for listing workflows available for API execution.","schema":{"type":"boolean"}},{"name":"limit","in":"query","description":"Maximum number of workflows to return per page. Must be between 1 and 100.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","description":"Pagination cursor returned from a previous request's nextCursor field. Omit for the first page.","schema":{"type":"string"}}],"responses":{"200":{"description":"A paginated list of workflows.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"Array of workflow summary objects for the current page.","items":{"$ref":"#/components/schemas/WorkflowSummary"}},"nextCursor":{"type":"string","nullable":true,"description":"Cursor for fetching the next page of results. null when there are no more results."},"limits":{"$ref":"#/components/schemas/Limits","description":"Rate limit and usage information for the current API key."}}},"example":{"data":[{"id":"wf_abc123","name":"Weather Bot","isDeployed":true,"createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:30:00Z"}],"nextCursor":null}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/workflows/{id}":{"get":{"operationId":"getWorkflow","summary":"Get Workflow","description":"Retrieve details for a single workflow, including its input fields and deployment status.","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/workflows/{id}\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique workflow identifier.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}}],"responses":{"200":{"description":"Workflow details including input field definitions.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"The full workflow detail object.","$ref":"#/components/schemas/WorkflowDetail"},"limits":{"$ref":"#/components/schemas/Limits","description":"Rate limit and usage information for the current API key."}}},"example":{"data":{"id":"wf_abc123","name":"Weather Bot","description":"A workflow that fetches weather data","isDeployed":true,"createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:30:00Z"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/jobs/{jobId}":{"get":{"operationId":"getJobStatus","summary":"Get Job Status","description":"Poll an execution by its execution ID: the jobId from an async receipt, or the executionId from a pending receipt or an X-Execution-Id header. Statuses are pending, processing, paused, completed, failed, and cancelled. The same API key that started the run can poll it. After the run's execution record expires (7 days after it finishes on SteelEngine Cloud), the status comes from run history: metadata.source is run-history and output is the run-history copy. Once run history is deleted (30 days on SteelEngine Cloud), the lookup returns 404.","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/jobs/{jobId}\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"jobId","in":"path","required":true,"description":"The execution ID (returned as jobId in the async receipt).","schema":{"type":"string","example":"exec_9f8e7d6c5b"}}],"responses":{"200":{"description":"Current status of the execution. output is present once the run has a result.","headers":{"X-Execution-Id":{"description":"The execution ID.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobStatus"},"example":{"success":true,"taskId":"exec_abc123","jobId":"exec_abc123","status":"completed","metadata":{"workflowId":"wf_1a2b3c4d5e","workspaceId":"wsp_abc123","userId":"usr_x","executionId":"exec_abc123","startTime":"2026-01-15T10:30:00Z","endTime":"2026-01-15T10:30:01Z","duration":1250},"output":{"content":"Done"},"startedAt":"2026-01-15T10:30:00Z","completedAt":"2026-01-15T10:30:01Z","executedAt":"2026-01-15T10:30:01Z"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"503":{"description":"The execution result could not be recovered. Retry this status lookup. Do not resubmit the execution.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"code":{"type":"string","example":"RESULT_UNAVAILABLE"},"error":{"type":"string"},"executionId":{"type":"string"},"jobId":{"type":"string"},"taskId":{"type":"string"},"statusUrl":{"type":"string"}}}}}}}}},"/api/v1/logs":{"get":{"operationId":"queryLogs","summary":"Query Logs","description":"List workflow execution logs with advanced filtering and cursor-based pagination. Supports filtering by workflow, trigger type, date range, duration, cost, and more.","tags":["Logs"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/logs?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"$ref":"#/components/parameters/WorkspaceId"},{"name":"workflowIds","in":"query","description":"Comma-separated list of workflow IDs to filter by. Only logs from these workflows will be returned.","schema":{"type":"string"}},{"name":"folderIds","in":"query","description":"Comma-separated list of folder IDs. Returns logs for all workflows within these folders.","schema":{"type":"string"}},{"name":"triggers","in":"query","description":"Comma-separated trigger types to filter by: api, webhook, schedule, manual, chat.","schema":{"type":"string"}},{"name":"level","in":"query","description":"Filter logs by severity level. info for successful executions, error for failed ones.","schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Only return logs after this ISO 8601 timestamp (inclusive).","schema":{"type":"string","format":"date-time"}},{"name":"endDate","in":"query","description":"Only return logs before this ISO 8601 timestamp (inclusive).","schema":{"type":"string","format":"date-time"}},{"name":"executionId","in":"query","description":"Filter by an exact execution ID. Useful for looking up a specific run.","schema":{"type":"string"}},{"name":"minDurationMs","in":"query","description":"Only return logs where execution took at least this many milliseconds.","schema":{"type":"integer"}},{"name":"maxDurationMs","in":"query","description":"Only return logs where execution took at most this many milliseconds.","schema":{"type":"integer"}},{"name":"minCost","in":"query","description":"Only return logs where execution cost at least this amount in USD.","schema":{"type":"number"}},{"name":"maxCost","in":"query","description":"Only return logs where execution cost at most this amount in USD.","schema":{"type":"number"}},{"name":"model","in":"query","description":"Filter by the AI model used during execution (e.g., gpt-4o, claude-sonnet-4-20250514).","schema":{"type":"string"}},{"name":"details","in":"query","description":"Response detail level. basic returns summary fields only. full includes execution data, trace spans, and outputs.","schema":{"type":"string"}},{"name":"includeTraceSpans","in":"query","description":"When true, includes block-level execution trace spans with timing and input/output data.","schema":{"type":"boolean"}},{"name":"includeFinalOutput","in":"query","description":"When true, includes the workflow's final output in each log entry.","schema":{"type":"boolean"}},{"name":"limit","in":"query","description":"Maximum number of log entries to return per page.","schema":{"type":"integer"}},{"name":"cursor","in":"query","description":"Pagination cursor returned from a previous request's nextCursor field.","schema":{"type":"string"}},{"name":"order","in":"query","description":"Sort order by execution start time. desc returns newest first.","schema":{"type":"string"}}],"responses":{"200":{"description":"A paginated list of execution logs matching the filter criteria.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"Array of log entries for the current page.","items":{"$ref":"#/components/schemas/LogEntry"}},"nextCursor":{"type":"string","nullable":true,"description":"Cursor for fetching the next page. null when there are no more results."},"limits":{"$ref":"#/components/schemas/Limits"}}},"example":{"data":[{"id":"log_abc123","workflowId":"wf_abc123","level":"info","trigger":"api","createdAt":"2026-01-15T10:30:00Z"}],"nextCursor":null}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/logs/{id}":{"get":{"operationId":"getLogDetails","summary":"Get Log Details","description":"Retrieve detailed information about a specific log entry, including workflow metadata, execution data, and cost breakdown.","tags":["Logs"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/logs/{id}\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the log entry.","schema":{"type":"string","example":"log_7x8y9z0a1b"}}],"responses":{"200":{"description":"Detailed log entry with full execution data and cost breakdown.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"The full log detail object.","$ref":"#/components/schemas/LogDetail"},"limits":{"$ref":"#/components/schemas/Limits"}}},"example":{"data":{"id":"log_abc123","workflowId":"wf_abc123","executionId":"exec_abc123","level":"info","trigger":"api","totalDurationMs":1250,"startedAt":"2026-01-15T10:30:00Z","endedAt":"2026-01-15T10:30:01Z","createdAt":"2026-01-15T10:30:00Z"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/logs/executions/{executionId}":{"get":{"operationId":"getExecutionDetails","summary":"Get Execution Details","description":"Retrieve the full execution state snapshot, including the workflow state at time of execution and detailed metadata.","tags":["Logs"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/logs/executions/{executionId}\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"executionId","in":"path","required":true,"description":"The unique execution identifier.","schema":{"type":"string","example":"exec_9f8e7d6c5b"}}],"responses":{"200":{"description":"Full execution state snapshot with workflow state and metadata.","content":{"application/json":{"schema":{"type":"object","properties":{"executionId":{"type":"string","description":"The unique identifier for this execution."},"workflowId":{"type":"string","description":"The workflow that was executed."},"workflowState":{"type":"object","description":"Snapshot of the workflow configuration at the time of execution.","properties":{"blocks":{"type":"object","description":"Map of block IDs to their configuration and state during execution."},"edges":{"type":"array","description":"List of connections between blocks defining the execution flow.","items":{"type":"object"}},"loops":{"type":"object","description":"Loop configurations defining iterative execution patterns."},"parallels":{"type":"object","description":"Parallel execution group configurations."}}},"executionMetadata":{"type":"object","description":"Metadata about the execution including timing and cost information.","properties":{"trigger":{"type":"string","description":"How the execution was triggered (e.g., api, manual, schedule)."},"startedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when execution started."},"endedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when execution completed."},"totalDurationMs":{"type":"integer","description":"Total execution duration in milliseconds."},"cost":{"type":"object","description":"Cost breakdown for this execution including per-model details."}}},"limits":{"$ref":"#/components/schemas/Limits"}}},"example":{"executionId":"exec_abc123","workflowId":"wf_abc123","workflowState":{},"executionMetadata":{}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/audit-logs":{"get":{"operationId":"listAuditLogs","summary":"List Audit Logs","description":"Retrieve audit logs for your organization with cursor-based pagination. Requires an Enterprise subscription and organization admin or owner role. Only an unscoped personal API key can call this endpoint. Workspace keys, organization keys, and keys with scope grants receive 403.","tags":["Audit Logs"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/audit-logs?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"action","in":"query","description":"Filter by action type (e.g., workflow.created, workflow.deployed, member.invited).","schema":{"type":"string"}},{"name":"resourceType","in":"query","description":"Filter by resource type (e.g., workflow, workspace, member).","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"Filter by a specific resource ID.","schema":{"type":"string"}},{"name":"workspaceId","in":"query","required":false,"description":"Filter by workspace.","schema":{"type":"string"}},{"name":"organizationId","in":"query","required":false,"description":"Organization to query. Organization keys are bound to their own organization. A different value returns 403.","schema":{"type":"string"}},{"name":"actorId","in":"query","description":"Filter by the user who performed the action. Must be a member of your organization.","schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Only return logs after this ISO 8601 timestamp (inclusive).","schema":{"type":"string","format":"date-time"}},{"name":"endDate","in":"query","description":"Only return logs before this ISO 8601 timestamp (inclusive).","schema":{"type":"string","format":"date-time"}},{"name":"includeDeparted","in":"query","description":"When true, includes audit logs from users who have left the organization.","schema":{"type":"boolean"}},{"name":"limit","in":"query","description":"Maximum number of audit log entries to return per page. Must be between 1 and 100.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","description":"Pagination cursor returned from a previous request's nextCursor field.","schema":{"type":"string"}}],"responses":{"200":{"description":"A paginated list of audit log entries.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"Array of audit log entries for the current page.","items":{"$ref":"#/components/schemas/AuditLogEntry"}},"nextCursor":{"type":"string","nullable":true,"description":"Cursor for fetching the next page. null when there are no more results."},"limits":{"$ref":"#/components/schemas/Limits"}}},"example":{"data":[{"id":"audit_abc123","action":"workflow.execute","actorId":"user_abc123","actorName":"Jane Doe","actorEmail":"jane@example.com","resourceType":"workflow","createdAt":"2026-01-15T10:30:00Z"}],"nextCursor":null}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/audit-logs/{id}":{"get":{"operationId":"getAuditLogDetails","summary":"Get Audit Log Details","description":"Retrieve a single audit log entry by ID. Requires an Enterprise subscription and organization admin or owner role. Only an unscoped personal API key can call this endpoint. Workspace keys, organization keys, and keys with scope grants receive 403.","tags":["Audit Logs"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/audit-logs/{id}\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique audit log entry identifier.","schema":{"type":"string","example":"audit_2c3d4e5f6g"}}],"responses":{"200":{"description":"The audit log entry.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"The audit log entry.","$ref":"#/components/schemas/AuditLogEntry"},"limits":{"$ref":"#/components/schemas/Limits"}}},"example":{"data":{"id":"audit_abc123","action":"workflow.execute","actorId":"user_abc123","actorName":"Jane Doe","actorEmail":"jane@example.com","resourceType":"workflow","resourceId":"wf_abc123","metadata":{},"createdAt":"2026-01-15T10:30:00Z"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/users/me/usage-limits":{"get":{"operationId":"getUsageLimits","summary":"Get Usage Limits","description":"Retrieve the authenticated caller's rate limits, usage spending, and storage consumption for the billing period. Accepts an API key or a signed-in session.","tags":["Usage"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/users/me/usage-limits\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"responses":{"200":{"description":"Current rate limits, usage, and storage information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageLimits"},"example":{"success":true,"rateLimit":{"sync":{"isLimited":false,"requestsPerMinute":60,"maxBurst":10,"remaining":59,"resetAt":"2026-01-15T11:00:00Z"},"async":{"isLimited":false,"requestsPerMinute":200,"maxBurst":20,"remaining":200,"resetAt":"2026-01-15T11:00:00Z"},"authType":"api"},"usage":{"currentPeriodCost":12.5,"limit":100,"plan":"pro"},"storage":{"usedBytes":5242880,"limitBytes":1073741824,"percentUsed":0.49}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}},"parameters":[]}},"/api/v1/tables":{"get":{"operationId":"listTables","summary":"List Tables","description":"List all tables in a workspace. Returns table metadata including name, schema, and row counts.","tags":["Tables"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/tables?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"$ref":"#/components/parameters/WorkspaceId"},{"name":"limit","in":"query","required":false,"description":"Page size (1-100). Omit both limit and cursor to receive every table in one response; when only cursor is sent the page size defaults to 50.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Pagination cursor returned in a previous response's nextCursor field.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of tables in the workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"tables":{"type":"array","items":{"$ref":"#/components/schemas/Table"},"description":"Array of tables in the workspace."},"totalCount":{"type":"integer","description":"Total number of tables."}},"description":"Response payload."},"nextCursor":{"type":"string","nullable":true,"description":"Cursor for fetching the next page. null when there are no more results."},"limits":{"$ref":"#/components/schemas/Limits"}}},"example":{"success":true,"data":{"tables":[{"id":"tbl_abc123","name":"contacts","description":"Customer contacts","schema":{"columns":[{"name":"email","type":"string","required":true,"unique":true}]},"rowCount":150,"maxRows":10000,"createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:30:00Z"}],"totalCount":1}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"operationId":"createTable","summary":"Create Table","description":"Create a new table in a workspace. Define the table schema with typed columns, optional constraints (required, unique), and a name.","tags":["Tables"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/v1/tables\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"workspaceId\": \"YOUR_WORKSPACE_ID\",\n \"name\": \"contacts\",\n \"description\": \"Customer contacts\",\n \"schema\": {\n \"columns\": [\n { \"name\": \"email\", \"type\": \"string\", \"required\": true, \"unique\": true },\n { \"name\": \"name\", \"type\": \"string\", \"required\": true },\n { \"name\": \"age\", \"type\": \"number\" }\n ]\n }\n }'"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","name","schema"],"properties":{"workspaceId":{"type":"string","description":"The workspace to create the table in."},"name":{"type":"string","description":"Table name. Must start with a letter or underscore, alphanumeric and underscores only.","pattern":"^[a-zA-Z_][a-zA-Z0-9_]*$"},"description":{"type":"string","description":"Optional description of the table."},"schema":{"type":"object","required":["columns"],"properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnDefinition"},"minItems":1,"description":"Column definitions for the table."}},"description":"Table schema definition containing column definitions."}}},"example":{"workspaceId":"wsp_abc123","name":"contacts","description":"Customer contacts","schema":{"columns":[{"name":"email","type":"string","required":true,"unique":true},{"name":"name","type":"string","required":true},{"name":"age","type":"number"}]}}}}},"responses":{"200":{"description":"Table created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"table":{"$ref":"#/components/schemas/Table","description":"The newly created table."},"message":{"type":"string","description":"Confirmation message."}},"description":"Response payload."}}},"example":{"success":true,"data":{"table":{"id":"tbl_abc123","name":"contacts","description":"Customer contacts","schema":{"columns":[{"name":"email","type":"string","required":true,"unique":true}]},"rowCount":0,"maxRows":10000,"createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:30:00Z"},"message":"Table created successfully"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"parameters":[]}},"/api/v1/tables/{tableId}":{"patch":{"operationId":"updateTable","summary":"Update Table","description":"Rename a table, move it to another database in the same workspace, or both. Provide at least one of `name` or `databaseId`. Requires write access; a scoped API key needs `update` on the table.","tags":["Tables"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X PATCH \\\n \"https://steelengine.com/api/v1/tables/{tableId}\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"workspaceId\":\"YOUR_WORKSPACE_ID\",\"name\":\"customers_v2\"}'"}],"parameters":[{"$ref":"#/components/parameters/TableId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"name":{"type":"string","minLength":1,"description":"New table name. Must start with a letter or underscore, followed by letters, numbers, or underscores."},"databaseId":{"type":"string","description":"ID of the database to move the table into."}}}}}},"responses":{"200":{"description":"Table updated.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"table":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"databaseId":{"type":"string"}}}},"description":"Response payload."}}},"example":{"success":true,"data":{"table":{"id":"tbl_abc123","name":"customers_v2","databaseId":"db_abc123"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"A table with that name already exists in the target database."},"429":{"$ref":"#/components/responses/RateLimited"}}},"get":{"operationId":"getTable","summary":"Get Table","description":"Retrieve a table's metadata, schema, and row count.","tags":["Tables"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/tables/{tableId}?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"$ref":"#/components/parameters/TableId"},{"$ref":"#/components/parameters/WorkspaceId"}],"responses":{"200":{"description":"Table details.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"table":{"$ref":"#/components/schemas/Table","description":"The requested table with its metadata and schema."}},"description":"Response payload."}}},"example":{"success":true,"data":{"table":{"id":"tbl_abc123","name":"contacts","description":"Customer contacts","schema":{"columns":[{"name":"email","type":"string","required":true,"unique":true}]},"rowCount":150,"maxRows":10000,"createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:30:00Z"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"delete":{"operationId":"deleteTable","summary":"Delete Table","description":"Delete a table and all its rows. This action is irreversible.","tags":["Tables"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X DELETE \\\n \"https://steelengine.com/api/v1/tables/{tableId}?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"$ref":"#/components/parameters/TableId"},{"$ref":"#/components/parameters/WorkspaceId"}],"responses":{"200":{"description":"Table deleted successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"message":{"type":"string","description":"Confirmation message."}},"description":"Response payload."}}},"example":{"success":true,"data":{"message":"Table deleted successfully"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/tables/{tableId}/columns":{"post":{"operationId":"addColumn","summary":"Add Column","description":"Add a new column to the table schema. Optionally specify a position to insert the column at a specific index.","tags":["Tables"],"x-codeSamples":[{"lang":"curl","source":"curl -X POST \\\n \"https://steelengine.com/api/v1/tables/{tableId}/columns\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"workspaceId\": \"YOUR_WORKSPACE_ID\",\n \"column\": {\n \"name\": \"email\",\n \"type\": \"string\",\n \"required\": true,\n \"unique\": true\n }\n }'"}],"parameters":[{"$ref":"#/components/parameters/TableId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","column"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID"},"column":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"Column name (alphanumeric and underscores, must start with letter or underscore)"},"type":{"type":"string","enum":["string","number","boolean","date","json"],"description":"Column data type"},"required":{"type":"boolean","description":"Whether the column requires a value"},"unique":{"type":"boolean","description":"Whether column values must be unique"},"position":{"type":"integer","minimum":0,"description":"Position index to insert the column at (0-based). Appends if omitted."}}}}},"example":{"workspaceId":"wsp_abc123","column":{"name":"phone","type":"string","required":false,"unique":false}}}}},"responses":{"200":{"description":"Column added successfully","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnDefinition"}}}}}},"example":{"success":true,"data":{"columns":[{"name":"email","type":"string","required":true,"unique":true},{"name":"phone","type":"string","required":false,"unique":false}]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"patch":{"operationId":"updateColumn","summary":"Update Column","description":"Update a column's name, type, or constraints. Multiple updates can be applied in a single request. When renaming, subsequent updates (type, constraints) use the new name.","tags":["Tables"],"x-codeSamples":[{"lang":"curl","source":"curl -X PATCH \\\n \"https://steelengine.com/api/v1/tables/{tableId}/columns\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"workspaceId\": \"YOUR_WORKSPACE_ID\",\n \"columnName\": \"old_name\",\n \"updates\": {\n \"name\": \"new_name\",\n \"type\": \"number\"\n }\n }'"}],"parameters":[{"$ref":"#/components/parameters/TableId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","columnName","updates"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID"},"columnName":{"type":"string","description":"Current name of the column to update"},"updates":{"type":"object","properties":{"name":{"type":"string","description":"New column name"},"type":{"type":"string","enum":["string","number","boolean","date","json"],"description":"New column data type"},"required":{"type":"boolean","description":"Whether the column requires a value"},"unique":{"type":"boolean","description":"Whether column values must be unique"}}}}},"example":{"workspaceId":"wsp_abc123","columnName":"phone","updates":{"name":"phone_number","type":"string","required":true}}}}},"responses":{"200":{"description":"Column updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnDefinition"}}}}}},"example":{"success":true,"data":{"columns":[{"name":"email","type":"string","required":true,"unique":true},{"name":"phone_number","type":"string","required":true,"unique":false}]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"delete":{"operationId":"deleteColumn","summary":"Delete Column","description":"Delete a column from the table schema. This removes the column definition and strips the corresponding key from all existing row data. Cannot delete the last remaining column.","tags":["Tables"],"x-codeSamples":[{"lang":"curl","source":"curl -X DELETE \\\n \"https://steelengine.com/api/v1/tables/{tableId}/columns\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"workspaceId\": \"YOUR_WORKSPACE_ID\",\n \"columnName\": \"old_column\"\n }'"}],"parameters":[{"$ref":"#/components/parameters/TableId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","columnName"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID"},"columnName":{"type":"string","description":"Name of the column to delete"}}},"example":{"workspaceId":"wsp_abc123","columnName":"phone_number"}}}},"responses":{"200":{"description":"Column deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnDefinition"}}}}}},"example":{"success":true,"data":{"columns":[{"name":"email","type":"string","required":true,"unique":true}]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/tables/{tableId}/rows":{"get":{"operationId":"listRows","summary":"List Rows","description":"Query rows from a table with optional filtering, sorting, and pagination. Filters and sorts are passed as JSON-encoded query parameters.","tags":["Tables"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/tables/{tableId}/rows?workspaceId=YOUR_WORKSPACE_ID&limit=50&offset=0\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"$ref":"#/components/parameters/TableId"},{"$ref":"#/components/parameters/WorkspaceId"},{"name":"filter","in":"query","required":false,"description":"JSON-encoded filter object. Example: {\"status\": \"active\"} or {\"age\": {\"$gt\": 18}}.","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"JSON-encoded sort object. Example: {\"created_at\": \"desc\"}.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Maximum rows to return (1-1000, default 100).","schema":{"type":"integer","default":100,"minimum":1,"maximum":1000}},{"name":"offset","in":"query","required":false,"description":"Number of rows to skip for pagination (default 0). Deprecated: use cursor. When both are sent, cursor wins.","schema":{"type":"integer","default":0,"minimum":0},"deprecated":true},{"name":"cursor","in":"query","required":false,"description":"Pagination cursor returned in a previous response's nextCursor field.","schema":{"type":"string"}}],"responses":{"200":{"description":"Rows matching the query.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/TableRow"},"description":"Array of rows matching the query."},"rowCount":{"type":"integer","description":"Number of rows returned in this response."},"totalCount":{"type":"integer","description":"Total rows matching the filter."},"limit":{"type":"integer","description":"The limit that was applied to the query."},"offset":{"type":"integer","description":"The offset that was applied to the query."}},"description":"Response payload."},"nextCursor":{"type":"string","nullable":true,"description":"Cursor for fetching the next page. null when there are no more results."}}},"example":{"success":true,"data":{"rows":[{"id":"row_abc123","data":{"email":"jane@example.com","name":"Jane Doe"},"position":0,"createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:30:00Z"}],"rowCount":1,"totalCount":1,"limit":100,"offset":0}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"operationId":"insertRows","summary":"Insert Rows","description":"Insert one or more rows into a table. For a single row, pass a `data` object. For batch insert, pass a `rows` array (up to 1000 rows).","tags":["Tables"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/v1/tables/{tableId}/rows\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"workspaceId\": \"YOUR_WORKSPACE_ID\",\n \"data\": {\n \"email\": \"user@example.com\",\n \"name\": \"Jane Doe\"\n }\n }'"}],"parameters":[{"$ref":"#/components/parameters/TableId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["workspaceId","data"],"description":"Single row insert.","properties":{"workspaceId":{"type":"string","description":"The workspace that owns the table."},"data":{"type":"object","additionalProperties":true,"description":"Key-value pairs matching the table schema."},"position":{"type":"integer","minimum":0,"description":"Position index for the row. If omitted, the row is appended at the end of the table."}}},{"type":"object","required":["workspaceId","rows"],"description":"Batch insert (up to 1000 rows).","properties":{"workspaceId":{"type":"string","description":"The workspace that owns the table."},"rows":{"type":"array","items":{"type":"object","additionalProperties":true},"minItems":1,"maxItems":1000,"description":"Array of row objects to insert. Each object contains key-value pairs matching the table schema."},"positions":{"type":"array","items":{"type":"integer","minimum":0},"uniqueItems":true,"maxItems":1000,"description":"Array of position indices for each row. Must be the same length as the rows array and must not contain duplicates. If omitted, rows are appended in order."}}}]},"example":{"workspaceId":"wsp_abc123","data":{"email":"jane@example.com","name":"Jane Doe","age":30}}}}},"responses":{"200":{"description":"Row(s) inserted successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"row":{"$ref":"#/components/schemas/TableRow","description":"The inserted row (present for single-row inserts)."},"rows":{"type":"array","items":{"$ref":"#/components/schemas/TableRow"},"description":"Array of inserted rows (present for batch inserts)."},"insertedCount":{"type":"integer","description":"Number of rows successfully inserted."},"message":{"type":"string","description":"Confirmation message."}},"description":"Response payload."}}},"example":{"success":true,"data":{"row":{"id":"row_abc123","data":{"email":"jane@example.com","name":"Jane Doe","age":30},"position":0,"createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:30:00Z"},"message":"Row inserted successfully"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"put":{"operationId":"updateRows","summary":"Update Rows","description":"Bulk update rows matching a filter. All matching rows will have the specified fields updated. Validates against schema and unique constraints.","tags":["Tables"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X PUT \\\n \"https://steelengine.com/api/v1/tables/{tableId}/rows\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"workspaceId\": \"YOUR_WORKSPACE_ID\",\n \"filter\": { \"status\": \"pending\" },\n \"data\": { \"status\": \"active\" }\n }'"}],"parameters":[{"$ref":"#/components/parameters/TableId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","filter","data"],"properties":{"workspaceId":{"type":"string","description":"The workspace that owns the table."},"filter":{"type":"object","additionalProperties":true,"description":"Filter criteria to match rows."},"data":{"type":"object","additionalProperties":true,"description":"Fields to update on matching rows."},"limit":{"type":"integer","minimum":1,"maximum":1000,"description":"Maximum number of rows to update."}}},"example":{"workspaceId":"wsp_abc123","filter":{"status":"pending"},"data":{"status":"active"}}}}},"responses":{"200":{"$ref":"#/components/responses/RowsUpdated"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"delete":{"operationId":"deleteRows","summary":"Delete Rows","description":"Delete rows by filter criteria or by an explicit list of row IDs. Pass either a `filter` object or a `rowIds` array.","tags":["Tables"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X DELETE \\\n \"https://steelengine.com/api/v1/tables/{tableId}/rows\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"workspaceId\": \"YOUR_WORKSPACE_ID\",\n \"rowIds\": [\"row_abc123\", \"row_def456\"]\n }'"}],"parameters":[{"$ref":"#/components/parameters/TableId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["workspaceId","filter"],"description":"Delete by filter.","properties":{"workspaceId":{"type":"string","description":"The workspace that owns the table."},"filter":{"type":"object","additionalProperties":true,"description":"Filter criteria to match rows for deletion."},"limit":{"type":"integer","minimum":1,"maximum":1000,"description":"Maximum number of rows to delete. Defaults to all matching rows, capped at 1000."}}},{"type":"object","required":["workspaceId","rowIds"],"description":"Delete by IDs.","properties":{"workspaceId":{"type":"string","description":"The workspace that owns the table."},"rowIds":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Explicit list of row IDs to delete (max 1000)."}}}]},"example":{"workspaceId":"wsp_abc123","rowIds":["row_abc123","row_def456"]}}}},"responses":{"200":{"description":"Rows deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"message":{"type":"string","description":"Confirmation message describing how many rows were deleted."},"deletedCount":{"type":"integer","description":"Number of rows that were deleted."},"deletedRowIds":{"type":"array","items":{"type":"string"},"description":"Array of IDs for each row that was deleted."},"requestedCount":{"type":"integer","description":"Number of row IDs requested for deletion (only present when deleting by IDs)."},"missingRowIds":{"type":"array","items":{"type":"string"},"description":"Row IDs that were requested but not found (only present when deleting by IDs)."}},"description":"Response payload."}}},"example":{"success":true,"data":{"message":"Rows deleted successfully","deletedCount":2,"deletedRowIds":["row_abc123","row_def456"]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/tables/{tableId}/rows/claim":{"post":{"operationId":"claimRow","summary":"Claim a Row","description":"Atomically find one row matching an exact-value filter and update it. Use this endpoint when multiple workers may compete for the same work: only one caller can claim a given row. A successful response with `claim: null` means no matching row was available. At least one filtered field must be changed by `data`.","tags":["Tables"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/v1/tables/{tableId}/rows/claim\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"workspaceId\": \"YOUR_WORKSPACE_ID\",\n \"filter\": { \"status\": \"pending\" },\n \"data\": { \"status\": \"claimed\", \"workerId\": \"worker_123\" }\n }'"}],"parameters":[{"$ref":"#/components/parameters/TableId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["workspaceId","filter","data"],"properties":{"workspaceId":{"type":"string","minLength":1,"description":"The workspace that owns the table."},"filter":{"type":"object","minProperties":1,"maxProperties":16,"additionalProperties":{"type":["string","number","boolean","null"]},"description":"Exact-match criteria used to select one available row. Values must be strings, finite numbers, booleans, or null; nested operators are not accepted."},"data":{"type":"object","minProperties":1,"maxProperties":64,"additionalProperties":true,"description":"Fields written atomically to the claimed row. Must change at least one field also present in `filter`."}}},"example":{"workspaceId":"wsp_abc123","filter":{"status":"pending"},"data":{"status":"claimed","workerId":"worker_123"}}}}},"responses":{"200":{"description":"The row was claimed, or no matching row was available.","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","required":["claim"],"properties":{"claim":{"oneOf":[{"type":"object","required":["id","original","row"],"properties":{"id":{"type":"string","description":"The claimed row ID."},"original":{"$ref":"#/components/schemas/TableRow","description":"The row before the claim update."},"row":{"$ref":"#/components/schemas/TableRow","description":"The row after the claim update."}}},{"type":"null"}]}}}}},"examples":{"claimed":{"summary":"A row was claimed","value":{"success":true,"data":{"claim":{"id":"row_abc123","original":{"id":"row_abc123","data":{"status":"pending"},"position":0,"createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:30:00Z"},"row":{"id":"row_abc123","data":{"status":"claimed","workerId":"worker_123"},"position":0,"createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:31:00Z"}}}}},"unavailable":{"summary":"No matching row was available","value":{"success":true,"data":{"claim":null}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"description":"The JSON request body exceeds 64 KiB.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}},"example":{"error":"Request body exceeds 64 KiB"}}}},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/tables/{tableId}/rows/{rowId}":{"get":{"operationId":"getRow","summary":"Get Row","description":"Retrieve a single row by its ID.","tags":["Tables"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/tables/{tableId}/rows/{rowId}?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"$ref":"#/components/parameters/TableId"},{"$ref":"#/components/parameters/RowId"},{"$ref":"#/components/parameters/WorkspaceId"}],"responses":{"200":{"description":"Row data.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"row":{"$ref":"#/components/schemas/TableRow","description":"The requested row."}},"description":"Response payload."}}},"example":{"success":true,"data":{"row":{"id":"row_abc123","data":{"email":"jane@example.com","name":"Jane Doe"},"position":0,"createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:30:00Z"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"patch":{"operationId":"updateRow","summary":"Update Row","description":"Partially update a single row. Only the provided fields are updated; existing fields are preserved. Data is validated against the table schema.","tags":["Tables"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X PATCH \\\n \"https://steelengine.com/api/v1/tables/{tableId}/rows/{rowId}\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"workspaceId\": \"YOUR_WORKSPACE_ID\",\n \"data\": { \"name\": \"Updated Name\" }\n }'"}],"parameters":[{"$ref":"#/components/parameters/TableId"},{"$ref":"#/components/parameters/RowId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","data"],"properties":{"workspaceId":{"type":"string","description":"The workspace that owns the table."},"data":{"type":"object","additionalProperties":true,"description":"Fields to update. Only specified fields are changed."}}},"example":{"workspaceId":"wsp_abc123","data":{"name":"Updated Name"}}}}},"responses":{"200":{"description":"Row updated.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"row":{"$ref":"#/components/schemas/TableRow","description":"The updated row with all current field values."},"message":{"type":"string","description":"Confirmation message."}},"description":"Response payload."}}},"example":{"success":true,"data":{"row":{"id":"row_abc123","data":{"email":"jane@example.com","name":"Updated Name"},"position":0,"createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-16T08:00:00Z"},"message":"Row updated successfully"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"delete":{"operationId":"deleteRow","summary":"Delete Row","description":"Delete a single row by its ID.","tags":["Tables"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X DELETE \\\n \"https://steelengine.com/api/v1/tables/{tableId}/rows/{rowId}?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"$ref":"#/components/parameters/TableId"},{"$ref":"#/components/parameters/RowId"},{"$ref":"#/components/parameters/WorkspaceId"}],"responses":{"200":{"description":"Row deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"message":{"type":"string","description":"Confirmation message."},"deletedCount":{"type":"integer","description":"Number of rows deleted (always 1 for single-row deletion)."}},"description":"Response payload."}}},"example":{"success":true,"data":{"message":"Row deleted successfully","deletedCount":1}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/tables/{tableId}/rows/upsert":{"post":{"operationId":"upsertRow","summary":"Upsert Row","description":"Insert a new row or update an existing one based on a unique column value. The table must have at least one column with a unique constraint. If a row with a matching unique value exists, it is updated; otherwise, a new row is inserted. When multiple unique columns exist, specify `conflictTarget` to indicate which column to match on.","tags":["Tables"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/v1/tables/{tableId}/rows/upsert\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"workspaceId\": \"YOUR_WORKSPACE_ID\",\n \"data\": { \"email\": \"user@example.com\", \"name\": \"John\" }\n }'"}],"parameters":[{"$ref":"#/components/parameters/TableId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","data"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"data":{"type":"object","additionalProperties":true,"description":"Row data. Must include a value for the conflict target column."},"conflictTarget":{"type":"string","description":"Name of the unique column to match on. Required when the table has multiple unique columns. If the table has exactly one unique column, this can be omitted."}}},"example":{"workspaceId":"wsp_abc123","data":{"email":"user@example.com","name":"John Doe"}}}}},"responses":{"200":{"description":"Row upserted successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"row":{"$ref":"#/components/schemas/TableRow","description":"The inserted or updated row."},"operation":{"type":"string","enum":["insert","update"],"description":"Whether the row was inserted or updated."},"message":{"type":"string","description":"Confirmation message."}},"description":"Response payload."}}},"example":{"success":true,"data":{"row":{"id":"row_abc123","data":{"email":"user@example.com","name":"John Doe"},"createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:30:00Z"},"operation":"insert","message":"Row inserted successfully"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/docs":{"get":{"operationId":"listDocs","summary":"List Docs","description":"List all docs in a workspace.","tags":["Docs"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/docs?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"$ref":"#/components/parameters/WorkspaceId"},{"name":"folderId","in":"query","required":false,"schema":{"type":"string"},"description":"Optional folder id. When provided, list only docs inside that folder. Omit to list across the whole workspace."},{"name":"scope","in":"query","required":false,"schema":{"type":"string","enum":["active","archived","all"]},"description":"Lifecycle scope filter. Defaults to active (live docs only)."},{"name":"limit","in":"query","required":false,"description":"Page size (1-200). Omit both limit and cursor to receive every doc in one response; when only cursor is sent the page size defaults to 100.","schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"cursor","in":"query","required":false,"description":"Pagination cursor returned in a previous response's nextCursor field.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of workspace docs.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request completed successfully."},"data":{"type":"object","properties":{"docs":{"type":"array","items":{"$ref":"#/components/schemas/DocMetadata"},"description":"Array of doc metadata objects in the workspace."},"totalCount":{"type":"integer","description":"Total number of docs."}},"description":"Response payload containing the docs list and count."},"nextCursor":{"type":"string","nullable":true,"description":"Cursor for fetching the next page. null when there are no more results."},"limits":{"$ref":"#/components/schemas/Limits"}}},"example":{"success":true,"data":{"docs":[{"id":"file_abc123","name":"data.csv","size":1024,"type":"text/csv","key":"files/wsp_abc123/data.csv","folderId":null,"uploadedBy":"user_abc123","uploadedAt":"2026-01-15T10:30:00Z"}],"totalCount":1}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"operationId":"uploadDoc","summary":"Upload Doc","description":"Upload a doc to a workspace. Send the doc as multipart/form-data with a `file` field and a `workspaceId` field, plus an optional `folderId`. Maximum doc size is 100MB. Duplicate doc names within a workspace are not allowed.","tags":["Docs"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/v1/docs\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -F \"workspaceId=YOUR_WORKSPACE_ID\" \\\n -F \"file=@/path/to/file.csv\""}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file","workspaceId"],"properties":{"file":{"type":"string","format":"binary","description":"The doc to upload (max 100MB)."},"workspaceId":{"type":"string","description":"The workspace to upload the doc to."},"folderId":{"type":"string","description":"Optional folder id to upload the doc into. The folder must already exist in the same workspace (use POST /api/v1/docs/folders to create one). Omit for an upload at the workspace top level."}}}}}},"responses":{"200":{"description":"Doc uploaded successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the upload completed successfully."},"data":{"type":"object","properties":{"doc":{"$ref":"#/components/schemas/DocMetadata","description":"Metadata of the newly uploaded doc."},"message":{"type":"string","description":"Human-readable confirmation message."}},"description":"Response payload containing the uploaded doc metadata."}}},"example":{"success":true,"data":{"doc":{"id":"file_abc123","name":"data.csv","size":1024,"type":"text/csv","key":"files/wsp_abc123/data.csv","folderId":null,"uploadedBy":"user_abc123","uploadedAt":"2026-01-15T10:30:00Z"},"message":"Doc uploaded successfully"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"description":"A doc with the same name already exists in this workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message indicating a doc with the same name already exists in this workspace."}}}}}},"429":{"$ref":"#/components/responses/RateLimited"}},"parameters":[]}},"/api/v1/docs/{fileId}":{"patch":{"operationId":"updateDoc","summary":"Update Doc","description":"Rename a doc, move it to another folder, or both. Pass `folderId: null` to move the doc to the workspace top level. Provide at least one of `name` or `folderId`.","tags":["Docs"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X PATCH \\\n \"https://steelengine.com/api/v1/docs/{fileId}\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"workspaceId\":\"YOUR_WORKSPACE_ID\",\"name\":\"Q3 report.pdf\",\"folderId\":\"FOLDER_ID\"}'"}],"parameters":[{"name":"fileId","in":"path","required":true,"description":"The doc ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"name":{"type":"string","minLength":1,"description":"New doc name."},"folderId":{"type":["string","null"],"description":"Target folder ID, or `null` for the top level."}}}}}},"responses":{"200":{"description":"Doc updated.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"doc":{"$ref":"#/components/schemas/DocMetadata"}},"description":"Response payload."}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"A doc with that name already exists in the target location (`code: \"duplicate_name\"`)."},"429":{"$ref":"#/components/responses/RateLimited"}}},"get":{"operationId":"downloadDoc","summary":"Download Doc","description":"Download a doc's content. Returns the raw doc bytes with appropriate Content-Type, Content-Disposition, and Content-Length headers. Doc metadata is included in custom response headers: X-Doc-Id, X-Doc-Name, X-Uploaded-At.","tags":["Docs"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/docs/{fileId}?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -o downloaded-file.csv"}],"parameters":[{"name":"fileId","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"type":"string","example":"wf_1709571234_abc1234"}},{"$ref":"#/components/parameters/WorkspaceId"}],"responses":{"200":{"description":"Doc content as binary data.","headers":{"Content-Type":{"description":"MIME type of the doc.","schema":{"type":"string","example":"text/csv"}},"Content-Disposition":{"description":"Attachment with docname.","schema":{"type":"string","example":"attachment; filename=\"data.csv\""}},"Content-Length":{"description":"Doc size in bytes.","schema":{"type":"string","example":"1024"}},"X-File-Id":{"description":"Unique doc identifier.","schema":{"type":"string"}},"X-File-Name":{"description":"Original docname.","schema":{"type":"string"}},"X-Uploaded-At":{"description":"ISO 8601 upload timestamp.","schema":{"type":"string","format":"date-time"}}},"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"delete":{"operationId":"deleteDoc","summary":"Delete Doc","description":"Archive a doc. The doc leaves the default list and is returned by List Docs with `scope=archived` or `scope=all`.","tags":["Docs"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X DELETE \\\n \"https://steelengine.com/api/v1/docs/{fileId}?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"fileId","in":"path","required":true,"description":"The unique identifier of the doc to delete.","schema":{"type":"string","example":"wf_1709571234_abc1234"}},{"$ref":"#/components/parameters/WorkspaceId"}],"responses":{"200":{"description":"Doc archived.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the deletion completed successfully."},"data":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable confirmation message."}},"description":"Response payload containing the deletion confirmation."}}},"example":{"success":true,"data":{"message":"File archived successfully"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/knowledge":{"get":{"operationId":"listKnowledgeBases","summary":"List Knowledge Bases","description":"List all knowledge bases in a workspace.","tags":["Knowledge Bases"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/knowledge?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"$ref":"#/components/parameters/WorkspaceId"},{"name":"limit","in":"query","required":false,"description":"Page size (1-100). Omit both limit and cursor to receive every knowledge base in one response; when only cursor is sent the page size defaults to 50.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Pagination cursor returned in a previous response's nextCursor field.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of knowledge bases in the workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was successful."},"data":{"type":"object","properties":{"knowledgeBases":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeBase"},"description":"Array of knowledge base objects in the workspace."},"totalCount":{"type":"integer","description":"Total number of knowledge bases."}},"description":"Response payload containing the list of knowledge bases."},"nextCursor":{"type":"string","nullable":true,"description":"Cursor for fetching the next page. null when there are no more results."},"limits":{"$ref":"#/components/schemas/Limits"}}},"example":{"success":true,"data":{"knowledgeBases":[{"id":"kb_abc123","name":"Product Docs","description":"Product documentation and FAQs","docCount":5,"tokenCount":25000,"embeddingModel":"text-embedding-3-small","createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:30:00Z"}],"totalCount":1}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"operationId":"createKnowledgeBase","summary":"Create Knowledge Base","description":"Create a new knowledge base in a workspace. Optionally configure chunking parameters for document processing.","tags":["Knowledge Bases"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/v1/knowledge\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"workspaceId\": \"YOUR_WORKSPACE_ID\",\n \"name\": \"Product Documentation\",\n \"description\": \"Internal product docs for search\",\n \"chunkingConfig\": {\n \"maxSize\": 1024,\n \"minSize\": 100,\n \"overlap\": 200\n }\n }'"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","name"],"properties":{"workspaceId":{"type":"string","description":"The workspace to create the knowledge base in."},"name":{"type":"string","description":"Knowledge base name (1-255 characters).","maxLength":255},"description":{"type":"string","description":"Optional description (max 1000 characters).","maxLength":1000},"chunkingConfig":{"$ref":"#/components/schemas/ChunkingConfig","description":"Optional chunking configuration for document processing. Defaults to maxSize=1024, minSize=100, overlap=200 if omitted."}}},"example":{"workspaceId":"wsp_abc123","name":"Product Docs","description":"Product documentation and FAQs"}}}},"responses":{"200":{"description":"Knowledge base created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was successful."},"data":{"type":"object","properties":{"knowledgeBase":{"$ref":"#/components/schemas/KnowledgeBase","description":"The newly created knowledge base object."},"message":{"type":"string","description":"Human-readable confirmation message."}},"description":"Response payload containing the created knowledge base."}}},"example":{"success":true,"data":{"knowledgeBase":{"id":"kb_abc123","name":"Product Docs","description":"Product documentation and FAQs","docCount":0,"tokenCount":0,"embeddingModel":"text-embedding-3-small","createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:30:00Z"},"message":"Knowledge base created successfully"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"parameters":[]}},"/api/v1/knowledge/{id}":{"get":{"operationId":"getKnowledgeBase","summary":"Get Knowledge Base","description":"Get details of a specific knowledge base.","tags":["Knowledge Bases"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/knowledge/KB_ID?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"Knowledge base ID.","schema":{"type":"string"}},{"$ref":"#/components/parameters/WorkspaceId"}],"responses":{"200":{"description":"Knowledge base details.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was successful."},"data":{"type":"object","properties":{"knowledgeBase":{"$ref":"#/components/schemas/KnowledgeBase","description":"The knowledge base object."}},"description":"Response payload containing the knowledge base details."}}},"example":{"success":true,"data":{"knowledgeBase":{"id":"kb_abc123","name":"Product Docs","description":"Product documentation and FAQs","docCount":5,"tokenCount":25000,"embeddingModel":"text-embedding-3-small","createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-15T10:30:00Z"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"put":{"operationId":"updateKnowledgeBase","summary":"Update Knowledge Base","description":"Update a knowledge base's name, description, or chunking configuration. At least one field must be provided.","tags":["Knowledge Bases"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X PUT \\\n \"https://steelengine.com/api/v1/knowledge/KB_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"workspaceId\": \"YOUR_WORKSPACE_ID\",\n \"name\": \"Updated Name\"\n }'"}],"parameters":[{"name":"id","in":"path","required":true,"description":"Knowledge base ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"workspaceId":{"type":"string","description":"The workspace the knowledge base belongs to."},"name":{"type":"string","description":"New name (1-255 characters).","maxLength":255},"description":{"type":"string","description":"New description (max 1000 characters).","maxLength":1000},"chunkingConfig":{"$ref":"#/components/schemas/ChunkingConfig","description":"Updated chunking configuration. All three fields (maxSize, minSize, overlap) must be provided if included."}}},"example":{"workspaceId":"wsp_abc123","name":"Updated Product Docs","description":"Updated product documentation"}}}},"responses":{"200":{"description":"Knowledge base updated successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was successful."},"data":{"type":"object","properties":{"knowledgeBase":{"$ref":"#/components/schemas/KnowledgeBase","description":"The updated knowledge base object."},"message":{"type":"string","description":"Human-readable confirmation message."}},"description":"Response payload containing the updated knowledge base."}}},"example":{"success":true,"data":{"knowledgeBase":{"id":"kb_abc123","name":"Updated Product Docs","description":"Updated product documentation","docCount":5,"tokenCount":25000,"embeddingModel":"text-embedding-3-small","createdAt":"2026-01-15T10:30:00Z","updatedAt":"2026-01-16T08:00:00Z"},"message":"Knowledge base updated successfully"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"delete":{"operationId":"deleteKnowledgeBase","summary":"Delete Knowledge Base","description":"Soft-delete a knowledge base and all its documents.","tags":["Knowledge Bases"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X DELETE \\\n \"https://steelengine.com/api/v1/knowledge/KB_ID?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"Knowledge base ID.","schema":{"type":"string"}},{"$ref":"#/components/parameters/WorkspaceId"}],"responses":{"200":{"description":"Knowledge base deleted successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was successful."},"data":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable confirmation message."}},"description":"Response payload."}}},"example":{"success":true,"data":{"message":"Knowledge base deleted successfully"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/knowledge/{id}/documents":{"get":{"operationId":"listDocuments","summary":"List Documents","description":"List documents in a knowledge base with pagination, filtering, and sorting.","tags":["Knowledge Bases"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/knowledge/KB_ID/documents?workspaceId=YOUR_WORKSPACE_ID&limit=50&offset=0\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"Knowledge base ID.","schema":{"type":"string"}},{"$ref":"#/components/parameters/WorkspaceId"},{"name":"limit","in":"query","description":"Maximum number of documents to return (1-100, default 50).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"offset","in":"query","description":"Number of documents to skip (default 0). Deprecated: use cursor. When both are sent, cursor wins.","schema":{"type":"integer","minimum":0,"default":0},"deprecated":true},{"name":"cursor","in":"query","required":false,"description":"Pagination cursor returned in a previous response's nextCursor field.","schema":{"type":"string"}},{"name":"search","in":"query","description":"Search documents by filename.","schema":{"type":"string"}},{"name":"enabledFilter","in":"query","description":"Filter by enabled status.","schema":{"type":"string","enum":["all","enabled","disabled"],"default":"all"}},{"name":"sortBy","in":"query","description":"Field to sort by.","schema":{"type":"string","enum":["filename","fileSize","tokenCount","chunkCount","uploadedAt","processingStatus","enabled"],"default":"uploadedAt"}},{"name":"sortOrder","in":"query","description":"Sort direction.","schema":{"type":"string","enum":["asc","desc"],"default":"desc"}}],"responses":{"200":{"description":"List of documents.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was successful."},"data":{"type":"object","properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeDocument"},"description":"Array of document objects in the knowledge base."},"pagination":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"example":0,"description":"Total number of documents matching the query before pagination. Returned as a JSON number, including 0 when no documents match."},"limit":{"type":"integer","description":"Maximum number of documents returned per page."},"offset":{"type":"integer","description":"Number of documents skipped from the beginning."},"hasMore":{"type":"boolean","description":"Whether there are more documents beyond the current page."}},"description":"Pagination metadata for the document list."}},"description":"Response payload containing the documents and pagination info."},"nextCursor":{"type":"string","nullable":true,"description":"Cursor for fetching the next page. null when there are no more results."},"limits":{"$ref":"#/components/schemas/Limits"}}},"example":{"success":true,"data":{"documents":[{"id":"doc_abc123","knowledgeBaseId":"kb_abc123","filename":"Getting Started.pdf","fileSize":204800,"mimeType":"application/pdf","processingStatus":"completed","chunkCount":12,"tokenCount":3500,"enabled":true,"createdAt":"2026-01-15T10:30:00Z"}],"pagination":{"total":1,"limit":50,"offset":0,"hasMore":false}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"operationId":"uploadDocument","summary":"Upload Document","description":"Upload a document to a knowledge base. The document will be processed asynchronously (chunked and embedded). Files must contain at least one byte and cannot exceed 100MB. Zero-byte files return HTTP 400 with error 'File cannot be empty' before storage or document processing begins.","tags":["Knowledge Bases"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/v1/knowledge/KB_ID/documents\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -F \"workspaceId=YOUR_WORKSPACE_ID\" \\\n -F \"file=@/path/to/document.pdf\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"Knowledge base ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file","workspaceId"],"properties":{"file":{"type":"string","format":"binary","description":"The document file to upload (at least one byte, max 100MB)."},"workspaceId":{"type":"string","description":"The workspace the knowledge base belongs to."}}}}}},"responses":{"200":{"description":"Document uploaded successfully. Processing will begin shortly.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was successful."},"data":{"type":"object","properties":{"document":{"$ref":"#/components/schemas/KnowledgeDocument","description":"The newly created document object with initial processing status of 'pending'."},"message":{"type":"string","description":"Human-readable confirmation message."}},"description":"Response payload containing the uploaded document."}}},"example":{"success":true,"data":{"document":{"id":"doc_abc123","knowledgeBaseId":"kb_abc123","filename":"Getting Started.pdf","fileSize":204800,"mimeType":"application/pdf","processingStatus":"pending","chunkCount":0,"tokenCount":0,"enabled":true,"createdAt":"2026-01-15T10:30:00Z"},"message":"Document uploaded successfully. Processing will begin shortly."}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"A file with the same name already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message indicating a file with the same name already exists."}}}}}},"413":{"description":"Storage limit exceeded for the workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message indicating the workspace storage limit has been exceeded."}}}}}},"415":{"description":"Unsupported file type. See error message for supported types.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message indicating the file type is not supported."}}}}}},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/knowledge/{id}/documents/{documentId}":{"patch":{"operationId":"updateKnowledgeDocument","summary":"Update Document","description":"Rename a document or enable/disable it. Disabled documents stay in the knowledge base but are left out of search results.","tags":["Knowledge Bases"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X PATCH \\\n \"https://steelengine.com/api/v1/knowledge/{id}/documents/{documentId}\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"workspaceId\":\"YOUR_WORKSPACE_ID\",\"enabled\":false}'"}],"parameters":[{"name":"id","in":"path","required":true,"description":"Knowledge base ID.","schema":{"type":"string"}},{"name":"documentId","in":"path","required":true,"description":"Document ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"filename":{"type":"string","minLength":1,"description":"New display filename."},"enabled":{"type":"boolean","description":"Whether the document is included in search."}}}}}},"responses":{"200":{"description":"Document updated.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"document":{"$ref":"#/components/schemas/KnowledgeDocumentDetail"}},"description":"Response payload."}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"get":{"operationId":"getDocument","summary":"Get Document","description":"Get details of a specific document in a knowledge base.","tags":["Knowledge Bases"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/knowledge/KB_ID/documents/DOC_ID?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"Knowledge base ID.","schema":{"type":"string"}},{"name":"documentId","in":"path","required":true,"description":"Document ID.","schema":{"type":"string"}},{"$ref":"#/components/parameters/WorkspaceId"}],"responses":{"200":{"description":"Document details.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was successful."},"data":{"type":"object","properties":{"document":{"$ref":"#/components/schemas/KnowledgeDocumentDetail","description":"Detailed document object including processing and connector information."}},"description":"Response payload containing the document details."}}},"example":{"success":true,"data":{"document":{"id":"doc_abc123","knowledgeBaseId":"kb_abc123","filename":"Getting Started.pdf","fileSize":204800,"mimeType":"application/pdf","processingStatus":"completed","chunkCount":12,"tokenCount":3500,"characterCount":18000,"enabled":true,"createdAt":"2026-01-15T10:30:00Z"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"delete":{"operationId":"deleteDocument","summary":"Delete Document","description":"Soft-delete a document from a knowledge base. For connector-sourced documents, this also prevents re-import on future syncs.","tags":["Knowledge Bases"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X DELETE \\\n \"https://steelengine.com/api/v1/knowledge/KB_ID/documents/DOC_ID?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"Knowledge base ID.","schema":{"type":"string"}},{"name":"documentId","in":"path","required":true,"description":"Document ID.","schema":{"type":"string"}},{"$ref":"#/components/parameters/WorkspaceId"}],"responses":{"200":{"description":"Document deleted successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was successful."},"data":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable confirmation message."}},"description":"Response payload."}}},"example":{"success":true,"data":{"message":"Document deleted successfully"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/knowledge/search":{"post":{"operationId":"searchKnowledgeBase","summary":"Search Knowledge Base","description":"Perform vector similarity search across one or more knowledge bases. Supports semantic search via query text, tag-based filtering, or a combination of both.","tags":["Knowledge Bases"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/v1/knowledge/search\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"workspaceId\": \"YOUR_WORKSPACE_ID\",\n \"knowledgeBaseIds\": [\"KB_ID\"],\n \"query\": \"How do I reset my password?\",\n \"topK\": 5\n }'"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","knowledgeBaseIds"],"properties":{"workspaceId":{"type":"string","description":"The workspace containing the knowledge bases."},"knowledgeBaseIds":{"oneOf":[{"type":"string","description":"A single knowledge base ID."},{"type":"array","items":{"type":"string"},"description":"An array of knowledge base IDs to search across."}],"description":"Array of knowledge base IDs to search across."},"query":{"type":"string","description":"Search query text for semantic similarity search. Either query or tagFilters must be provided."},"topK":{"type":"integer","minimum":1,"maximum":100,"default":10,"description":"Maximum number of results to return."},"tagFilters":{"type":"array","description":"Tag-based filters. Either query or tagFilters must be provided.","items":{"$ref":"#/components/schemas/TagFilter"}}}},"example":{"workspaceId":"wsp_abc123","knowledgeBaseIds":["kb_abc123"],"query":"How do I reset my password?","topK":5}}}},"responses":{"200":{"description":"Search results.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was successful."},"data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"},"description":"Array of search result objects ranked by similarity."},"query":{"type":"string","description":"The search query used."},"knowledgeBaseIds":{"type":"array","items":{"type":"string"},"description":"Knowledge base IDs that were searched."},"topK":{"type":"integer","description":"Maximum results requested."},"totalResults":{"type":"integer","description":"Number of results returned."}},"description":"Response payload containing the search results and metadata."}}},"example":{"success":true,"data":{"results":[{"documentId":"doc_abc123","documentName":"Getting Started.pdf","content":"To reset your password, go to Settings > Security.","chunkIndex":3,"similarity":0.95,"metadata":{}}],"query":"How do I reset my password?","knowledgeBaseIds":["kb_abc123"],"topK":5,"totalResults":1}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"parameters":[]}},"/api/v1/docs/folders/{folderId}":{"patch":{"operationId":"updateDocFolder","summary":"Update Doc Folder","description":"Rename a doc folder, move it under another folder, or both. Pass `parentId: null` to move it to the top level. A folder cannot be moved into itself or one of its descendants.","tags":["Docs"],"security":[{"ApiKeyAuth":[]}],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X PATCH \\\n \"https://steelengine.com/api/v1/docs/folders/{folderId}\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"workspaceId\":\"YOUR_WORKSPACE_ID\",\"name\":\"Archive\"}'"}],"parameters":[{"name":"folderId","in":"path","required":true,"description":"The folder ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"name":{"type":"string","minLength":1,"maxLength":200,"description":"New folder name."},"parentId":{"type":["string","null"],"description":"New parent folder ID, or `null` for the top level."}}}}}},"responses":{"200":{"description":"Folder updated.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"folder":{"$ref":"#/components/schemas/WorkspaceFolder"}},"description":"Response payload."}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"A sibling folder already has that name (`code: \"duplicate_name\"`)."},"429":{"$ref":"#/components/responses/RateLimited"}}},"delete":{"operationId":"deleteDocFolder","summary":"Delete Doc Folder","description":"Delete a doc folder. As in the app, the folder, every folder inside it, and every doc inside any of them move to Recently Deleted together; non-empty folders are not rejected.","tags":["Docs"],"security":[{"ApiKeyAuth":[]}],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X DELETE \\\n \"https://steelengine.com/api/v1/docs/folders/{folderId}?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"folderId","in":"path","required":true,"description":"The folder ID.","schema":{"type":"string"}},{"$ref":"#/components/parameters/WorkspaceId"}],"responses":{"200":{"description":"Folder deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"message":{"type":"string"},"descendantCount":{"type":"integer","description":"Number of nested folders deleted with it."}},"description":"Response payload."}}},"example":{"success":true,"data":{"message":"Folder deleted successfully","descendantCount":2}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/knowledge/{id}/documents/{documentId}/reprocess":{"post":{"operationId":"reprocessKnowledgeDocument","summary":"Reprocess Document","description":"Retry processing for a document whose processing failed. Existing chunks are cleared and processing restarts in the background; poll Get Document for the new status. Only documents with `processingStatus: \"failed\"` can be reprocessed.","tags":["Knowledge Bases"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/v1/knowledge/{id}/documents/{documentId}/reprocess\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"workspaceId\":\"YOUR_WORKSPACE_ID\"}'"}],"parameters":[{"name":"id","in":"path","required":true,"description":"Knowledge base ID.","schema":{"type":"string"}},{"name":"documentId","in":"path","required":true,"description":"Document ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."}}}}}},"responses":{"202":{"description":"Processing restarted.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"documentId":{"type":"string"},"processingStatus":{"type":"string"},"message":{"type":"string"}},"description":"Response payload."}}},"example":{"success":true,"data":{"documentId":"doc_abc123","processingStatus":"pending","message":"Document retry processing started"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"The document is not in the `failed` state."},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/docs/folders":{"get":{"operationId":"listDocFolders","summary":"List Doc Folders","description":"List all active folders used to organize workspace docs. Folders are returned as a flat list with parentId references; clients reconstruct the tree as needed.","tags":["Docs"],"parameters":[{"$ref":"#/components/parameters/WorkspaceId"},{"name":"limit","in":"query","required":false,"description":"Page size (1-200). Omit both limit and cursor to receive every folder in one response; when only cursor is sent the page size defaults to 100.","schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"cursor","in":"query","required":false,"description":"Pagination cursor returned in a previous response's nextCursor field.","schema":{"type":"string"}}],"security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Folders listed successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{"folders":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceFolder"}},"totalCount":{"type":"integer"}},"required":["folders","totalCount"]},"nextCursor":{"type":"string","nullable":true,"description":"Cursor for fetching the next page. null when there are no more results."},"limits":{"$ref":"#/components/schemas/Limits"}},"required":["success","data"]}}}},"400":{"description":"workspaceId missing or invalid."},"403":{"description":"Caller lacks workspace permission."},"500":{"description":"Internal error."}},"x-codeSamples":[{"lang":"curl","label":"curl","source":"curl -X GET \\\n \"https://steelengine.com/api/v1/docs/folders?workspaceId=YOUR_WORKSPACE_ID\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}]},"post":{"operationId":"createDocFolder","summary":"Create Doc Folder","description":"Create a folder for organizing workspace docs. Pass `parentId` to nest the new folder under an existing one, or omit (or null) to create at the top level. Auto-suffixes the name on sibling collisions up to 100 attempts; beyond that returns 409.","tags":["Docs"],"security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","name"],"properties":{"workspaceId":{"type":"string","description":"Target workspace."},"name":{"type":"string","minLength":1,"maxLength":200,"description":"Folder display name."},"parentId":{"type":["string","null"],"description":"Optional parent folder id."}}}}}},"responses":{"201":{"description":"Folder created.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{"folder":{"$ref":"#/components/schemas/WorkspaceFolder"}},"required":["folder"]}},"required":["success","data"]}}}},"400":{"description":"Validation failed or parent folder not found."},"403":{"description":"Caller lacks write permission on the workspace."},"409":{"description":"Name collision after 100 auto-suffix attempts."},"500":{"description":"Internal error."}},"x-codeSamples":[{"lang":"curl","label":"curl","source":"curl -X POST \\\n \"https://steelengine.com/api/v1/docs/folders\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"workspaceId\":\"YOUR_WORKSPACE_ID\",\"name\":\"Reports\"}'"}]}},"/api/workflows/{id}/paused":{"get":{"operationId":"listPausedExecutions","summary":"List Paused Executions","description":"List the runs of a workflow that stopped at a Human in the Loop block, newest first. Requires read access to the workflow. The status filter is optional; omit it to return every paused execution.","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl \\\n \"https://steelengine.com/api/workflows/{id}/paused?status=paused,partially_resumed\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}},{"name":"status","in":"query","required":false,"description":"Comma-separated pause-record statuses to return: paused, partially_resumed, resumed, fully_resumed, cancelled. Per-block execution uses resumed when its current pause is resolved; legacy execution uses fully_resumed. Use paused,partially_resumed for records still waiting, or resumed,fully_resumed for resolved pauses across both runtimes. These are pause-record states, not final workflow outcomes. Omit the filter to return every paused execution.","schema":{"type":"string","example":"paused,partially_resumed"}}],"responses":{"200":{"description":"Paused executions matching the status filter. The list is not paginated.","content":{"application/json":{"schema":{"type":"object","properties":{"pausedExecutions":{"type":"array","items":{"$ref":"#/components/schemas/PausedExecutionSummary"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/workflows/{id}/paused/{executionId}":{"get":{"operationId":"getPausedExecution","summary":"Get Paused Execution","description":"Get one paused execution with all of its pause points, their resume forms and links, and the display names of the paused blocks. Requires read access to the workflow. GET /api/resume/{workflowId}/{executionId} returns the same body.","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl \\\n \"https://steelengine.com/api/workflows/{id}/paused/{executionId}\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}},{"name":"executionId","in":"path","required":true,"description":"The execution that paused.","schema":{"type":"string","example":"exec_9f8e7d6c5b"}}],"responses":{"200":{"description":"The paused execution.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PausedExecutionDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/resume/{workflowId}/{executionId}/{contextId}":{"get":{"operationId":"getPauseContext","summary":"Get Pause Point","description":"Get one pause point of a paused execution, with its resume form and any resume request that is running for it. Requires read access to the workflow.","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl \\\n \"https://steelengine.com/api/resume/{workflowId}/{executionId}/{contextId}\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"parameters":[{"name":"workflowId","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}},{"name":"executionId","in":"path","required":true,"description":"The execution that paused.","schema":{"type":"string","example":"exec_9f8e7d6c5b"}},{"name":"contextId","in":"path","required":true,"description":"The pause point to resume, from the pause point or its resumeLinks.","schema":{"type":"string","example":"hitl_block_1"}}],"responses":{"200":{"description":"The pause point.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PauseContextDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"operationId":"resumeExecution","summary":"Resume Execution","description":"Submit a decision for a paused Human in the Loop block and continue the run. Requires write access to the workflow. The body is the resume input, either wrapped in input or sent as top-level fields. The decision is approved unless the input sets _humanInTheLoopDecision (or decision) to denied or rejected. Each resume chooses its own response mode: synchronous by default, Server-Sent Events with Accept: text/event-stream or X-Stream-Response: true, or asynchronous with X-Execution-Mode: async (async wins when both are sent).","tags":["Workflows"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/resume/{workflowId}/{executionId}/{contextId}\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"input\": {\"approved\": true, \"comments\": \"Looks good\"}}'"}],"parameters":[{"name":"workflowId","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string","example":"wf_1a2b3c4d5e"}},{"name":"executionId","in":"path","required":true,"description":"The execution that paused.","schema":{"type":"string","example":"exec_9f8e7d6c5b"}},{"name":"contextId","in":"path","required":true,"description":"The pause point to resume, from the pause point or its resumeLinks.","schema":{"type":"string","example":"hitl_block_1"}},{"name":"X-Execution-Mode","in":"header","required":false,"description":"Set to async to return 202 immediately with a statusUrl to poll.","schema":{"type":"string","enum":["async"]}},{"name":"X-Stream-Response","in":"header","required":false,"description":"Set to true to stream post-resume events as Server-Sent Events.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"input":{"type":"object","description":"Values for the Resume Form fields, plus an optional _humanInTheLoopDecision."}},"additionalProperties":true},"example":{"input":{"approved":true,"comments":"Looks good to proceed"}}}}},"responses":{"200":{"description":"Synchronous result of the resumed run, an opened Server-Sent Events stream, or status queued with a queuePosition when another resume for this execution is already running. A queued response is JSON even when streaming was requested. A resumed run that reaches another Human in the Loop block returns status paused with new _resume links in output. With Accept: text/event-stream or X-Stream-Response: true, consume the SSE data frames described below.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string","description":"The runtime result status is returned unchanged. Successful completion can be success (per-block execution) or completed (legacy execution or the fallback when a successful result omits status). Other outcomes are failed, cancelled, paused when more human input is needed, or queued when another resume is already running. paused and queued are not terminal outcomes.","example":"success"},"executionId":{"type":"string","description":"The execution ID of the resumed run."},"rootExecutionId":{"type":"string"},"output":{"description":"The workflow output."},"error":{"type":"string"},"metadata":{"type":"object","properties":{"duration":{"type":"number"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"}}},"queuePosition":{"type":"integer","description":"Present when status is queued."},"message":{"type":"string"}}},"example":{"success":true,"status":"success","executionId":"exec_resume_123","rootExecutionId":"exec_9f8e7d6c5b","output":{"result":"approved"},"metadata":{"duration":1234,"startTime":"2026-01-01T00:00:00.000Z","endTime":"2026-01-01T00:00:01.234Z"}}},"text/event-stream":{"schema":{"type":"string","description":"SSE data frames contain JSON, except for the [DONE] end marker. Output chunks have blockId and chunk. A terminal payload has event: final and data containing success and output; if the run pauses again, data also contains status: paused. Execution failures or cancellation produce event: error with an error message. The stream normally ends with data: [DONE]; use the final or error payload to determine the run outcome. Heartbeat comments may appear between frames."},"example":"data: {\"blockId\":\"agent1\",\"chunk\":\"Approved\"}\n\ndata: {\"event\":\"final\",\"data\":{\"success\":true,\"output\":{\"result\":\"approved\"}}}\n\ndata: [DONE]\n\n"}}},"202":{"description":"The resume was accepted and is running. Returned for X-Execution-Mode: async, or when a synchronous wait timed out (status processing). Poll statusUrl with Get Job Status.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"async":{"type":"boolean"},"status":{"type":"string","description":"accepted, queued, or processing."},"jobId":{"type":"string"},"executionId":{"type":"string"},"rootExecutionId":{"type":"string"},"statusUrl":{"type":"string"},"message":{"type":"string"}}},"example":{"success":true,"async":true,"status":"accepted","executionId":"exec_resume_123","rootExecutionId":"exec_9f8e7d6c5b","statusUrl":"https://steelengine.com/api/jobs/exec_resume_123"}}}},"400":{"description":"The resume could not be queued. error carries the reason.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"The pause point named by contextId is not waiting: \"Resume request does not match the durable execution state\".","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"503":{"description":"The durable resume service or the resume event stream is temporarily unavailable. Retry later.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}},"/api/mcp/discover":{"get":{"operationId":"discoverMcpServers","summary":"Discover MCP Servers","description":"List the workflow MCP servers the caller can use, with the URL to configure in an MCP client. A workspace key sees its own workspace. Scoped and organization keys see only workspaces their grants reach. Servers in archived workspaces are left out. The list is not paginated.","tags":["MCP Servers"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl \\\n \"https://steelengine.com/api/mcp/discover\" \\\n -H \"X-API-Key: YOUR_API_KEY\""}],"responses":{"200":{"description":"The servers the caller can use.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"servers":{"type":"array","items":{"$ref":"#/components/schemas/McpServerSummary"}},"authentication":{"type":"object","description":"How to authenticate against each server URL.","properties":{"method":{"type":"string"},"header":{"type":"string"}}}}},"example":{"success":true,"servers":[{"id":"mcp_srv_123","name":"Support tools","description":"Ticket triage workflows","workspace":{"id":"ws_123","name":"Support"},"toolCount":3,"createdAt":"2026-01-01T00:00:00.000Z","url":"https://steelengine.com/api/mcp/serve/mcp_srv_123"}],"authentication":{"method":"API Key","header":"X-API-Key"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"A workspace key has no workspace scope.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}}}}},"/api/v1/chat":{"post":{"operationId":"sendChatMessage","summary":"Send Chat Message","description":"$6a","tags":["Chat"],"x-codeSamples":[{"id":"curl","label":"cURL","lang":"bash","source":"curl -X POST \\\n \"https://steelengine.com/api/v1/chat\" \\\n -H \"X-API-Key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"message\": \"Add a Slack notification after the Agent block\",\n \"workflowId\": \"YOUR_WORKFLOW_ID\"\n }'"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","minLength":1,"description":"The message to send to Chat."},"workflowId":{"type":"string","description":"The workflow Chat uses as context. Takes precedence over `workflowName`. When continuing a chat, it must match the stored workflow."},"workflowName":{"type":"string","description":"Name of the workflow to use as context when `workflowId` is omitted."},"chatId":{"type":"string","description":"An existing workflow chat to continue with its stored workflow and message history. Omit to start a new chat. Unknown or inaccessible IDs return 404; this field cannot create a chat with a caller-supplied ID."},"model":{"type":"string","description":"Model ID for this turn. Defaults to the platform's default Chat model."},"autoExecuteTools":{"type":"boolean","default":true,"description":"Whether Chat runs its tools during the turn. When false, tool calls are returned without running."},"timeout":{"type":"number","default":3600000,"description":"Maximum time for the turn, in milliseconds. The server stops waiting after one hour regardless."},"mode":{"type":"string","enum":["ask","build","plan","agent"],"default":"agent","deprecated":true,"description":"Accepted for compatibility and ignored."}}},"example":{"message":"Add a Slack notification after the Agent block","workflowId":"wf_abc123"}}}},"responses":{"200":{"description":"The finished turn. `success` is false when the turn ran but failed; `error` then says why.","content":{"application/json":{"schema":{"type":"object","required":["success","content","toolCalls","chatId"],"properties":{"success":{"type":"boolean","description":"Whether the turn completed without error."},"content":{"type":"string","description":"Chat's text reply."},"toolCalls":{"type":"array","description":"Tools Chat called during the turn, in order.","items":{"$ref":"#/components/schemas/ChatToolCall"}},"chatId":{"type":"string","description":"The chat this turn belongs to. Pass it as `chatId` to continue the conversation."},"error":{"type":"string","description":"Why the turn failed, when `success` is false."}}},"example":{"success":true,"content":"I added a Slack block after Agent 1 and connected it.","toolCalls":[{"id":"call_1","name":"edit_workflow","status":"success","durationMs":840}],"chatId":"chat_abc123"}}}},"400":{"description":"Invalid request body, no workflow is available, the requested workflow differs from the chat, or the chat has no attached workflow.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatError"},"example":{"success":false,"error":"Invalid request","details":[{"code":"too_small","path":["message"],"message":"message is required"}]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatError"},"example":{"success":false,"error":"API key required"}}}},"403":{"description":"The API key can't use Chat here: it is a scoped, workspace or organization key, or a personal key without write access to the workflow or in a workspace that disallows personal keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatError"},"example":{"success":false,"error":"API key is not authorized for this workspace"}}}},"404":{"description":"The `chatId` does not exist, is inaccessible to the API key owner, or can no longer be loaded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatError"},"example":{"success":false,"error":"Chat not found"}}}},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"description":"The turn could not be run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatError"},"example":{"success":false,"error":"Internal server error"}}}}}}}},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your SteelEngine API key (personal, workspace, or organization). Create personal and workspace keys under Settings > API Keys. Create organization keys under Organization Settings > API Keys."}},"parameters":{"TableId":{"name":"tableId","in":"path","required":true,"schema":{"type":"string","example":"tbl_abc123"},"description":"The unique identifier of the table."},"RowId":{"name":"rowId","in":"path","required":true,"schema":{"type":"string","example":"row_xyz789"},"description":"The unique identifier of the row."},"WorkspaceId":{"name":"workspaceId","in":"query","required":true,"schema":{"type":"string"},"description":"The unique identifier of the workspace."}},"schemas":{"ColumnDefinition":{"type":"object","description":"Definition of a table column including its type and constraints.","required":["name","type"],"properties":{"name":{"type":"string","description":"Column name. Must start with a letter or underscore.","example":"email","pattern":"^[a-zA-Z_][a-zA-Z0-9_]*$"},"type":{"type":"string","enum":["string","number","boolean","date","json"],"description":"Data type of the column."},"required":{"type":"boolean","description":"Whether the column requires a value on insert.","default":false},"unique":{"type":"boolean","description":"Whether values in this column must be unique across all rows.","default":false}}},"Table":{"type":"object","description":"A user-defined table with a typed schema.","properties":{"id":{"type":"string","description":"Unique table identifier.","example":"tbl_abc123"},"name":{"type":"string","description":"Table name.","example":"contacts"},"description":{"type":"string","description":"Optional description of the table.","example":"Customer contact records"},"schema":{"type":"object","description":"Table schema definition.","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnDefinition"},"description":"Array of column definitions for the table."}}},"rowCount":{"type":"integer","description":"Current number of rows in the table."},"maxRows":{"type":"integer","description":"Maximum rows allowed by the current billing plan."},"createdAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the table was created."},"updatedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the table was last modified."}}},"TableRow":{"type":"object","description":"A single row in a table.","properties":{"id":{"type":"string","description":"Unique row identifier.","example":"row_xyz789"},"data":{"type":"object","additionalProperties":true,"description":"Row data as key-value pairs matching the table schema."},"position":{"type":"integer","description":"Row's position/order in the table."},"createdAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the row was created."},"updatedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the row was last modified."}}},"WorkflowSummary":{"type":"object","description":"Summary representation of a workflow returned in list operations.","properties":{"id":{"type":"string","description":"Unique workflow identifier.","example":"wf_1a2b3c4d5e"},"name":{"type":"string","description":"Human-readable workflow name.","example":"Customer Support Agent"},"description":{"type":"string","nullable":true,"description":"Optional description of what the workflow does.","example":"Routes incoming support tickets and drafts responses"},"color":{"type":"string","description":"Hex color code used for the workflow icon in the dashboard (e.g., #4874ff).","example":"#4874ff"},"folderId":{"type":"string","nullable":true,"description":"The folder this workflow belongs to. null if at the workspace root.","example":"folder_abc123"},"workspaceId":{"type":"string","description":"The workspace this workflow belongs to.","example":"ws_xyz789"},"isDeployed":{"type":"boolean","description":"Whether the workflow is currently deployed and available for API execution.","example":true},"deployedAt":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 timestamp of the most recent deployment. null if never deployed.","example":"2025-06-15T10:30:00Z"},"runCount":{"type":"integer","description":"Total number of times this workflow has been executed.","example":142},"lastRunAt":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 timestamp of the most recent execution. null if never run.","example":"2025-06-20T14:15:22Z"},"createdAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the workflow was created.","example":"2025-01-10T09:00:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the workflow was last modified.","example":"2025-06-18T16:45:00Z"}}},"WorkflowDetail":{"type":"object","description":"Full workflow representation including input field definitions and configuration.","properties":{"id":{"type":"string","description":"Unique workflow identifier.","example":"wf_1a2b3c4d5e"},"name":{"type":"string","description":"Human-readable workflow name.","example":"Customer Support Agent"},"description":{"type":"string","nullable":true,"description":"Optional description of what the workflow does.","example":"Routes incoming support tickets and drafts responses"},"color":{"type":"string","description":"Hex color code used for the workflow icon in the dashboard.","example":"#4874ff"},"folderId":{"type":"string","nullable":true,"description":"The folder this workflow belongs to. null if at the workspace root.","example":"folder_abc123"},"workspaceId":{"type":"string","description":"The workspace this workflow belongs to.","example":"ws_xyz789"},"isDeployed":{"type":"boolean","description":"Whether the workflow is currently deployed and available for API execution.","example":true},"deployedAt":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 timestamp of the most recent deployment. null if never deployed.","example":"2025-06-15T10:30:00Z"},"runCount":{"type":"integer","description":"Total number of times this workflow has been executed.","example":142},"lastRunAt":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 timestamp of the most recent execution. null if never run.","example":"2025-06-20T14:15:22Z"},"variables":{"type":"object","description":"Workflow-level variables and their current values.","example":{}},"inputs":{"type":"object","description":"The workflow's input field definitions. Use these to construct the input object when executing the workflow.","properties":{"fields":{"type":"object","description":"Map of field names to their type definitions and configuration.","additionalProperties":true,"example":{}}}},"createdAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the workflow was created.","example":"2025-01-10T09:00:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the workflow was last modified.","example":"2025-06-18T16:45:00Z"}}},"ExecutionResult":{"type":"object","description":"Result of a synchronous workflow execution (X-SteelEngine-Response-Type: execution). A workflow that ends in a Response block returns that block's authored body, status code, and headers instead (X-SteelEngine-Response-Type: response).","properties":{"success":{"type":"boolean","description":"Whether the workflow executed successfully without errors.","example":true},"executionId":{"type":"string","description":"Unique identifier for this execution. Use this to query logs or cancel the execution.","example":"exec_9f8e7d6c5b"},"status":{"type":"string","enum":["success","failed","cancelled","paused"],"description":"Execution outcome reported by the engine, when available. paused means the run is waiting for human input and is not finished.","example":"success"},"output":{"description":"Workflow output. Structure depends on the workflow's blocks.","example":{"result":"Hello, world!"}},"error":{"type":"string","nullable":true,"description":"Error message when the execution failed. Absent or null on success.","example":null},"metadata":{"type":"object","description":"Execution timing metadata.","properties":{"duration":{"type":"integer","description":"Total execution duration in milliseconds.","example":1250},"startTime":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when execution started.","example":"2025-06-20T14:15:22Z"},"endTime":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when execution completed.","example":"2025-06-20T14:15:23Z"},"timingSemanticsVersion":{"type":"integer","description":"Present with value 2 when duration counts active execution time only. Then activeDurationMs, waitDurationMs, and elapsedDurationMs are also present.","example":2},"activeDurationMs":{"type":"integer","description":"Time spent executing blocks, in milliseconds."},"waitDurationMs":{"type":"integer","description":"Time spent waiting (for example on a paused run), in milliseconds."},"elapsedDurationMs":{"type":"integer","description":"Wall-clock time from start to end, in milliseconds."}}}}},"AsyncExecutionResult":{"type":"object","description":"Receipt returned (HTTP 202, X-SteelEngine-Response-Type: async) when X-Execution-Mode: async queues the execution.","properties":{"success":{"type":"boolean","description":"Whether the execution was successfully queued.","example":true},"async":{"type":"boolean","description":"Always true for async executions. Use this to distinguish from synchronous responses.","example":true},"jobId":{"type":"string","description":"Identifier to poll with Get Job Status. Equal to executionId.","example":"exec_9f8e7d6c5b"},"executionId":{"type":"string","description":"Unique execution identifier. Use this to query execution status or cancel.","example":"exec_9f8e7d6c5b"},"message":{"type":"string","description":"Human-readable status message.","example":"Workflow execution queued"},"statusUrl":{"type":"string","format":"uri","description":"URL of Get Job Status for this execution. Returns the output once the run completes.","example":"https://steelengine.com/api/jobs/exec_9f8e7d6c5b"}}},"LogEntry":{"type":"object","description":"Summary of a single workflow execution log entry.","properties":{"id":{"type":"string","description":"Unique log entry identifier.","example":"log_7x8y9z0a1b"},"workflowId":{"type":"string","description":"The workflow that was executed.","example":"wf_1a2b3c4d5e"},"executionId":{"type":"string","description":"Unique execution identifier for this run.","example":"exec_9f8e7d6c5b"},"level":{"type":"string","description":"Log severity. info for successful executions, error for failures.","example":"info"},"trigger":{"type":"string","description":"How the execution was triggered (e.g., api, manual, webhook, schedule, chat).","example":"api"},"startedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when execution started.","example":"2025-06-20T14:15:22Z"},"endedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when execution completed.","example":"2025-06-20T14:15:23Z"},"totalDurationMs":{"type":"integer","description":"Total execution duration in milliseconds.","example":1250},"cost":{"type":"object","description":"Cost summary for this execution.","properties":{"total":{"type":"number","description":"Total cost of this execution in USD.","example":0.0032}}},"files":{"type":"object","nullable":true,"description":"File outputs produced during execution. null if no files were generated.","example":null}}},"LogDetail":{"type":"object","description":"Detailed log entry with full execution data, workflow metadata, and cost breakdown.","properties":{"id":{"type":"string","description":"Unique log entry identifier.","example":"log_7x8y9z0a1b"},"workflowId":{"type":"string","description":"The workflow that was executed.","example":"wf_1a2b3c4d5e"},"executionId":{"type":"string","description":"Unique execution identifier for this run.","example":"exec_9f8e7d6c5b"},"level":{"type":"string","description":"Log severity. info for successful executions, error for failures.","example":"info"},"trigger":{"type":"string","description":"How the execution was triggered (e.g., api, manual, webhook, schedule, chat).","example":"api"},"startedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when execution started.","example":"2025-06-20T14:15:22Z"},"endedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when execution completed.","example":"2025-06-20T14:15:23Z"},"totalDurationMs":{"type":"integer","description":"Total execution duration in milliseconds.","example":1250},"workflow":{"type":"object","description":"Summary metadata about the workflow at the time of execution.","properties":{"id":{"type":"string","description":"Unique workflow identifier.","example":"wf_1a2b3c4d5e"},"name":{"type":"string","description":"Workflow name at the time of execution.","example":"Customer Support Agent"},"description":{"type":"string","nullable":true,"description":"Workflow description at the time of execution.","example":"Routes incoming support tickets and drafts responses"}}},"executionData":{"type":"object","description":"Detailed execution data including block-level traces and final output.","properties":{"traceSpans":{"type":"array","description":"Block-level execution traces with timing, inputs, and outputs for each block that ran.","items":{"type":"object"}},"finalOutput":{"type":"object","description":"The workflow's final output after all blocks completed."}}},"cost":{"type":"object","description":"Detailed cost breakdown for this execution.","properties":{"total":{"type":"number","description":"Total cost of this execution in USD.","example":0.0032},"tokens":{"type":"object","description":"Aggregate token usage across all AI model calls in this execution.","properties":{"prompt":{"type":"integer","description":"Total prompt (input) tokens consumed.","example":450},"completion":{"type":"integer","description":"Total completion (output) tokens generated.","example":120},"total":{"type":"integer","description":"Total tokens (prompt + completion).","example":570}}},"models":{"type":"object","description":"Per-model cost and token breakdown. Keys are model identifiers (e.g., gpt-4o, claude-sonnet-4-20250514).","additionalProperties":{"type":"object","description":"Cost and token details for a specific model.","properties":{"input":{"type":"number","description":"Cost of prompt tokens for this model in USD."},"output":{"type":"number","description":"Cost of completion tokens for this model in USD."},"total":{"type":"number","description":"Total cost for this model in USD."},"tokens":{"type":"object","description":"Token usage for this specific model.","properties":{"prompt":{"type":"integer","description":"Prompt tokens consumed by this model."},"completion":{"type":"integer","description":"Completion tokens generated by this model."},"total":{"type":"integer","description":"Total tokens for this model."}}}}}}}}}},"Limits":{"type":"object","description":"Rate limit and usage information attached to the /api/v1 workflows, logs, and audit logs responses. The Execute Workflow and Get Job Status responses do not include it.","properties":{"workflowExecutionRateLimit":{"type":"object","description":"Current rate limit status for workflow executions.","properties":{"sync":{"description":"Rate limit bucket for synchronous executions.","$ref":"#/components/schemas/RateLimitBucket"},"async":{"description":"Rate limit bucket for asynchronous executions.","$ref":"#/components/schemas/RateLimitBucket"}}},"usage":{"type":"object","description":"Current billing period usage and plan limits.","properties":{"currentPeriodCost":{"type":"number","description":"Total spend in the current billing period in USD.","example":1.25},"limit":{"type":"number","description":"Maximum allowed spend for the current billing period in USD.","example":50},"plan":{"type":"string","description":"Your current subscription plan (e.g., free, pro, team).","example":"pro"},"isExceeded":{"type":"boolean","description":"Whether the usage limit has been exceeded. Executions may be blocked when true.","example":false}}}}},"RateLimitBucket":{"type":"object","description":"Rate limit status for a specific execution type.","properties":{"requestsPerMinute":{"type":"integer","description":"Maximum number of requests allowed per minute.","example":60},"maxBurst":{"type":"integer","description":"Maximum number of concurrent requests allowed in a burst.","example":10},"remaining":{"type":"integer","description":"Number of requests remaining in the current rate limit window.","example":59},"resetAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the rate limit window resets.","example":"2025-06-20T14:16:00Z"}}},"JobStatus":{"type":"object","description":"Status of an execution looked up by its execution ID.","properties":{"success":{"type":"boolean","description":"Whether the lookup succeeded.","example":true},"jobId":{"type":"string","description":"The execution ID that was looked up.","example":"exec_9f8e7d6c5b"},"taskId":{"type":"string","description":"Same value as jobId, kept for compatibility.","example":"exec_9f8e7d6c5b"},"status":{"type":"string","enum":["pending","processing","paused","completed","failed","cancelled"],"description":"pending: admitted but not yet running. processing: running. paused: waiting for human input, not finished. completed, failed, and cancelled are terminal.","example":"completed"},"metadata":{"type":"object","description":"Execution metadata: workflowId, workspaceId, userId, and executionId. Once the run has finished, it also contains the timing fields startTime, endTime, duration, and the timingSemanticsVersion 2 fields.","additionalProperties":true,"properties":{"workflowId":{"type":"string"},"workspaceId":{"type":"string"},"userId":{"type":"string"},"executionId":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"duration":{"type":"integer","description":"Duration in milliseconds."},"source":{"type":"string","enum":["run-history"],"description":"Present when the status comes from run history because the run's execution record has expired."}}},"output":{"description":"Present once the run has a result. For an async execution this is the workflow output, or {data, status, headers} when the workflow ended in a Response block. For a synchronous run that returned a pending receipt, this is the full execution result (success, executionId, output, error, status, metadata). When metadata.source is run-history, this is the run-history copy of the workflow output, which is size-capped and has secrets removed.","example":{"result":"Hello, world!"}},"error":{"type":"string","description":"Present when status is failed or cancelled.","example":"Workflow execution failed"},"startedAt":{"type":"string","format":"date-time","description":"When the run started. Present once the result is available."},"completedAt":{"type":"string","format":"date-time","description":"When the run finished. Absent for paused runs."},"executedAt":{"type":"string","format":"date-time","description":"Same as completedAt. Present for async executions only."}}},"AuditLogEntry":{"type":"object","description":"An enterprise audit log entry recording an action taken in the workspace.","properties":{"id":{"type":"string","description":"Unique identifier for the audit log entry.","example":"audit_2c3d4e5f6g"},"workspaceId":{"type":"string","nullable":true,"description":"The workspace where the action occurred.","example":"ws_xyz789"},"actorId":{"type":"string","nullable":true,"description":"The user ID of the person who performed the action.","example":"user_abc123"},"actorName":{"type":"string","nullable":true,"description":"Display name of the person who performed the action.","example":"Jane Smith"},"actorEmail":{"type":"string","nullable":true,"description":"Email address of the person who performed the action.","example":"jane@example.com"},"action":{"type":"string","description":"The action that was performed (e.g., workflow.created, member.invited).","example":"workflow.deployed"},"resourceType":{"type":"string","description":"The type of resource affected (e.g., workflow, workspace, member).","example":"workflow"},"resourceId":{"type":"string","nullable":true,"description":"The unique identifier of the affected resource.","example":"wf_1a2b3c4d5e"},"resourceName":{"type":"string","nullable":true,"description":"Display name of the affected resource.","example":"Customer Support Agent"},"description":{"type":"string","nullable":true,"description":"Human-readable description of the action.","example":"Deployed workflow Customer Support Agent"},"metadata":{"type":"object","nullable":true,"description":"Additional context about the action.","example":null},"createdAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the action occurred.","example":"2025-06-20T14:15:22Z"}}},"UsageLimits":{"type":"object","description":"Current rate limits, usage, and storage information for the authenticated user.","properties":{"success":{"type":"boolean","description":"Whether the request was successful."},"rateLimit":{"type":"object","description":"Rate limit status for workflow executions.","properties":{"sync":{"description":"Rate limit bucket for synchronous executions.","allOf":[{"$ref":"#/components/schemas/RateLimitBucket"},{"type":"object","properties":{"isLimited":{"type":"boolean","description":"Whether the rate limit has been reached."}}}]},"async":{"description":"Rate limit bucket for asynchronous executions.","allOf":[{"$ref":"#/components/schemas/RateLimitBucket"},{"type":"object","properties":{"isLimited":{"type":"boolean","description":"Whether the rate limit has been reached."}}}]},"authType":{"type":"string","description":"The authentication type used (api or manual)."}}},"usage":{"type":"object","description":"Current billing period usage.","properties":{"currentPeriodCost":{"type":"number","description":"Total spend in the current billing period in USD."},"limit":{"type":"number","description":"Maximum allowed spend for the current billing period in USD."},"plan":{"type":"string","description":"Your current subscription plan (e.g., free, pro, team)."}}},"storage":{"type":"object","description":"File storage usage.","properties":{"usedBytes":{"type":"integer","description":"Total storage used in bytes."},"limitBytes":{"type":"integer","description":"Maximum storage allowed in bytes."},"percentUsed":{"type":"number","description":"Percentage of storage used (0-100)."}}}}},"KnowledgeBase":{"type":"object","description":"A knowledge base for storing and searching document embeddings.","properties":{"id":{"type":"string","description":"Unique knowledge base identifier."},"name":{"type":"string","description":"Knowledge base name."},"description":{"type":"string","nullable":true,"description":"Optional description."},"tokenCount":{"type":"integer","description":"Total token count across all documents."},"embeddingModel":{"type":"string","description":"Embedding model used (e.g. text-embedding-3-small)."},"embeddingDimension":{"type":"integer","description":"Embedding vector dimension."},"chunkingConfig":{"$ref":"#/components/schemas/ChunkingConfig"},"docCount":{"type":"integer","description":"Number of documents in the knowledge base."},"connectorTypes":{"type":"array","items":{"type":"string"},"description":"Types of connectors attached to this knowledge base."},"createdAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the knowledge base was created."},"updatedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the knowledge base was last modified."}}},"ChunkingConfig":{"type":"object","description":"Configuration for how documents are split into chunks for embedding.","properties":{"maxSize":{"type":"integer","minimum":100,"maximum":4000,"default":1024,"description":"Maximum chunk size in tokens."},"minSize":{"type":"integer","minimum":1,"maximum":2000,"default":100,"description":"Minimum chunk size in characters."},"overlap":{"type":"integer","minimum":0,"maximum":500,"default":200,"description":"Overlap between chunks in tokens."}}},"KnowledgeDocument":{"type":"object","description":"A document in a knowledge base.","properties":{"id":{"type":"string","description":"Unique document identifier."},"knowledgeBaseId":{"type":"string","description":"Knowledge base this document belongs to."},"filename":{"type":"string","description":"Original filename."},"fileSize":{"type":"integer","description":"File size in bytes."},"mimeType":{"type":"string","description":"MIME type of the file."},"processingStatus":{"type":"string","enum":["pending","processing","completed","failed"],"description":"Current processing status."},"chunkCount":{"type":"integer","description":"Number of chunks created from this document."},"tokenCount":{"type":"integer","description":"Total token count."},"characterCount":{"type":"integer","description":"Total character count."},"enabled":{"type":"boolean","description":"Whether the document is enabled for search."},"createdAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the document was uploaded."}}},"KnowledgeDocumentDetail":{"type":"object","description":"Detailed document information including processing and connector details.","properties":{"id":{"type":"string","description":"Unique document identifier."},"knowledgeBaseId":{"type":"string","description":"Knowledge base this document belongs to."},"filename":{"type":"string","description":"Original filename."},"fileSize":{"type":"integer","description":"File size in bytes."},"mimeType":{"type":"string","description":"MIME type of the file."},"processingStatus":{"type":"string","enum":["pending","processing","completed","failed"],"description":"Current processing status."},"processingError":{"type":"string","nullable":true,"description":"Error message if processing failed."},"processingStartedAt":{"type":"string","format":"date-time","nullable":true,"description":"When processing started."},"processingCompletedAt":{"type":"string","format":"date-time","nullable":true,"description":"When processing completed."},"chunkCount":{"type":"integer","description":"Number of chunks created."},"tokenCount":{"type":"integer","description":"Total token count."},"characterCount":{"type":"integer","description":"Total character count."},"enabled":{"type":"boolean","description":"Whether the document is enabled for search."},"connectorId":{"type":"string","nullable":true,"description":"Connector ID if sourced from an external connector."},"connectorType":{"type":"string","nullable":true,"description":"Connector type (e.g. google-drive, notion)."},"sourceUrl":{"type":"string","nullable":true,"description":"Original source URL for connector-sourced documents."},"createdAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the document was uploaded."}}},"SearchResult":{"type":"object","description":"A single search result from knowledge base vector search.","properties":{"documentId":{"type":"string","description":"ID of the source document."},"documentName":{"type":"string","description":"Filename of the source document."},"content":{"type":"string","description":"The matched chunk content."},"chunkIndex":{"type":"integer","description":"Index of the chunk within the document."},"metadata":{"type":"object","description":"Tag metadata associated with the chunk (display names mapped to values)."},"similarity":{"type":"number","minimum":0,"maximum":1,"description":"Similarity score (0-1, where 1 is most similar)."}}},"TagFilter":{"type":"object","description":"A tag-based filter for knowledge base search.","required":["tagName","value"],"properties":{"tagName":{"type":"string","description":"Display name of the tag to filter by."},"fieldType":{"type":"string","enum":["text","number","date","boolean"],"default":"text","description":"Data type of the tag field."},"operator":{"type":"string","default":"eq","description":"Comparison operator (e.g. eq, neq, gt, lt, gte, lte, contains, between)."},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value to filter by."},"valueTo":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"Upper bound value for 'between' operator."}}},"Workspace":{"type":"object","description":"A workspace groups workflows, tables, knowledge bases, files, and credentials under a single billing + permission boundary.","properties":{"id":{"type":"string","description":"Unique workspace identifier.","example":"wsp_abc123"},"name":{"type":"string","description":"Workspace display name.","example":"Engineering"},"slug":{"type":"string","description":"Immutable URL slug assigned at creation. Crockford base32, unique within the parent organization.","example":"engin3r2"},"color":{"type":"string","description":"Hex color shown in the workspace switcher.","pattern":"^#[0-9a-fA-F]{6}$","example":"#3972F6"},"ownerId":{"type":"string","description":"User ID of the workspace owner."},"organizationId":{"type":"string","description":"Parent organization ID."},"billedAccountUserId":{"type":"string","description":"User ID whose subscription is billed for this workspace's usage. Defaults to ownerId."},"allowPersonalApiKeys":{"type":"boolean","description":"Whether members can create personal API keys for this workspace.","default":true},"roleKey":{"type":["string","null"],"description":"The caller's most significant role key on this workspace. Seeded keys are workspace:admin, workspace:write, and workspace:read. Custom role keys can also appear.","example":"workspace:admin"},"roleKeys":{"type":"array","items":{"type":"string"},"description":"Every role key the caller holds on this workspace, including organization-wide roles.","example":["workspace:admin"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time","description":"Set when the workspace is archived; null otherwise."}}},"DocMetadata":{"type":"object","properties":{"id":{"type":"string","description":"Unique file identifier.","example":"wf_1709571234_abc1234"},"name":{"type":"string","description":"Original filename.","example":"data.csv"},"size":{"type":"integer","description":"File size in bytes.","example":1024},"type":{"type":"string","description":"MIME type of the file.","example":"text/csv"},"key":{"type":"string","description":"Storage key for the file.","example":"workspace/abc-123/1709571234-xyz-data.csv"},"uploadedBy":{"type":"string","description":"User ID of the uploader."},"uploadedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of when the file was uploaded."},"folderId":{"type":["string","null"],"description":"Parent folder id, or null when the doc lives at the workspace top level."}}},"WorkspaceFolder":{"type":"object","description":"A workspace folder used to organize docs.","properties":{"id":{"type":"string","description":"Folder ID."},"workspaceId":{"type":"string","description":"Owning workspace ID."},"parentId":{"type":["string","null"],"description":"Parent folder ID, or null for top-level."},"name":{"type":"string","description":"Display name."},"isSystem":{"type":"boolean","description":"Whether this is a system-managed folder."},"sortOrder":{"type":"integer","description":"Display sort order."},"color":{"type":["string","null"],"description":"Optional accent color."},"createdBy":{"type":["string","null"],"description":"User ID of the creator."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","workspaceId","parentId","name","isSystem","sortOrder","createdAt","updatedAt"]},"PendingExecutionResult":{"type":"object","description":"Receipt returned (HTTP 202, X-SteelEngine-Response-Type: pending) when a synchronous execution was admitted but its result did not arrive in time. The run continues. Poll statusUrl instead of sending another request, which would start a second run.","properties":{"success":{"type":"boolean","description":"Always true: the execution was admitted.","example":true},"pending":{"type":"boolean","description":"Always true. Distinguishes this receipt from an execution result.","example":true},"executionId":{"type":"string","description":"Execution identifier. Use it as the jobId for Get Job Status.","example":"exec_9f8e7d6c5b"},"message":{"type":"string","example":"Workflow execution was admitted, but its result is not yet available"},"statusUrl":{"type":"string","format":"uri","description":"URL of Get Job Status for this execution.","example":"https://steelengine.com/api/jobs/exec_9f8e7d6c5b"}}},"ResumeQueueEntry":{"type":"object","description":"One resume request recorded against a pause point.","properties":{"id":{"type":"string"},"contextId":{"type":"string","description":"The pause point this resume targets."},"newExecutionId":{"type":"string","description":"The execution ID the resumed run uses."},"resumeInput":{"description":"The input sent with the resume request."},"status":{"type":"string","description":"Queue status of the resume request."},"queuedAt":{"type":["string","null"],"format":"date-time"},"claimedAt":{"type":["string","null"],"format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"},"failureReason":{"type":["string","null"]},"decidedBy":{"type":["object","null"],"description":"Who submitted the decision: a user, or an API key when the resume was sent with one.","properties":{"userId":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"]},"apiKeyId":{"type":["string","null"]},"apiKeyName":{"type":["string","null"]}}}}},"PausePoint":{"type":"object","description":"One place where a run is waiting for human input. A Human in the Loop block inside a Loop or Parallel pauses once per iteration or branch, each with its own contextId.","properties":{"contextId":{"type":"string","description":"Identifies this pause point. Pass it to Resume Execution."},"blockId":{"type":"string","description":"The Human in the Loop block that paused."},"response":{"description":"The pause response: display data, the resume form definition, and the resume links."},"registeredAt":{"type":"string","format":"date-time"},"resumeStatus":{"type":"string","enum":["paused","queued","resuming","resumed","failed"],"description":"Whether this pause point is still waiting."},"snapshotReady":{"type":"boolean"},"resumeLinks":{"type":"object","properties":{"apiUrl":{"type":"string","description":"Resume Execution URL for this pause point."},"uiUrl":{"type":"string","description":"Approval portal URL."},"contextId":{"type":"string"},"executionId":{"type":"string"},"workflowId":{"type":"string"}}},"queuePosition":{"type":["integer","null"],"description":"Position in the resume queue when a resume for this execution is already running."},"latestResumeEntry":{"oneOf":[{"$ref":"#/components/schemas/ResumeQueueEntry"},{"type":"null"}]}}},"PausedExecutionSummary":{"type":"object","description":"A paused execution as returned by List Paused Executions.","properties":{"id":{"type":"string","description":"ID of the paused-execution record."},"workflowId":{"type":"string"},"executionId":{"type":"string","description":"The execution that paused."},"status":{"type":"string","description":"State of the pause record, not the final workflow outcome. Per-block execution uses paused while input is still needed (including after a partial resume) and resumed once its current pause is resolved. Legacy execution uses paused, partially_resumed, or fully_resumed. cancelled can also appear. Filter with resumed,fully_resumed to select resolved pauses across both runtimes.","example":"resumed"},"totalPauseCount":{"type":"integer"},"resumedCount":{"type":"integer"},"pausedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"expiresAt":{"type":["string","null"],"format":"date-time"},"pausePoints":{"type":"array","items":{"$ref":"#/components/schemas/PausePoint"}},"metadata":{"type":["object","null"],"description":"Metadata recorded when the run paused."},"triggerIds":{"type":"array","items":{"type":"string"}}}},"PausedExecutionDetail":{"type":"object","description":"A paused execution with every pause point. The internal execution snapshot is never returned.","properties":{"id":{"type":"string","description":"ID of the paused-execution record."},"workflowId":{"type":"string"},"executionId":{"type":"string","description":"The execution that paused."},"status":{"type":"string","description":"State of the pause record, not the final workflow outcome. Per-block execution uses paused while input is still needed (including after a partial resume) and resumed once its current pause is resolved. Legacy execution uses paused, partially_resumed, or fully_resumed. cancelled can also appear. Filter with resumed,fully_resumed to select resolved pauses across both runtimes.","example":"resumed"},"totalPauseCount":{"type":"integer"},"resumedCount":{"type":"integer"},"pausedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"expiresAt":{"type":["string","null"],"format":"date-time"},"pausePoints":{"type":"array","items":{"$ref":"#/components/schemas/PausePoint"}},"blockNames":{"type":"object","additionalProperties":{"type":"string"},"description":"Display name of each paused block, keyed by block ID."}}},"PauseContextDetail":{"type":"object","properties":{"execution":{"$ref":"#/components/schemas/PausedExecutionDetail"},"pausePoint":{"$ref":"#/components/schemas/PausePoint"},"activeResumeEntry":{"oneOf":[{"$ref":"#/components/schemas/ResumeQueueEntry"},{"type":"null"}]}}},"McpServerSummary":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"workspace":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]}}},"toolCount":{"type":"integer","description":"Number of workflow tools the server exposes."},"createdAt":{"type":"string","format":"date-time"},"url":{"type":"string","description":"The server URL to configure in an MCP client."}}},"ChatToolCall":{"type":"object","required":["id","name","status"],"properties":{"id":{"type":"string","description":"Tool call ID."},"name":{"type":"string","description":"Tool name."},"status":{"type":"string","enum":["success","error","pending"],"description":"`pending` means the tool was not run, for example when `autoExecuteTools` is false."},"params":{"type":"object","additionalProperties":true,"description":"Arguments Chat passed to the tool."},"result":{"description":"What the tool returned."},"error":{"type":"string","description":"Why the tool call failed."},"durationMs":{"type":"number","description":"How long the tool took, in milliseconds."}}},"ChatError":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"string","description":"Human-readable error message."},"details":{"type":"array","items":{"type":"object"},"description":"Field-level validation errors, on `400` responses."}}}},"responses":{"BadRequest":{"description":"Invalid request parameters. Check the details array for specific validation errors.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message describing the validation failure."},"details":{"type":"array","description":"List of specific validation errors with field-level details.","items":{"type":"object"}}}}}}},"Unauthorized":{"description":"Invalid or missing API key. Ensure the X-API-Key header is set with a valid key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}}}}}},"Forbidden":{"description":"Access denied. You do not have permission to access this resource. For audit log endpoints, this requires an Enterprise subscription and organization admin/owner role.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}}}}}},"NotFound":{"description":"The requested resource was not found. Verify the ID is correct and belongs to your workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}}}}}},"RateLimited":{"description":"Rate limit exceeded. Wait for the duration specified in the Retry-After header before retrying.","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message with rate limit details."}}}}}},"RowsUpdated":{"description":"Rows updated.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"message":{"type":"string","description":"Confirmation message describing how many rows were updated."},"updatedCount":{"type":"integer","description":"Number of rows that were updated."},"updatedRowIds":{"type":"array","items":{"type":"string"},"description":"Array of IDs for each row that was updated."}},"description":"Response payload."}}},"example":{"success":true,"data":{"message":"Rows updated successfully","updatedCount":2,"updatedRowIds":["row_abc123","row_def456"]}}}}}}}},"proxyUrl":"$undefined"},"document":"./openapi.json","operations":[{"method":"delete","path":"/api/v1/docs/folders/{folderId}","tags":["Docs"]}],"showDescription":true}]}]

Delete Doc Folder

Authorization

Path Parameters

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`