mirror of
https://github.com/simstudioai/sim.git
synced 2026-09-21 13:00:04 +08:00
Waleed
7c05e36049
* fix(tables): stop a column retype from nulling empty-string cells A type conversion rewrote every cell holding '' to null. Main only nulled a blank the target type could not read; '' is a real stored value that both string and json columns accept, so string->json and json->string silently destroyed those cells. Worse on a required target: countEmptyCells matches only a missing key, SQL NULL, or '[]', so '' passes the required guard and the rewrite then wrote null behind a constraint that had just succeeded. The per-cell decision is now the pure retypeCellRewrite, restoring main's rule: null a blank only when the target cannot read it, otherwise coerce. * fix(execution): release the concurrency slot when a group cancel is refused The stop-the-work effects (durable Redis abort record, queue-job cancel, in-process abort) all fire before the workflow-group sidecar is consulted, and none can be undone. When the sidecar refuses the claim we throw a conflict, which skipped releaseExecutionSlot and stranded the plan concurrency reservation until it expired. Every conflict return is a terminal-or-absent state - a missing log row, a log already completed or errored, or a terminal cell - so a refusal never means the run is still executing. The slot is released before the throw, keeping the exact success && !isPausedCancellationPath predicate rather than a blanket finally that would free reservations for live runs. * fix(uploads): recover an ambiguous PUT instead of discarding the object Main recovered an upload whose bytes committed but whose response was lost, via a verify endpoint. The session client retries the PUT instead, but every provider now signs a create-only precondition, so the retry returns 409/412, is classified non-retryable, and the session aborts - deleting the object that had already landed. A transient blip on the final ack cost the whole upload. A conflict on a retry attempt is now treated as our own earlier PUT having committed, and completion proceeds. That is safe because completeUploadSession independently verifies the object through assertObjectIdentity, which rejects on uploadId mismatch before anything durable is registered. A first-attempt conflict still fails loudly. * fix(folders): enforce the workspace folder ceiling on the create path Readers bound the active path index at MAX_FOLDERS_PER_WORKSPACE and throw once a workspace exceeds it, but POST /api/folders reached createFolder, which has no maxFolderRows field and never counts. A workspace could therefore be driven past the ceiling, after which the 27 capped read sites failed on a state the product had allowed. createFolder now asserts room inside its transaction, right after the mutation lock, so the count cannot be raced. The refusal is a typed conflict rendering 409 with an actionable message rather than a 500. The check counts rows directly instead of loading the path index, so an already-over-cap workspace gets a clean refusal rather than a read error, and no reader gained a cap. folderMutationStatus also gained the payload_too_large mapping it was missing, which had been rendering a delete-cascade cap breach as an unexplained 500. * fix(skills): route internal skill writes through the shared use cases The internal route made the workspace authorization decision itself, never consulting the skills operation policy, never loading canonical workspace context, and recording an audit entry with no operation id or actor projection. v2 and Copilot already went through the use cases; only this surface did not. GET/POST/DELETE now authenticate, parse, call the shared use case, and present. Request and response shapes are unchanged. Two behavior changes fall out: a write against a deleted workspace is now refused with 404 rather than accepted, and permission-denial text matches the rest of the platform. Legacy internal-JWT auth is dropped because no principal kind expresses that caller and nothing calls it: the whole repo references /api/skills only in two comments, no tool declares an internalRoute to it, and the executor reads skills through a direct listSkills call rather than over HTTP. * fix(folders): enforce the workspace ceiling on the remaining create paths Folder duplication, admin workspace import, and workspace forking all inserted folders without consulting the ceiling that 27 read sites enforce, so any of them could leave a workspace whose reads then fail. Each now asserts room for the rows it is about to add rather than one at a time: duplication measures the whole subtree up front, forking counts its bulk insert, and import counts per segment because that is genuinely one row. assertFolderCollectionHasRoom gained an additionalRows notion for the bulk case, and short-circuits when nothing is being added so an over-cap workspace still reads and still syncs. Duplication deliberately does not take the folder mutation lock. Holding it across the copy would block folder creation workspace-wide for an unbounded time - there is no cap on workflows per subtree and duplicateWorkflow runs sequentially - and narrowing it is impossible because an advisory transaction lock cannot be released early; splitting the transaction would leave a half-copied tree on failure. A rare few-row overshoot near the ceiling is the better trade, and it matches what forking already does. A test asserts the lock is absent so re-adding it is a visible decision. Admin import gained the transaction and lock it never had. Its folder-full refusal escapes the per-workflow result list, because a full tree is a property of the workspace and would otherwise be buried as N failures behind a 200. The fork and promote routes had no catch at all, and withRouteHandler only classifies HttpError, so a refusal rendered as an opaque 500 - twice over, since drizzle wraps the throw. Both now project a classified conflict as 409 and rethrow anything unclassified. * fix(uploads): bound the signed PUT lifetime and advertise its real expiry A single-PUT transfer was signed for the whole 24h upload-session TTL, because expiresAt was reused as both the session lifetime and the signing lifetime. Multipart part URLs in the same file kept 1h, and the pre-migration presigned route signed every PUT for 1h, so the widening was unintended rather than a policy change. No provider clamps below 24h. The PUT presign is now clamped at the provider boundary by a shared UPLOAD_URL_TTL_MS, which the part-URL path also uses so the two cannot drift. An expired PUT URL is deliberately not recoverable: unlike multipart, which re-signs per part call because its progress is durable, a PUT is not resumable, so an expired URL and an interrupted PUT have identical recovery. Nothing leaks, since every provider signs a create-only precondition. Clamping alone would have made the contract lie: the URL would die an hour before the session's advertised expiresAt, with nothing telling an integrator why the 403 happened. The PUT transfer now carries its own expiresAt, mirroring the multipart part-URL field. It is provider-dependent on purpose - cloud transfers report the clamped signature expiry, while the local data plane has no signature and admits against the session, so reporting an hour there would have been a new inaccuracy in the other direction. * chore: delete the dead presigned-upload and skill-adapter paths The presigned upload routes and the internal skills adapters were both replaced during the v2 migration, leaving their implementations behind with no callers. Removed generatePresignedUploadUrl and verifyPresignedUploadReceipt with their three provider helpers, QUOTA_EXEMPT_STORAGE_CONTEXTS and the types it orphaned, and the performCreateSkill/performUpdateSkill/performDeleteSkill adapters with recordSkillEvent and statusForSkillOrchestrationError. Each was verified unreachable across apps, packages, scripts and ee, including barrel re-exports and string access, not just direct imports. recordSkillEvent needed the closest look, since deleting an audit writer can silently drop coverage. The use cases declare the same action, resource, and description, and the framework adds the operation and actor the old helper lacked; recordAudit back-fills actorName and actorEmail from the user table when both are omitted, so the one field the helper passed is not lost. The self-hosting architecture doc described a directUploadSupported flag on an endpoint that no longer exists, and now describes the upload-session flow that replaced it. * refactor(folders): keep the cheap resource facts out of the schema graph Reading a folder resource type's label or its lock support meant importing folderResourceConfig, which imports the db schema for every table it serves and from there reaches lib/table/service, the executor, and the tool registry. That mattered as soon as lib/folders/queries needed a label: queries is reached from workspace-file-manager, which is reached from the files and chat pages, so one import edge put roughly 4,700 modules into those page graphs and broke the tool-registry boundary audit. Labels and lock support now live in a leaf module that imports only a type, and config composes them so there is still one source of truth. The three folder routes that pulled the whole config in for a single boolean read the leaf instead. * fix(skills): apply an upsert batch in one transaction The internal skills route looped the batch, calling an independently committing use case per item. A rejection on a later item left the earlier ones written and audited while the request reported failure - the compound-mutation rule in CLAUDE.md exists for exactly this. No new transaction plumbing was needed: upsertSkills already wraps its whole item loop in one db.transaction, so the partial commit came from calling it N times rather than once. upsertSkillBatch now validates and per-skill authorizes every item before issuing a single write, and createSkill and updateSkill became thin wrappers over it so v2 and Copilot keep one authority for the rules. The compound operation declares the read floor that skills.update already used, and the use case additionally authorizes skills.create when any item lacks an id, still ahead of every write. A read-only member who is a skill editor keeps their edit, and creates are not authorized more loosely than before. Audit projects one entry per committed skill, and analytics moved after the commit so nothing is reported for a rolled-back item. Note metadata.operation for these writes is now skills.upsert rather than skills.create/update; the action field still carries the distinction. * fix(security): close two disclosure gaps and finish the slot-leak fix The payer-pool gate only covered the workspace branch. A personal API key that omits workspaceId takes the account branch, where getHighestPrioritySubscription resolves an organization subscription from any member row regardless of role - so a plain member read the organization-wide credit and storage pool by dropping one query parameter. The account branch is now gated by the same authority, and the storage pool is not queried when it may not be disclosed. Forcing that branch self-scoped instead would have downgraded plan, period, and status, which is what a member needs to see whether the org is blocked. GET /api/v1/logs/executions/[executionId] emitted the workflow snapshot raw, carrying password sub-block values and oauth-input credential ids. It now shares the sanitizer the v2 read already used, extracted so there is one implementation rather than two. Env-var references are still preserved. cancelWorkflowGroupExecution itself was unguarded, so an unexpected throw from its transaction escaped ahead of every release site - the same reservation leak this branch set out to close, still open on the adjacent path. It now releases through the shared predicate and rethrows, because a failed transition means the cell state is unknown and a success-shaped answer would be a lie. The comment claiming the abort record cannot be taken back was false and now states the real reason: a refusal is always a terminal-or-absent state. * fix(v2-api): cover every persisted run status and every capped body The workflow-runs endpoints carried the same omission the logs contract had: the execution logger persists redacting, the run schemas did not list it, and because validation is whole-response one such row returned 500 for an entire page. Both schemas now derive from PersistedWorkflowExecutionStatus behind the same AssertNever gate, so a future status is a type error rather than a production 500. The single-run read keeps its extra queued value, which only it can observe. That schema was also serving as the run-list status filter. Widening it would have accepted a filter value the application input cannot express, so the reported set and the accepted filter are now separate schemas. Routes declaring maxBodyBytes without payloadTooLargeResponse fell back to a bare string with no error code and no private cache header. Rather than patch the four, the default moved into the builders - all three had the hole - which covers 58 body-bearing handlers, and a route override still wins. The five per-route overrides that merely restated the default are gone. Also documents the 413 on the one knowledge route that has a real body cap, adds the rollout gate's 404 to the last v2 operation missing it, and rewords the nextCursor description, which read as though every list were a full-set list. * fix(api): make the shared traits and lifetimes single-sourced The folder resource-traits leaf composed labels into config but restated lock support independently, so the routes reading the trait and the orchestration reading the config could disagree about which resources lock. Config now composes both, and supportsLocking is required rather than optional so a new resource type cannot silently omit it. The upload commit claimed the PUT clamp and the multipart part URLs shared a constant and could not drift. That was true only of the advertised expiry - the three provider signers each hardcoded an hour, so changing the constant would have moved what we advertise while leaving what we sign, recreating exactly the mismatch the clamp removed. Each provider now receives the lifetime in its own unit from the one constant. Table restore hand-rolled its status map and returned the driver message verbatim at 500, leaking the failed statement and its bound parameters - the same defect this branch closed at nine other sites. It and import-csv now use the shared projection; import-csv's result type also had to carry the lock the classifier already set, so a 423 can name it. Deletes v2RowWriteError, which had no callers and would have rendered a locked table as 400 by discarding the 423 it was handed.
4747 lines
160 KiB
JSON
4747 lines
160 KiB
JSON
{
|
|
"openapi": "3.1.0",
|
|
"info": {
|
|
"title": "Sim API v2 — Workflows",
|
|
"description": "Version 2 of the Sim REST API for workflow management, deployment versions, execution, run lifecycle, folders, and portable import and export.",
|
|
"version": "2.0.0",
|
|
"contact": {
|
|
"name": "Sim Support",
|
|
"email": "help@sim.ai",
|
|
"url": "https://www.sim.ai"
|
|
},
|
|
"license": {
|
|
"name": "Apache 2.0",
|
|
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
|
|
}
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "https://www.sim.ai",
|
|
"description": "Production"
|
|
}
|
|
],
|
|
"tags": [
|
|
{
|
|
"name": "Workflows",
|
|
"description": "Manage and execute workflow definitions, folders, deployment versions, and portable imports and exports."
|
|
},
|
|
{
|
|
"name": "Workflow Runs",
|
|
"description": "Inspect, resume, and cancel workflow runs."
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"paths": {
|
|
"/api/v2/workflows": {
|
|
"get": {
|
|
"operationId": "listWorkflows",
|
|
"summary": "List Workflows",
|
|
"description": "List workflows in a workspace with folder and deployment filters, search, sorting, and opaque cursor pagination. A workspace whose folder tree exceeds 10,000 folders is a 413, because the response needs the whole tree to render folder paths.",
|
|
"tags": ["Workflows"],
|
|
"parameters": [
|
|
{
|
|
"name": "workspaceId",
|
|
"in": "query",
|
|
"required": true,
|
|
"description": "Workspace whose workflows should be listed.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Workspace whose workflows should be listed."
|
|
}
|
|
},
|
|
{
|
|
"name": "folderPath",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Restrict results to workflows in this folder path.",
|
|
"schema": {
|
|
"description": "Restrict results to workflows in this folder path.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "deployedOnly",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Return only workflows with an active deployment when true.",
|
|
"schema": {
|
|
"description": "Return only workflows with an active deployment when true.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Maximum workflows to return per page.",
|
|
"schema": {
|
|
"default": 50,
|
|
"description": "Maximum workflows to return per page.",
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "cursor",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Opaque pagination cursor returned by a previous request.",
|
|
"schema": {
|
|
"description": "Opaque pagination cursor returned by a previous request.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "search",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Case-insensitive substring search on the resource name.",
|
|
"schema": {
|
|
"description": "Case-insensitive substring search on the resource name.",
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 200
|
|
}
|
|
},
|
|
{
|
|
"name": "sortBy",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Field used to sort the result.",
|
|
"schema": {
|
|
"default": "position",
|
|
"description": "Field used to sort the result.",
|
|
"type": "string",
|
|
"enum": ["position", "name", "createdAt", "updatedAt", "runCount"]
|
|
}
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Sort direction.",
|
|
"schema": {
|
|
"default": "asc",
|
|
"description": "Sort direction.",
|
|
"type": "string",
|
|
"enum": ["asc", "desc"]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A page of workflows.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowListResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"413": {
|
|
"$ref": "#/components/responses/PayloadTooLarge"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"operationId": "createWorkflowV2",
|
|
"summary": "Create Workflow",
|
|
"description": "Create a workflow in a workspace root or canonical workflow folder. A workspace whose folder tree exceeds 10,000 folders is a 413, because the response needs the whole tree to render folder paths.",
|
|
"tags": ["Workflows"],
|
|
"requestBody": {
|
|
"required": true,
|
|
"description": "Name, description, workspace, and optional folder for a new workflow.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateWorkflowRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "The created workflow.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateWorkflowResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"409": {
|
|
"$ref": "#/components/responses/Conflict"
|
|
},
|
|
"413": {
|
|
"$ref": "#/components/responses/PayloadTooLarge"
|
|
},
|
|
"423": {
|
|
"$ref": "#/components/responses/Locked"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/workflows/{id}": {
|
|
"get": {
|
|
"operationId": "getWorkflow",
|
|
"summary": "Get Workflow",
|
|
"description": "Get a workflow with its variables and deployed API-trigger inputs. A workspace whose folder tree exceeds 10,000 folders is a 413, because the response needs the whole tree to render folder paths.",
|
|
"tags": ["Workflows"],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The requested workflow.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowDetailResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"413": {
|
|
"$ref": "#/components/responses/PayloadTooLarge"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"operationId": "updateWorkflowV2",
|
|
"summary": "Update Workflow",
|
|
"description": "Rename, describe, or move a workflow to a canonical folder path. A workspace whose folder tree exceeds 10,000 folders is a 413, because the response needs the whole tree to render folder paths.",
|
|
"tags": ["Workflows"],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"description": "Fields to update on an existing workflow.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UpdateWorkflowRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "The updated workflow.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UpdateWorkflowResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"409": {
|
|
"$ref": "#/components/responses/Conflict"
|
|
},
|
|
"413": {
|
|
"$ref": "#/components/responses/PayloadTooLarge"
|
|
},
|
|
"423": {
|
|
"$ref": "#/components/responses/Locked"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"operationId": "deleteWorkflowV2",
|
|
"summary": "Delete Workflow",
|
|
"description": "Permanently delete a workflow and its associated mutable state.",
|
|
"tags": ["Workflows"],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The workflow was deleted.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DeleteWorkflowResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"423": {
|
|
"$ref": "#/components/responses/Locked"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/workflows/{id}/versions": {
|
|
"get": {
|
|
"operationId": "listWorkflowVersionsV2",
|
|
"summary": "List Workflow Versions",
|
|
"description": "List immutable deployment versions of a workflow, newest first.",
|
|
"tags": ["Workflows"],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
}
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Maximum deployment versions to return per page.",
|
|
"schema": {
|
|
"default": 50,
|
|
"description": "Maximum deployment versions to return per page.",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"maximum": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "cursor",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Opaque pagination cursor returned by a previous request.",
|
|
"schema": {
|
|
"description": "Opaque pagination cursor returned by a previous request.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A page of deployment versions.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowVersionListResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/workflows/{id}/versions/{version}": {
|
|
"get": {
|
|
"operationId": "getWorkflowVersionV2",
|
|
"summary": "Get Workflow Version",
|
|
"description": "Get an immutable deployment version and its pinned workflow graph snapshot.",
|
|
"tags": ["Workflows"],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Unique workflow identifier."
|
|
}
|
|
},
|
|
{
|
|
"name": "version",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Numeric deployment version.",
|
|
"schema": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"description": "Numeric deployment version.",
|
|
"examples": [3]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The requested deployment version.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowVersionDetailResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/workflows/{id}/deploy": {
|
|
"post": {
|
|
"operationId": "deployWorkflow",
|
|
"summary": "Deploy Workflow",
|
|
"description": "Create and asynchronously activate a deployment version. This request is not idempotent: it accepts no idempotency key and every call mints a new deployment version, so retrying after a timeout creates a second version rather than returning the first. The response carries `latestDeploymentAttempt` for the accepted attempt, but `GET /workflows/{id}` does not expose that field — poll activation with `isDeployed` and `deployedAt` on the workflow, or with `isActive` on `GET /workflows/{id}/versions`. Returns 409 when the deployment would conflict with an existing webhook path. A workspace API key cannot call this operation. Because unauthorized resources are concealed, the rejection is reported as `404` rather than `403`; use a personal API key.",
|
|
"tags": ["Workflows"],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": false,
|
|
"description": "Optional metadata for the new deployment version.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DeployWorkflowRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "The accepted deployment attempt.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DeployWorkflowResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"409": {
|
|
"$ref": "#/components/responses/Conflict"
|
|
},
|
|
"413": {
|
|
"$ref": "#/components/responses/PayloadTooLarge"
|
|
},
|
|
"423": {
|
|
"$ref": "#/components/responses/Locked"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"operationId": "undeployWorkflow",
|
|
"summary": "Undeploy Workflow",
|
|
"description": "Deactivate the currently serving workflow version. A workspace API key cannot call this operation. Because unauthorized resources are concealed, the rejection is reported as `404` rather than `403`; use a personal API key.",
|
|
"tags": ["Workflows"],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The workflow was undeployed.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UndeployWorkflowResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"423": {
|
|
"$ref": "#/components/responses/Locked"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/workflows/{id}/rollback": {
|
|
"post": {
|
|
"operationId": "rollbackWorkflow",
|
|
"summary": "Rollback Workflow",
|
|
"description": "Asynchronously reactivate a previous deployment version, selecting the preceding active version when no version is supplied. A workspace API key cannot call this operation. Because unauthorized resources are concealed, the rejection is reported as `404` rather than `403`; use a personal API key.",
|
|
"tags": ["Workflows"],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": false,
|
|
"description": "Optional deployment version to reactivate.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RollbackWorkflowRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "The accepted rollback attempt.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RollbackWorkflowResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"413": {
|
|
"$ref": "#/components/responses/PayloadTooLarge"
|
|
},
|
|
"423": {
|
|
"$ref": "#/components/responses/Locked"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/workflows/{id}/export": {
|
|
"get": {
|
|
"operationId": "exportWorkflow",
|
|
"summary": "Export Workflow",
|
|
"description": "Export a portable, secret-sanitized workflow. Workspace-scoped bindings must be selected again after import. A workspace whose folder tree exceeds 10,000 folders is a 413, because the response needs the whole tree to render folder paths.",
|
|
"tags": ["Workflows"],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The workflow export payload.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ExportWorkflowResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"413": {
|
|
"$ref": "#/components/responses/PayloadTooLarge"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/workflows/import": {
|
|
"post": {
|
|
"operationId": "importWorkflow",
|
|
"summary": "Import Workflow",
|
|
"description": "Create a workflow from a portable export object, bare state, or JSON string.",
|
|
"tags": ["Workflows"],
|
|
"requestBody": {
|
|
"required": true,
|
|
"description": "Portable workflow data and destination metadata for an import.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ImportWorkflowRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "The imported workflow.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ImportWorkflowResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"409": {
|
|
"$ref": "#/components/responses/Conflict"
|
|
},
|
|
"413": {
|
|
"$ref": "#/components/responses/PayloadTooLarge"
|
|
},
|
|
"423": {
|
|
"$ref": "#/components/responses/Locked"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/workflows/{id}/execute": {
|
|
"post": {
|
|
"operationId": "executeWorkflowV2",
|
|
"summary": "Execute Workflow",
|
|
"description": "Execute a deployed workflow synchronously, asynchronously, or as Server-Sent Events. Public workflows permit anonymous synchronous and streaming execution; asynchronous execution requires an API key. A synchronous run that exceeds its execution timeout returns HTTP 200 with `status: \"failed\"` and `error.code: \"TIMEOUT\"` rather than an HTTP error, so branch on `status`. The optional `X-Run-Id` header is a one-shot uniqueness claim, not an idempotency key: reusing a value returns 409 with `error.details.code: \"RUN_ID_CONFLICT\"` and never replays the earlier run. Option constraints — each is a 400: (1) `async: true` requires an API key; anonymous public-workflow callers may only execute synchronously or as a stream. (2) `async` and `stream` cannot both be true. (3) `executionTimeoutSeconds` is accepted only when `async: true`. (4) `async: true` rejects every streaming and output-shaping option — `selectedOutputs`, `includeThinking`, `includeToolCalls`, `includeFileBase64`, and `base64MaxBytes`. (5) `includeThinking` and `includeToolCalls` require `stream: true`. (6) `includeThinking` and `includeToolCalls` require the `X-Sim-Stream-Protocol: agent-events-v1` request header, which declares that the client understands agent-event frames.",
|
|
"tags": ["Workflows"],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
},
|
|
{}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
}
|
|
},
|
|
{
|
|
"name": "x-run-id",
|
|
"in": "header",
|
|
"required": false,
|
|
"description": "Caller-supplied run identifier, available only to API-key callers. This is a one-shot uniqueness claim, NOT an idempotency key: the first request to use a value starts a run, and any later request reusing it fails with 409 and `error.details.code: \"RUN_ID_CONFLICT\"` instead of replaying the original result. To retry safely, generate a fresh value per attempt and reconcile duplicates yourself, or omit the header and let the server allocate the run identifier.",
|
|
"schema": {
|
|
"description": "Caller-supplied run identifier, available only to API-key callers. This is a one-shot uniqueness claim, NOT an idempotency key: the first request to use a value starts a run, and any later request reusing it fails with 409 and `error.details.code: \"RUN_ID_CONFLICT\"` instead of replaying the original result. To retry safely, generate a fresh value per attempt and reconcile duplicates yourself, or omit the header and let the server allocate the run identifier.",
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 128,
|
|
"pattern": "^[A-Za-z0-9._:-]+$",
|
|
"examples": ["run_8f14e45f-ceea-467f-a"]
|
|
}
|
|
},
|
|
{
|
|
"name": "x-sim-via",
|
|
"in": "header",
|
|
"required": false,
|
|
"description": "Comma-separated workflow identifiers describing the workflow-to-workflow call chain that led to this request. Each hop appends its own workflow id, and Sim sets it automatically when one workflow calls another; supply it yourself only when relaying an existing chain. A chain already at the maximum depth is rejected with 409 and `error.details.code: \"CALL_CHAIN_DEPTH_EXCEEDED\"`, which is how runaway recursion between workflows is stopped.",
|
|
"schema": {
|
|
"description": "Comma-separated workflow identifiers describing the workflow-to-workflow call chain that led to this request. Each hop appends its own workflow id, and Sim sets it automatically when one workflow calls another; supply it yourself only when relaying an existing chain. A chain already at the maximum depth is rejected with 409 and `error.details.code: \"CALL_CHAIN_DEPTH_EXCEEDED\"`, which is how runaway recursion between workflows is stopped.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"description": "Input and execution-mode options for a deployed workflow. Option constraints — each is a 400: (1) `async: true` requires an API key; anonymous public-workflow callers may only execute synchronously or as a stream. (2) `async` and `stream` cannot both be true. (3) `executionTimeoutSeconds` is accepted only when `async: true`. (4) `async: true` rejects every streaming and output-shaping option — `selectedOutputs`, `includeThinking`, `includeToolCalls`, `includeFileBase64`, and `base64MaxBytes`. (5) `includeThinking` and `includeToolCalls` require `stream: true`. (6) `includeThinking` and `includeToolCalls` require the `X-Sim-Stream-Protocol: agent-events-v1` request header, which declares that the client understands agent-event frames.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ExecuteWorkflowRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "A synchronous run result or Server-Sent Event stream.",
|
|
"headers": {
|
|
"X-Run-Id": {
|
|
"$ref": "#/components/headers/X-Run-Id"
|
|
},
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ExecuteWorkflowSyncResponse"
|
|
}
|
|
},
|
|
"text/event-stream": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"202": {
|
|
"description": "The asynchronous run was queued.",
|
|
"headers": {
|
|
"X-Run-Id": {
|
|
"$ref": "#/components/headers/X-Run-Id"
|
|
},
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ExecuteWorkflowQueuedResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"402": {
|
|
"$ref": "#/components/responses/UsageLimitExceeded"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"409": {
|
|
"$ref": "#/components/responses/RunIdConflict"
|
|
},
|
|
"413": {
|
|
"$ref": "#/components/responses/PayloadTooLarge"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"499": {
|
|
"$ref": "#/components/responses/ClientClosedRequest"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/workflows/{id}/runs": {
|
|
"get": {
|
|
"operationId": "listWorkflowRunsV2",
|
|
"summary": "List Workflow Runs",
|
|
"description": "List recorded runs of a workflow with filtering and opaque cursor pagination. Ordering deviates from the v2 `sortBy` + `sortOrder` convention: runs are sortable only by start time, so direction is carried by the single `order` param.",
|
|
"tags": ["Workflow Runs"],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
}
|
|
},
|
|
{
|
|
"name": "status",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Filter by run status.",
|
|
"schema": {
|
|
"description": "Filter by run status.",
|
|
"type": "string",
|
|
"enum": ["pending", "running", "completed", "failed", "cancelled", "paused"]
|
|
}
|
|
},
|
|
{
|
|
"name": "trigger",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Filter by trigger type.",
|
|
"schema": {
|
|
"description": "Filter by trigger type.",
|
|
"type": "string",
|
|
"minLength": 1
|
|
}
|
|
},
|
|
{
|
|
"name": "startDate",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Include runs started at or after this ISO 8601 timestamp.",
|
|
"schema": {
|
|
"description": "Include runs started at or after this ISO 8601 timestamp.",
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
|
|
}
|
|
},
|
|
{
|
|
"name": "endDate",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Include runs started at or before this ISO 8601 timestamp.",
|
|
"schema": {
|
|
"description": "Include runs started at or before this ISO 8601 timestamp.",
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
|
|
}
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Maximum workflow runs to return per page.",
|
|
"schema": {
|
|
"default": 50,
|
|
"description": "Maximum workflow runs to return per page.",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"maximum": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "cursor",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Opaque pagination cursor returned by a previous request.",
|
|
"schema": {
|
|
"description": "Opaque pagination cursor returned by a previous request.",
|
|
"type": "string",
|
|
"minLength": 1
|
|
}
|
|
},
|
|
{
|
|
"name": "order",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Sort direction by run start time. This operation deviates from the v2 `sortBy` + `sortOrder` convention: runs are sortable only by start time, so the direction is carried by this single `order` param and `sortBy`/`sortOrder` are not accepted.",
|
|
"schema": {
|
|
"default": "desc",
|
|
"description": "Sort direction by run start time. This operation deviates from the v2 `sortBy` + `sortOrder` convention: runs are sortable only by start time, so the direction is carried by this single `order` param and `sortBy`/`sortOrder` are not accepted.",
|
|
"type": "string",
|
|
"enum": ["asc", "desc"]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A page of workflow runs.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowRunListResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/workflows/{id}/runs/{runId}": {
|
|
"get": {
|
|
"operationId": "getWorkflowRunV2",
|
|
"summary": "Get Workflow Run",
|
|
"description": "Get current workflow run state, optionally including final and block outputs.",
|
|
"tags": ["Workflow Runs"],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Unique workflow identifier."
|
|
}
|
|
},
|
|
{
|
|
"name": "runId",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow run identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 128,
|
|
"pattern": "^[A-Za-z0-9._:-]+$",
|
|
"description": "Unique workflow run identifier.",
|
|
"examples": ["run_8f14e45f-ceea-467f-a"]
|
|
}
|
|
},
|
|
{
|
|
"name": "includeOutput",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Include final and block outputs when true.",
|
|
"schema": {
|
|
"description": "Include final and block outputs when true.",
|
|
"type": "string",
|
|
"enum": ["true", "false"]
|
|
}
|
|
},
|
|
{
|
|
"name": "selectedOutputs",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Comma-separated block output references to include.",
|
|
"schema": {
|
|
"description": "Comma-separated block output references to include.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The workflow run status.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowRunStatusResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"409": {
|
|
"$ref": "#/components/responses/Conflict"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/workflows/{id}/runs/{runId}/resume": {
|
|
"post": {
|
|
"operationId": "resumeWorkflowRunV2",
|
|
"summary": "Resume Workflow Run",
|
|
"description": "Resume one human-in-the-loop pause context. The resumed attempt receives a new run identifier and may complete synchronously or return a queue receipt.",
|
|
"tags": ["Workflow Runs"],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Unique workflow identifier."
|
|
}
|
|
},
|
|
{
|
|
"name": "runId",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow run identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 128,
|
|
"pattern": "^[A-Za-z0-9._:-]+$",
|
|
"description": "Unique workflow run identifier.",
|
|
"examples": ["run_8f14e45f-ceea-467f-a"]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"description": "Pause context and optional input used to resume a workflow run.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ResumeWorkflowRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "The resumed workflow attempt completed synchronously.",
|
|
"headers": {
|
|
"X-Run-Id": {
|
|
"$ref": "#/components/headers/X-Run-Id"
|
|
},
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ResumeWorkflowSyncResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"202": {
|
|
"description": "The resumed workflow attempt was queued.",
|
|
"headers": {
|
|
"X-Run-Id": {
|
|
"$ref": "#/components/headers/X-Run-Id"
|
|
},
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ResumeWorkflowQueuedResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"402": {
|
|
"$ref": "#/components/responses/UsageLimitExceeded"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"409": {
|
|
"$ref": "#/components/responses/Conflict"
|
|
},
|
|
"413": {
|
|
"$ref": "#/components/responses/PayloadTooLarge"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/workflows/{id}/runs/{runId}/cancel": {
|
|
"post": {
|
|
"operationId": "cancelRunV2",
|
|
"summary": "Cancel Workflow Run",
|
|
"description": "Request cancellation of a running, queued, or paused workflow run. Cancelling a run that has already reached a terminal state succeeds with no effect rather than returning an error. The `reason` field is present on every response, including full successes — `recorded` is the success value; it is not a partial-failure marker. A run produced by a table workflow group is a 409 when its cell can no longer accept the cancellation, because the run and its cell must reach the cancelled state together.",
|
|
"tags": ["Workflow Runs"],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Unique workflow identifier."
|
|
}
|
|
},
|
|
{
|
|
"name": "runId",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique workflow run identifier.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 128,
|
|
"pattern": "^[A-Za-z0-9._:-]+$",
|
|
"description": "Unique workflow run identifier.",
|
|
"examples": ["run_8f14e45f-ceea-467f-a"]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The cancellation outcome.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CancelWorkflowRunResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"409": {
|
|
"$ref": "#/components/responses/Conflict"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/workflows/folders": {
|
|
"get": {
|
|
"operationId": "listWorkflowsFolders",
|
|
"summary": "List Workflow Folders",
|
|
"description": "List canonical workflow folders in a workspace. The bounded set is returned in one page with `nextCursor` always null; there is no second page to fetch.",
|
|
"tags": ["Workflows"],
|
|
"parameters": [
|
|
{
|
|
"name": "workspaceId",
|
|
"in": "query",
|
|
"required": true,
|
|
"description": "Workspace whose folders should be listed.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Workspace whose folders should be listed."
|
|
}
|
|
},
|
|
{
|
|
"name": "parentPath",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Restrict results to direct children of this parent path.",
|
|
"schema": {
|
|
"description": "Restrict results to direct children of this parent path.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "search",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Case-insensitive substring match against the folder name.",
|
|
"schema": {
|
|
"description": "Case-insensitive substring match against the folder name.",
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 200
|
|
}
|
|
},
|
|
{
|
|
"name": "sortBy",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Field used to sort the result.",
|
|
"schema": {
|
|
"default": "name",
|
|
"description": "Field used to sort the result.",
|
|
"type": "string",
|
|
"enum": ["name", "createdAt", "updatedAt"]
|
|
}
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Sort direction.",
|
|
"schema": {
|
|
"default": "asc",
|
|
"description": "Sort direction.",
|
|
"type": "string",
|
|
"enum": ["asc", "desc"]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A list of workflow folders.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowFolderListResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"413": {
|
|
"$ref": "#/components/responses/PayloadTooLarge"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"operationId": "createWorkflowsFolder",
|
|
"summary": "Create Workflow Folder",
|
|
"description": "Create a canonical workflow folder in a workspace.",
|
|
"tags": ["Workflows"],
|
|
"requestBody": {
|
|
"required": true,
|
|
"description": "Workspace and canonical path for a new workflow folder.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateWorkflowFolderRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "The created workflow folder.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateWorkflowFolderResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"409": {
|
|
"$ref": "#/components/responses/Conflict"
|
|
},
|
|
"413": {
|
|
"$ref": "#/components/responses/PayloadTooLarge"
|
|
},
|
|
"423": {
|
|
"$ref": "#/components/responses/Locked"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"operationId": "relocateWorkflowsFolder",
|
|
"summary": "Rename or Move Workflow Folder",
|
|
"description": "Rename or move a workflow folder and its descendants to a canonical path.",
|
|
"tags": ["Workflows"],
|
|
"requestBody": {
|
|
"required": true,
|
|
"description": "Current and destination paths for a workflow folder.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RelocateWorkflowFolderRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "The relocated workflow folder.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RelocateWorkflowFolderResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"409": {
|
|
"$ref": "#/components/responses/Conflict"
|
|
},
|
|
"413": {
|
|
"$ref": "#/components/responses/PayloadTooLarge"
|
|
},
|
|
"423": {
|
|
"$ref": "#/components/responses/Locked"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"operationId": "deleteWorkflowsFolder",
|
|
"summary": "Delete Workflow Folder",
|
|
"description": "Delete a workflow folder, optionally including its descendants and workflows.",
|
|
"tags": ["Workflows"],
|
|
"parameters": [
|
|
{
|
|
"name": "workspaceId",
|
|
"in": "query",
|
|
"required": true,
|
|
"description": "Workspace containing the folder.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Workspace containing the folder."
|
|
}
|
|
},
|
|
{
|
|
"name": "path",
|
|
"in": "query",
|
|
"required": true,
|
|
"description": "Path of the folder to delete.",
|
|
"schema": {
|
|
"description": "Path of the folder to delete.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "recursive",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Delete nested files and folders when true.",
|
|
"schema": {
|
|
"description": "Delete nested files and folders when true.",
|
|
"default": "false",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The workflow folder was deleted.",
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DeleteWorkflowFolderResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/Unauthorized"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/Forbidden"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFound"
|
|
},
|
|
"409": {
|
|
"$ref": "#/components/responses/Conflict"
|
|
},
|
|
"413": {
|
|
"$ref": "#/components/responses/PayloadTooLarge"
|
|
},
|
|
"423": {
|
|
"$ref": "#/components/responses/Locked"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/RateLimited"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalError"
|
|
},
|
|
"503": {
|
|
"$ref": "#/components/responses/ServiceUnavailable"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"securitySchemes": {
|
|
"apiKey": {
|
|
"type": "apiKey",
|
|
"in": "header",
|
|
"name": "X-API-Key",
|
|
"description": "Your Sim API key, personal or workspace-scoped. Generate one from the Sim dashboard under Settings > API Keys. A workspace API key is not accepted everywhere: operations that act on behalf of a specific human — administrative reads, secret access, and irreversible or governance-affecting writes — always reject it, whatever role the key carries. Each such operation says so in its own description, and the rejection surfaces as `403` unless the operation conceals unauthorized resources, in which case it is reported as `404`. Use a personal API key for those."
|
|
}
|
|
},
|
|
"headers": {
|
|
"X-RateLimit-Limit": {
|
|
"description": "Maximum requests allowed in the current window.",
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"title": "Rate limit",
|
|
"description": "Maximum requests allowed in the current window."
|
|
}
|
|
},
|
|
"X-RateLimit-Remaining": {
|
|
"description": "Requests remaining in the current window.",
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"title": "Rate limit remaining",
|
|
"description": "Requests remaining in the current window."
|
|
}
|
|
},
|
|
"X-RateLimit-Reset": {
|
|
"description": "ISO 8601 timestamp when the current rate-limit window resets.",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"title": "Rate limit reset",
|
|
"description": "ISO 8601 timestamp when the current rate-limit window resets."
|
|
}
|
|
},
|
|
"Retry-After": {
|
|
"description": "Seconds to wait before retrying a rate-limited request.",
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"title": "Retry after",
|
|
"description": "Seconds to wait before retrying a rate-limited request."
|
|
}
|
|
},
|
|
"X-Run-Id": {
|
|
"description": "Identifier assigned to the workflow run.",
|
|
"schema": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"title": "Run identifier",
|
|
"description": "Identifier assigned to the workflow run."
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"BadRequest": {
|
|
"description": "The request is invalid.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Unauthorized": {
|
|
"description": "The API key is missing or invalid.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"UsageLimitExceeded": {
|
|
"description": "The workspace has exceeded its usage or billing limits.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Forbidden": {
|
|
"description": "The caller lacks access to the resource.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"NotFound": {
|
|
"description": "The requested resource was not found.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Conflict": {
|
|
"description": "The request conflicts with current resource state.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"RunIdConflict": {
|
|
"description": "The run cannot be started. Two causes share this status, distinguished by `error.details.code`: `RUN_ID_CONFLICT` when the supplied `X-Run-Id` is already associated with a different request, and `CALL_CHAIN_DEPTH_EXCEEDED` when the incoming `X-Sim-Via` chain has already reached the maximum workflow-to-workflow call depth.",
|
|
"headers": {
|
|
"X-Run-Id": {
|
|
"$ref": "#/components/headers/X-Run-Id"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Gone": {
|
|
"description": "The requested generated resource has expired.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PayloadTooLarge": {
|
|
"description": "The request, or a resource collection it must materialize, exceeds the allowed size. Besides an oversized request body, this covers a generated artifact that renders past the download ceiling and a workspace folder tree too large to load in full.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"UnsupportedMediaType": {
|
|
"description": "The request uses an unsupported media type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Locked": {
|
|
"description": "The resource is locked and cannot be modified.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"RateLimited": {
|
|
"description": "The caller exceeded the request rate limit.",
|
|
"headers": {
|
|
"Retry-After": {
|
|
"$ref": "#/components/headers/Retry-After"
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"ClientClosedRequest": {
|
|
"description": "The client closed the connection before the response was produced.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"InternalError": {
|
|
"description": "An unexpected server error occurred.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"ServiceUnavailable": {
|
|
"description": "A required service is temporarily unavailable.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/V2Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"schemas": {
|
|
"V2Error": {
|
|
"type": "object",
|
|
"properties": {
|
|
"error": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"description": "Stable machine-readable error code."
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"description": "Human-readable explanation of the error."
|
|
},
|
|
"details": {
|
|
"description": "Optional structured error details."
|
|
}
|
|
},
|
|
"required": ["code", "message"],
|
|
"additionalProperties": false,
|
|
"description": "Canonical error details."
|
|
}
|
|
},
|
|
"required": ["error"],
|
|
"additionalProperties": false,
|
|
"title": "v2 error response",
|
|
"description": "Canonical error envelope returned by the public v2 API.",
|
|
"examples": [
|
|
{
|
|
"error": {
|
|
"code": "BAD_REQUEST",
|
|
"message": "The request is invalid."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"WorkflowListItem": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Workflow name.",
|
|
"examples": ["Customer support triage"]
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow description, or null when none is set."
|
|
},
|
|
"folderPath": {
|
|
"type": "string",
|
|
"description": "Canonical containing-folder path; `/` is the workspace root.",
|
|
"examples": ["/Operations"]
|
|
},
|
|
"workspaceId": {
|
|
"type": "string",
|
|
"description": "Workspace that owns the workflow."
|
|
},
|
|
"isDeployed": {
|
|
"type": "boolean",
|
|
"description": "Whether the workflow has an active deployment."
|
|
},
|
|
"deployedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "ISO 8601 activation timestamp, or null when not deployed.",
|
|
"format": "date-time"
|
|
},
|
|
"runCount": {
|
|
"type": "integer",
|
|
"minimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"description": "Total recorded workflow runs."
|
|
},
|
|
"lastRunAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "ISO 8601 timestamp of the latest run, or null when never run.",
|
|
"format": "date-time"
|
|
},
|
|
"createdAt": {
|
|
"type": "string",
|
|
"description": "ISO 8601 timestamp when the workflow was created.",
|
|
"format": "date-time"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string",
|
|
"description": "ISO 8601 timestamp when the workflow was last updated.",
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"description",
|
|
"folderPath",
|
|
"workspaceId",
|
|
"isDeployed",
|
|
"deployedAt",
|
|
"runCount",
|
|
"lastRunAt",
|
|
"createdAt",
|
|
"updatedAt"
|
|
],
|
|
"additionalProperties": false,
|
|
"title": "Workflow summary",
|
|
"description": "Summary of a workflow and its deployment and run state."
|
|
},
|
|
"WorkflowListResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/WorkflowListItem"
|
|
},
|
|
"description": "Items in the current page."
|
|
},
|
|
"nextCursor": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Opaque cursor for the next page: send it back as `cursor` to continue, and stop when it is null. Most v2 lists page, so null means the last page was reached. A few are full-set lists that return their whole bounded result in one response and therefore always report null; those say so in the operation description. Either way, null means there is nothing further to fetch — never construct a cursor yourself."
|
|
}
|
|
},
|
|
"required": ["data", "nextCursor"],
|
|
"additionalProperties": false,
|
|
"title": "Workflow list response",
|
|
"description": "A cursor-paginated page of workflow summaries.",
|
|
"examples": [
|
|
{
|
|
"data": [
|
|
{
|
|
"id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
|
|
"name": "Customer support triage",
|
|
"description": "Routes incoming support requests to the right team.",
|
|
"folderPath": "/Operations",
|
|
"workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",
|
|
"isDeployed": true,
|
|
"deployedAt": "2026-06-12T10:30:00.000Z",
|
|
"runCount": 42,
|
|
"lastRunAt": "2026-08-09T18:04:11.000Z",
|
|
"createdAt": "2026-05-01T09:00:00.000Z",
|
|
"updatedAt": "2026-08-09T18:04:11.000Z"
|
|
}
|
|
],
|
|
"nextCursor": null
|
|
}
|
|
]
|
|
},
|
|
"CreateWorkflowResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/WorkflowListItem"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Create workflow response",
|
|
"description": "The created workflow summary.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
|
|
"name": "Customer support triage",
|
|
"description": "Routes incoming support requests to the right team.",
|
|
"folderPath": "/Operations",
|
|
"workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",
|
|
"isDeployed": true,
|
|
"deployedAt": "2026-06-12T10:30:00.000Z",
|
|
"runCount": 42,
|
|
"lastRunAt": "2026-08-09T18:04:11.000Z",
|
|
"createdAt": "2026-05-01T09:00:00.000Z",
|
|
"updatedAt": "2026-08-09T18:04:11.000Z"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"CreateWorkflowRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"workspaceId": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Workspace in which to create the workflow."
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 255,
|
|
"description": "Workflow name."
|
|
},
|
|
"description": {
|
|
"description": "Optional workflow description.",
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"maxLength": 50000
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"folderPath": {
|
|
"description": "Folder path. A missing leading slash is normalized before validation.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["workspaceId", "name"],
|
|
"additionalProperties": false,
|
|
"title": "Create workflow request",
|
|
"description": "Name, description, workspace, and optional folder for a new workflow."
|
|
},
|
|
"WorkflowInputField": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Input field name."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "Input field type."
|
|
},
|
|
"description": {
|
|
"description": "Optional input field description.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["name", "type"],
|
|
"additionalProperties": false,
|
|
"title": "Workflow input field",
|
|
"description": "A deployed API trigger input exposed by a workflow."
|
|
},
|
|
"WorkflowDetail": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Workflow name.",
|
|
"examples": ["Customer support triage"]
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow description, or null when none is set."
|
|
},
|
|
"folderPath": {
|
|
"type": "string",
|
|
"description": "Canonical containing-folder path; `/` is the workspace root.",
|
|
"examples": ["/Operations"]
|
|
},
|
|
"workspaceId": {
|
|
"type": "string",
|
|
"description": "Workspace that owns the workflow."
|
|
},
|
|
"isDeployed": {
|
|
"type": "boolean",
|
|
"description": "Whether the workflow has an active deployment."
|
|
},
|
|
"deployedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "ISO 8601 activation timestamp, or null when not deployed.",
|
|
"format": "date-time"
|
|
},
|
|
"runCount": {
|
|
"type": "integer",
|
|
"minimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"description": "Total recorded workflow runs."
|
|
},
|
|
"lastRunAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "ISO 8601 timestamp of the latest run, or null when never run.",
|
|
"format": "date-time"
|
|
},
|
|
"createdAt": {
|
|
"type": "string",
|
|
"description": "ISO 8601 timestamp when the workflow was created.",
|
|
"format": "date-time"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string",
|
|
"description": "ISO 8601 timestamp when the workflow was last updated.",
|
|
"format": "date-time"
|
|
},
|
|
"variables": {
|
|
"type": "object",
|
|
"propertyNames": {
|
|
"type": "string"
|
|
},
|
|
"additionalProperties": {
|
|
"description": "Structured workflow variable value."
|
|
},
|
|
"description": "Workflow-scoped variables keyed by variable identifier."
|
|
},
|
|
"inputs": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/WorkflowInputField"
|
|
},
|
|
"description": "Input fields exposed by the workflow API trigger."
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"description",
|
|
"folderPath",
|
|
"workspaceId",
|
|
"isDeployed",
|
|
"deployedAt",
|
|
"runCount",
|
|
"lastRunAt",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"variables",
|
|
"inputs"
|
|
],
|
|
"additionalProperties": false,
|
|
"title": "Workflow detail",
|
|
"description": "Full workflow summary with variables and API-trigger input fields."
|
|
},
|
|
"WorkflowDetailResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/WorkflowDetail"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Workflow detail response",
|
|
"description": "Detailed workflow metadata, variables, and trigger inputs.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
|
|
"name": "Customer support triage",
|
|
"description": "Routes incoming support requests to the right team.",
|
|
"folderPath": "/Operations",
|
|
"workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",
|
|
"isDeployed": true,
|
|
"deployedAt": "2026-06-12T10:30:00.000Z",
|
|
"runCount": 42,
|
|
"lastRunAt": "2026-08-09T18:04:11.000Z",
|
|
"createdAt": "2026-05-01T09:00:00.000Z",
|
|
"updatedAt": "2026-08-09T18:04:11.000Z",
|
|
"variables": {},
|
|
"inputs": []
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"UpdateWorkflowResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/WorkflowListItem"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Update workflow response",
|
|
"description": "The updated workflow summary.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
|
|
"name": "Customer support triage",
|
|
"description": "Routes incoming support requests to the right team.",
|
|
"folderPath": "/Operations",
|
|
"workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",
|
|
"isDeployed": true,
|
|
"deployedAt": "2026-06-12T10:30:00.000Z",
|
|
"runCount": 42,
|
|
"lastRunAt": "2026-08-09T18:04:11.000Z",
|
|
"createdAt": "2026-05-01T09:00:00.000Z",
|
|
"updatedAt": "2026-08-09T18:04:11.000Z"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"UpdateWorkflowRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Replacement workflow name.",
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 255
|
|
},
|
|
"description": {
|
|
"description": "Replacement workflow description; null clears it.",
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"maxLength": 50000
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"folderPath": {
|
|
"description": "Destination folder path; `/` moves the workflow to the workspace root.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"title": "Update workflow request",
|
|
"description": "Fields to update on an existing workflow."
|
|
},
|
|
"DeleteWorkflowResult": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Identifier of the deleted workflow."
|
|
},
|
|
"deleted": {
|
|
"type": "boolean",
|
|
"const": true,
|
|
"description": "Confirms that the workflow was deleted."
|
|
}
|
|
},
|
|
"required": ["id", "deleted"],
|
|
"additionalProperties": false,
|
|
"title": "Delete workflow result",
|
|
"description": "Confirmation that a workflow was deleted."
|
|
},
|
|
"DeleteWorkflowResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/DeleteWorkflowResult"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Delete workflow response",
|
|
"description": "Confirmation that the workflow was deleted.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
|
|
"deleted": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"WorkflowVersion": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Unique deployment-version identifier."
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"description": "Monotonically increasing deployment version number."
|
|
},
|
|
"name": {
|
|
"description": "Optional deployment-version label.",
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Optional deployment-version release note.",
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"description": "Whether this version is currently serving executions."
|
|
},
|
|
"createdAt": {
|
|
"type": "string",
|
|
"description": "ISO 8601 timestamp when this version was created.",
|
|
"format": "date-time"
|
|
},
|
|
"deployedBy": {
|
|
"description": "Display name of the user who created the deployment, when available.",
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"latestOperationStatus": {
|
|
"description": "Latest lifecycle-operation status for this version.",
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": ["preparing", "activating", "active", "failed", "superseded"]
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": ["id", "version", "isActive", "createdAt"],
|
|
"additionalProperties": false,
|
|
"title": "Workflow version",
|
|
"description": "A saved deployment version of a workflow."
|
|
},
|
|
"WorkflowVersionListResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/WorkflowVersion"
|
|
},
|
|
"description": "Items in the current page."
|
|
},
|
|
"nextCursor": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Opaque cursor for the next page: send it back as `cursor` to continue, and stop when it is null. Most v2 lists page, so null means the last page was reached. A few are full-set lists that return their whole bounded result in one response and therefore always report null; those say so in the operation description. Either way, null means there is nothing further to fetch — never construct a cursor yourself."
|
|
}
|
|
},
|
|
"required": ["data", "nextCursor"],
|
|
"additionalProperties": false,
|
|
"title": "Workflow version list response",
|
|
"description": "A cursor-paginated page of deployment versions.",
|
|
"examples": [
|
|
{
|
|
"data": [
|
|
{
|
|
"id": "version_3",
|
|
"version": 3,
|
|
"name": "Escalation routing",
|
|
"description": "Adds the priority escalation branch.",
|
|
"isActive": true,
|
|
"createdAt": "2026-06-12T10:30:00.000Z",
|
|
"deployedBy": "Jane Smith",
|
|
"latestOperationStatus": "active"
|
|
}
|
|
],
|
|
"nextCursor": null
|
|
}
|
|
]
|
|
},
|
|
"DeployedWorkflowState": {
|
|
"title": "Deployed workflow state",
|
|
"description": "Workflow graph snapshot pinned by a deployment version.",
|
|
"type": "object",
|
|
"additionalProperties": true
|
|
},
|
|
"WorkflowVersionDetail": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Unique deployment-version identifier."
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"description": "Monotonically increasing deployment version number."
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Version label, or null when unset."
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Version release note, or null when unset."
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"description": "Whether this version is currently serving executions."
|
|
},
|
|
"createdAt": {
|
|
"type": "string",
|
|
"description": "ISO 8601 timestamp when this version was created.",
|
|
"format": "date-time"
|
|
},
|
|
"state": {
|
|
"description": "Deployed workflow graph snapshot pinned by this version.",
|
|
"$ref": "#/components/schemas/DeployedWorkflowState"
|
|
}
|
|
},
|
|
"required": ["id", "version", "name", "description", "isActive", "createdAt", "state"],
|
|
"additionalProperties": false,
|
|
"title": "Workflow version detail",
|
|
"description": "A deployment version together with the workflow state it pins."
|
|
},
|
|
"WorkflowVersionDetailResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/WorkflowVersionDetail"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Workflow version detail response",
|
|
"description": "The deployment version and its pinned workflow graph.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"id": "version_3",
|
|
"version": 3,
|
|
"name": "Escalation routing",
|
|
"description": "Adds the priority escalation branch.",
|
|
"isActive": true,
|
|
"createdAt": "2026-06-12T10:30:00.000Z",
|
|
"state": {
|
|
"blocks": {},
|
|
"edges": []
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"ActiveDeploymentSummary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"deploymentVersionId": {
|
|
"type": "string",
|
|
"description": "Identifier of the active deployment version."
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"description": "Numeric active deployment version."
|
|
},
|
|
"deployedAt": {
|
|
"type": "string",
|
|
"description": "ISO 8601 timestamp when this version became active.",
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
"required": ["deploymentVersionId", "version", "deployedAt"],
|
|
"additionalProperties": false,
|
|
"title": "Active deployment",
|
|
"description": "Summary of the workflow version currently serving API executions."
|
|
},
|
|
"DeploymentOperationSummary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Unique deployment operation identifier."
|
|
},
|
|
"deploymentVersionId": {
|
|
"type": "string",
|
|
"description": "Deployment version targeted by this operation."
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"description": "Numeric deployment version."
|
|
},
|
|
"action": {
|
|
"type": "string",
|
|
"enum": ["deploy", "activate"],
|
|
"description": "Operation being performed on the deployment version."
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"enum": ["preparing", "activating", "active", "failed", "superseded"],
|
|
"description": "Current deployment lifecycle status."
|
|
},
|
|
"isCurrent": {
|
|
"default": true,
|
|
"description": "Whether this operation still describes the current deployment attempt.",
|
|
"type": "boolean"
|
|
},
|
|
"readiness": {
|
|
"$ref": "#/components/schemas/DeploymentReadiness"
|
|
},
|
|
"requestedAt": {
|
|
"type": "string",
|
|
"description": "ISO 8601 timestamp when the deployment operation was requested.",
|
|
"format": "date-time"
|
|
},
|
|
"activatedAt": {
|
|
"description": "ISO 8601 activation timestamp, or null before activation completes.",
|
|
"format": "date-time",
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"error": {
|
|
"description": "Deployment failure details, or null when no failure occurred.",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DeploymentOperationError"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"deploymentVersionId",
|
|
"version",
|
|
"action",
|
|
"status",
|
|
"isCurrent",
|
|
"readiness",
|
|
"requestedAt"
|
|
],
|
|
"additionalProperties": false,
|
|
"title": "Deployment operation",
|
|
"description": "Lifecycle state of a deployment or version-activation attempt."
|
|
},
|
|
"DeploymentReadiness": {
|
|
"type": "object",
|
|
"properties": {
|
|
"webhooks": {
|
|
"type": "string",
|
|
"enum": ["pending", "ready", "not_applicable"],
|
|
"description": "Webhook synchronization readiness."
|
|
},
|
|
"schedules": {
|
|
"type": "string",
|
|
"enum": ["pending", "ready", "not_applicable"],
|
|
"description": "Schedule synchronization readiness."
|
|
},
|
|
"mcp": {
|
|
"type": "string",
|
|
"enum": ["pending", "ready", "not_applicable"],
|
|
"description": "MCP synchronization readiness."
|
|
}
|
|
},
|
|
"required": ["webhooks", "schedules", "mcp"],
|
|
"additionalProperties": false,
|
|
"title": "Deployment readiness",
|
|
"description": "Readiness of the side effects required to activate a deployment."
|
|
},
|
|
"DeploymentOperationError": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"description": "Stable deployment failure code."
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"description": "Human-readable deployment failure message."
|
|
},
|
|
"retryable": {
|
|
"type": "boolean",
|
|
"description": "Whether retrying the deployment may succeed."
|
|
}
|
|
},
|
|
"required": ["code", "message", "retryable"],
|
|
"additionalProperties": false,
|
|
"title": "Deployment operation error",
|
|
"description": "Failure details for a deployment lifecycle operation."
|
|
},
|
|
"DeployResult": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
},
|
|
"isDeployed": {
|
|
"type": "boolean",
|
|
"description": "Whether a workflow version is currently live and available for API execution."
|
|
},
|
|
"deployedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "ISO 8601 timestamp associated with the deployment, or null when unavailable.",
|
|
"format": "date-time",
|
|
"examples": ["2026-06-12T10:30:00.000Z"]
|
|
},
|
|
"warnings": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Non-fatal synchronization warnings. Empty when there is nothing to report."
|
|
},
|
|
"activeDeployment": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ActiveDeploymentSummary"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Currently live deployment version, or null while no version is active."
|
|
},
|
|
"latestDeploymentAttempt": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DeploymentOperationSummary"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Most recent deployment lifecycle attempt, or null when none is available."
|
|
},
|
|
"version": {
|
|
"description": "Deployment version created for this attempt, when available.",
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"isDeployed",
|
|
"deployedAt",
|
|
"warnings",
|
|
"activeDeployment",
|
|
"latestDeploymentAttempt"
|
|
],
|
|
"additionalProperties": false,
|
|
"title": "Deploy result",
|
|
"description": "Deployment attempt accepted for processing. Activation is asynchronous; `latestDeploymentAttempt` on this response is the attempt handle. The request is NOT idempotent — every POST mints a new deployment version, so a retry after a timeout creates a second version rather than returning the first. `latestDeploymentAttempt` is returned only here: `GET /workflows/{id}` does not carry it, so poll activation with `isDeployed` and `deployedAt` on the workflow, or with `isActive` on `GET /workflows/{id}/versions`."
|
|
},
|
|
"DeployWorkflowResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/DeployResult"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Deploy workflow response",
|
|
"description": "Current deployment state after accepting the attempt.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
|
|
"isDeployed": false,
|
|
"deployedAt": null,
|
|
"warnings": [],
|
|
"activeDeployment": null,
|
|
"latestDeploymentAttempt": {
|
|
"id": "depop_01J8ZK3QW4M6X2R9T7B5C0V1",
|
|
"deploymentVersionId": "depver_01J8ZK3QW4M6X2R9T7B5C0V2",
|
|
"version": 3,
|
|
"action": "deploy",
|
|
"status": "preparing",
|
|
"isCurrent": true,
|
|
"readiness": {
|
|
"webhooks": "pending",
|
|
"schedules": "ready",
|
|
"mcp": "not_applicable"
|
|
},
|
|
"requestedAt": "2026-06-12T10:30:00.000Z",
|
|
"activatedAt": null,
|
|
"error": null
|
|
},
|
|
"version": 3
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"DeployWorkflowRequest": {
|
|
"default": {},
|
|
"title": "Deploy workflow request",
|
|
"description": "Optional metadata for the new deployment version.",
|
|
"examples": [
|
|
{
|
|
"name": "Escalation routing",
|
|
"description": "Adds the priority escalation branch."
|
|
}
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Optional label for the deployment version.",
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 100
|
|
},
|
|
"description": {
|
|
"description": "Optional release note for the deployment version.",
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"maxLength": 50000
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"UndeployResult": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
},
|
|
"isDeployed": {
|
|
"type": "boolean",
|
|
"description": "Whether a workflow version is currently live and available for API execution."
|
|
},
|
|
"deployedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "ISO 8601 timestamp associated with the deployment, or null when unavailable.",
|
|
"format": "date-time",
|
|
"examples": ["2026-06-12T10:30:00.000Z"]
|
|
},
|
|
"warnings": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Non-fatal synchronization warnings. Empty when there is nothing to report."
|
|
},
|
|
"activeDeployment": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ActiveDeploymentSummary"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Currently live deployment version, or null while no version is active."
|
|
},
|
|
"latestDeploymentAttempt": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DeploymentOperationSummary"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Most recent deployment lifecycle attempt, or null when none is available."
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"isDeployed",
|
|
"deployedAt",
|
|
"warnings",
|
|
"activeDeployment",
|
|
"latestDeploymentAttempt"
|
|
],
|
|
"additionalProperties": false,
|
|
"title": "Undeploy result",
|
|
"description": "Deployment state after a successful undeploy. `isDeployed` is false and no workflow version is active."
|
|
},
|
|
"UndeployWorkflowResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/UndeployResult"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Undeploy workflow response",
|
|
"description": "Deployment state after deactivating the active version.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
|
|
"isDeployed": false,
|
|
"deployedAt": null,
|
|
"warnings": [],
|
|
"activeDeployment": null,
|
|
"latestDeploymentAttempt": null
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"RollbackResult": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Unique workflow identifier.",
|
|
"examples": ["3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36"]
|
|
},
|
|
"isDeployed": {
|
|
"type": "boolean",
|
|
"description": "Whether a workflow version is currently live and available for API execution."
|
|
},
|
|
"deployedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "ISO 8601 timestamp associated with the deployment, or null when unavailable.",
|
|
"format": "date-time",
|
|
"examples": ["2026-06-12T10:30:00.000Z"]
|
|
},
|
|
"warnings": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Non-fatal synchronization warnings. Empty when there is nothing to report."
|
|
},
|
|
"activeDeployment": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ActiveDeploymentSummary"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Currently live deployment version, or null while no version is active."
|
|
},
|
|
"latestDeploymentAttempt": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DeploymentOperationSummary"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Most recent deployment lifecycle attempt, or null when none is available."
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"description": "Deployment version selected for re-activation."
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"isDeployed",
|
|
"deployedAt",
|
|
"warnings",
|
|
"activeDeployment",
|
|
"latestDeploymentAttempt",
|
|
"version"
|
|
],
|
|
"additionalProperties": false,
|
|
"title": "Rollback result",
|
|
"description": "Rollback attempt accepted for processing. Activation is asynchronous; inspect `isDeployed` and `latestDeploymentAttempt` for current state."
|
|
},
|
|
"RollbackWorkflowResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/RollbackResult"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Rollback workflow response",
|
|
"description": "Current deployment state after accepting the rollback attempt.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
|
|
"isDeployed": false,
|
|
"deployedAt": null,
|
|
"warnings": [],
|
|
"activeDeployment": null,
|
|
"latestDeploymentAttempt": {
|
|
"id": "depop_01J8ZK4RX5N7Y3S0U8D6E1W2",
|
|
"deploymentVersionId": "depver_01J8ZK4RX5N7Y3S0U8D6E1W3",
|
|
"version": 2,
|
|
"action": "activate",
|
|
"status": "activating",
|
|
"isCurrent": true,
|
|
"readiness": {
|
|
"webhooks": "ready",
|
|
"schedules": "ready",
|
|
"mcp": "not_applicable"
|
|
},
|
|
"requestedAt": "2026-06-12T10:30:00.000Z",
|
|
"activatedAt": null,
|
|
"error": null
|
|
},
|
|
"version": 2
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"RollbackWorkflowRequest": {
|
|
"default": {},
|
|
"title": "Rollback workflow request",
|
|
"description": "Optional deployment version to reactivate.",
|
|
"examples": [
|
|
{
|
|
"version": 2
|
|
}
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"description": "Deployment version to reactivate. Omit to select the previous active version.",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"maximum": 2147483647
|
|
}
|
|
}
|
|
},
|
|
"WorkflowExportPayload": {
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "string",
|
|
"const": "1.0",
|
|
"description": "Workflow export format version."
|
|
},
|
|
"exportedAt": {
|
|
"type": "string",
|
|
"description": "ISO 8601 timestamp when the export was created.",
|
|
"format": "date-time"
|
|
},
|
|
"workflow": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Identifier of the source workflow."
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Name of the exported workflow."
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Description of the exported workflow, or null when unset."
|
|
},
|
|
"workspaceId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Identifier of the source workspace, or null for legacy exports."
|
|
},
|
|
"folderPath": {
|
|
"type": "string",
|
|
"description": "Canonical containing-folder path; `/` is the workspace root."
|
|
}
|
|
},
|
|
"required": ["id", "name", "description", "workspaceId", "folderPath"],
|
|
"additionalProperties": false,
|
|
"description": "Source workflow metadata."
|
|
},
|
|
"state": {
|
|
"type": "object",
|
|
"additionalProperties": true,
|
|
"description": "Secret-sanitized workflow graph, edges, loops, parallels, metadata, and variables."
|
|
}
|
|
},
|
|
"required": ["version", "exportedAt", "workflow", "state"],
|
|
"additionalProperties": false,
|
|
"title": "Workflow export payload",
|
|
"description": "Portable, secret-sanitized workflow export. Workspace-scoped bindings must be selected again after import."
|
|
},
|
|
"ExportWorkflowResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/WorkflowExportPayload"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Export workflow response",
|
|
"description": "Portable, secret-sanitized workflow data.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"version": "1.0",
|
|
"exportedAt": "2026-08-09T18:04:11.000Z",
|
|
"workflow": {
|
|
"id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
|
|
"name": "Customer support triage",
|
|
"description": "Routes incoming support requests to the right team.",
|
|
"workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",
|
|
"folderPath": "/Operations"
|
|
},
|
|
"state": {
|
|
"blocks": {},
|
|
"edges": []
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"ImportedWorkflow": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Identifier of the imported workflow."
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Imported workflow name."
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Imported workflow description."
|
|
},
|
|
"workspaceId": {
|
|
"type": "string",
|
|
"description": "Workspace that owns the imported workflow."
|
|
},
|
|
"folderPath": {
|
|
"type": "string",
|
|
"description": "Canonical containing-folder path."
|
|
},
|
|
"createdAt": {
|
|
"type": "string",
|
|
"description": "ISO 8601 timestamp when the workflow was imported.",
|
|
"format": "date-time"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string",
|
|
"description": "ISO 8601 timestamp when the workflow was last updated.",
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"description",
|
|
"workspaceId",
|
|
"folderPath",
|
|
"createdAt",
|
|
"updatedAt"
|
|
],
|
|
"additionalProperties": false,
|
|
"title": "Imported workflow",
|
|
"description": "Workflow created by an import operation."
|
|
},
|
|
"ImportWorkflowResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/ImportedWorkflow"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Import workflow response",
|
|
"description": "The workflow created by the import.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
|
|
"name": "Customer support triage",
|
|
"description": "Routes incoming support requests to the right team.",
|
|
"workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",
|
|
"folderPath": "/Operations",
|
|
"createdAt": "2026-05-01T09:00:00.000Z",
|
|
"updatedAt": "2026-08-09T18:04:11.000Z"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"ImportWorkflowRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"workspaceId": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Workspace in which to import the workflow."
|
|
},
|
|
"workflow": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "JSON string containing a workflow export object or bare workflow state."
|
|
},
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": true,
|
|
"description": "Workflow export object or bare workflow state."
|
|
}
|
|
],
|
|
"description": "Workflow export object, bare workflow state, or JSON string containing either form."
|
|
},
|
|
"folderPath": {
|
|
"description": "Destination folder path; omit for the workspace root.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Override for the imported workflow name.",
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 200
|
|
},
|
|
"description": {
|
|
"description": "Override for the imported workflow description.",
|
|
"type": "string",
|
|
"maxLength": 2000
|
|
}
|
|
},
|
|
"required": ["workspaceId", "workflow"],
|
|
"additionalProperties": false,
|
|
"title": "Import workflow request",
|
|
"description": "Portable workflow data and destination metadata for an import."
|
|
},
|
|
"ExecutionError": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string",
|
|
"description": "Human-readable workflow execution failure message."
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"enum": [
|
|
"TIMEOUT",
|
|
"CANCELLED",
|
|
"USAGE_LIMIT_EXCEEDED",
|
|
"INVALID_INPUT",
|
|
"BLOCK_EXECUTION_FAILED",
|
|
"CHILD_WORKFLOW_FAILED",
|
|
"OUTPUT_TOO_LARGE",
|
|
"EXECUTION_FAILED"
|
|
],
|
|
"description": "Stable machine-readable execution failure code."
|
|
},
|
|
"blockId": {
|
|
"description": "Identifier of the failing block, when attributable.",
|
|
"type": "string"
|
|
},
|
|
"blockName": {
|
|
"description": "Display name of the failing block.",
|
|
"type": "string"
|
|
},
|
|
"blockType": {
|
|
"description": "Integration or block type that failed.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["message", "code"],
|
|
"additionalProperties": false,
|
|
"title": "Execution error",
|
|
"description": "Structured in-band failure details for a workflow run."
|
|
},
|
|
"WorkflowRunResult": {
|
|
"type": "object",
|
|
"properties": {
|
|
"runId": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 128,
|
|
"pattern": "^[A-Za-z0-9._:-]+$",
|
|
"description": "Unique workflow run identifier.",
|
|
"examples": ["run_8f14e45f-ceea-467f-a"]
|
|
},
|
|
"workflowId": {
|
|
"type": "string",
|
|
"description": "Workflow that produced the run."
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"enum": ["completed", "failed", "paused", "cancelled"],
|
|
"description": "Terminal or paused run status."
|
|
},
|
|
"output": {
|
|
"description": "Workflow output, including partial output on failure."
|
|
},
|
|
"error": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ExecutionError"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Structured execution failure, or null when none occurred."
|
|
},
|
|
"startedAt": {
|
|
"description": "ISO 8601 timestamp when execution started.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"endedAt": {
|
|
"description": "ISO 8601 timestamp when execution ended.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"durationMs": {
|
|
"description": "Execution duration in milliseconds.",
|
|
"type": "number",
|
|
"minimum": 0
|
|
}
|
|
},
|
|
"required": ["runId", "workflowId", "status", "output", "error"],
|
|
"additionalProperties": false,
|
|
"title": "Workflow run result",
|
|
"description": "Synchronous workflow run output and in-band execution status. Run failures are reported in band, not as HTTP errors — a synchronous run that exceeds its execution timeout returns HTTP 200 with `status: \"failed\"` and `error.code: \"TIMEOUT\"`, so always branch on `status` rather than on the HTTP status alone."
|
|
},
|
|
"ExecuteWorkflowSyncResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/WorkflowRunResult"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Synchronous workflow execution response",
|
|
"description": "Completed, failed, paused, or cancelled synchronous workflow run.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"runId": "run_8f14e45f-ceea-467f-a",
|
|
"workflowId": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
|
|
"status": "completed",
|
|
"output": {
|
|
"result": "Ticket routed to Support"
|
|
},
|
|
"error": null,
|
|
"startedAt": "2026-08-09T18:04:10.000Z",
|
|
"endedAt": "2026-08-09T18:04:11.000Z",
|
|
"durationMs": 1000
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"QueuedWorkflowRun": {
|
|
"type": "object",
|
|
"properties": {
|
|
"runId": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 128,
|
|
"pattern": "^[A-Za-z0-9._:-]+$",
|
|
"description": "Unique workflow run identifier.",
|
|
"examples": ["run_8f14e45f-ceea-467f-a"]
|
|
},
|
|
"statusUrl": {
|
|
"type": "string",
|
|
"format": "uri",
|
|
"description": "Absolute URL of the workflow run resource."
|
|
}
|
|
},
|
|
"required": ["runId", "statusUrl"],
|
|
"additionalProperties": false,
|
|
"title": "Queued workflow run",
|
|
"description": "Receipt returned when a workflow run is queued."
|
|
},
|
|
"ExecuteWorkflowQueuedResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/QueuedWorkflowRun"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Queued workflow execution response",
|
|
"description": "Receipt returned for an asynchronous workflow run.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"runId": "run_8f14e45f-ceea-467f-a",
|
|
"statusUrl": "https://www.sim.ai/api/v2/workflows/3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36/runs/run_8f14e45f-ceea-467f-a"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"ExecuteWorkflowRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"input": {
|
|
"description": "Workflow input keyed by deployed trigger input-field name.",
|
|
"type": "object",
|
|
"propertyNames": {
|
|
"type": "string"
|
|
},
|
|
"additionalProperties": {
|
|
"description": "Value supplied for one workflow input field."
|
|
}
|
|
},
|
|
"async": {
|
|
"default": false,
|
|
"description": "Queue the run and return a 202 receipt when true. Requires an API key, cannot be combined with `stream`, and rejects all streaming and output-shaping options (`selectedOutputs`, `includeThinking`, `includeToolCalls`, `includeFileBase64`, `base64MaxBytes`).",
|
|
"type": "boolean"
|
|
},
|
|
"executionTimeoutSeconds": {
|
|
"description": "Requested server-side timeout for an asynchronous run, in seconds. This is an upper bound on the request, not the effective timeout: the run uses the smaller of this value and the account plan's execution timeout, so requesting more than the plan allows silently yields the plan timeout with no warning. Rejected with 400 unless `async` is true.",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"maximum": 604800
|
|
},
|
|
"stream": {
|
|
"default": false,
|
|
"description": "Return Server-Sent Events instead of JSON when true. Cannot be combined with `async`.",
|
|
"type": "boolean"
|
|
},
|
|
"selectedOutputs": {
|
|
"description": "Block output references to include in a streamed response. Rejected when `async` is true.",
|
|
"maxItems": 100,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
}
|
|
},
|
|
"includeThinking": {
|
|
"default": false,
|
|
"description": "Include model reasoning events in an agent-event stream. Requires `stream: true` and the `X-Sim-Stream-Protocol: agent-events-v1` request header, and is rejected when `async` is true.",
|
|
"type": "boolean"
|
|
},
|
|
"includeToolCalls": {
|
|
"default": false,
|
|
"description": "Include tool-call events in an agent-event stream. Requires `stream: true` and the `X-Sim-Stream-Protocol: agent-events-v1` request header, and is rejected when `async` is true.",
|
|
"type": "boolean"
|
|
},
|
|
"includeFileBase64": {
|
|
"description": "Inline eligible output files as base64 content.",
|
|
"type": "boolean"
|
|
},
|
|
"base64MaxBytes": {
|
|
"description": "Maximum total bytes of file content to inline as base64.",
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 10485760
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"title": "Execute workflow request",
|
|
"description": "Input and execution-mode options for a deployed workflow. Option constraints — each is a 400: (1) `async: true` requires an API key; anonymous public-workflow callers may only execute synchronously or as a stream. (2) `async` and `stream` cannot both be true. (3) `executionTimeoutSeconds` is accepted only when `async: true`. (4) `async: true` rejects every streaming and output-shaping option — `selectedOutputs`, `includeThinking`, `includeToolCalls`, `includeFileBase64`, and `base64MaxBytes`. (5) `includeThinking` and `includeToolCalls` require `stream: true`. (6) `includeThinking` and `includeToolCalls` require the `X-Sim-Stream-Protocol: agent-events-v1` request header, which declares that the client understands agent-event frames.",
|
|
"examples": [
|
|
{
|
|
"input": {
|
|
"ticketId": "ticket_123"
|
|
}
|
|
},
|
|
{
|
|
"input": {
|
|
"ticketId": "ticket_123"
|
|
},
|
|
"async": true
|
|
},
|
|
{
|
|
"input": {
|
|
"ticketId": "ticket_123"
|
|
},
|
|
"stream": true
|
|
}
|
|
]
|
|
},
|
|
"WorkflowRunListItem": {
|
|
"type": "object",
|
|
"properties": {
|
|
"runId": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 128,
|
|
"pattern": "^[A-Za-z0-9._:-]+$",
|
|
"description": "Unique workflow run identifier.",
|
|
"examples": ["run_8f14e45f-ceea-467f-a"]
|
|
},
|
|
"workflowId": {
|
|
"type": "string",
|
|
"description": "Workflow that produced the run."
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [
|
|
"pending",
|
|
"running",
|
|
"redacting",
|
|
"completed",
|
|
"failed",
|
|
"cancelled",
|
|
"paused"
|
|
],
|
|
"description": "Current or terminal run status. `redacting` is transient, reported while the output of a finished run is being scrubbed."
|
|
},
|
|
"trigger": {
|
|
"type": "string",
|
|
"description": "Trigger type that started the run."
|
|
},
|
|
"startedAt": {
|
|
"type": "string",
|
|
"description": "ISO 8601 timestamp when the run started.",
|
|
"format": "date-time"
|
|
},
|
|
"endedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "ISO 8601 timestamp when the run ended, or null while active.",
|
|
"format": "date-time"
|
|
},
|
|
"durationMs": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Run duration in milliseconds, or null while active."
|
|
},
|
|
"cost": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "number",
|
|
"description": "Total credits consumed by the run."
|
|
}
|
|
},
|
|
"required": ["total"],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Credit cost, or null when unavailable."
|
|
}
|
|
},
|
|
"required": [
|
|
"runId",
|
|
"workflowId",
|
|
"status",
|
|
"trigger",
|
|
"startedAt",
|
|
"endedAt",
|
|
"durationMs",
|
|
"cost"
|
|
],
|
|
"additionalProperties": false,
|
|
"title": "Workflow run summary",
|
|
"description": "Summary of a recorded workflow run."
|
|
},
|
|
"WorkflowRunListResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/WorkflowRunListItem"
|
|
},
|
|
"description": "Items in the current page."
|
|
},
|
|
"nextCursor": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Opaque cursor for the next page: send it back as `cursor` to continue, and stop when it is null. Most v2 lists page, so null means the last page was reached. A few are full-set lists that return their whole bounded result in one response and therefore always report null; those say so in the operation description. Either way, null means there is nothing further to fetch — never construct a cursor yourself."
|
|
}
|
|
},
|
|
"required": ["data", "nextCursor"],
|
|
"additionalProperties": false,
|
|
"title": "Workflow run list response",
|
|
"description": "A cursor-paginated page of workflow run summaries.",
|
|
"examples": [
|
|
{
|
|
"data": [
|
|
{
|
|
"runId": "run_8f14e45f-ceea-467f-a",
|
|
"workflowId": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
|
|
"status": "completed",
|
|
"trigger": "api",
|
|
"startedAt": "2026-08-09T18:04:10.000Z",
|
|
"endedAt": "2026-08-09T18:04:11.000Z",
|
|
"durationMs": 1000,
|
|
"cost": {
|
|
"total": 12
|
|
}
|
|
}
|
|
],
|
|
"nextCursor": null
|
|
}
|
|
]
|
|
},
|
|
"WorkflowRunStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"runId": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 128,
|
|
"pattern": "^[A-Za-z0-9._:-]+$",
|
|
"description": "Unique workflow run identifier.",
|
|
"examples": ["run_8f14e45f-ceea-467f-a"]
|
|
},
|
|
"workflowId": {
|
|
"type": "string",
|
|
"description": "Workflow that produced the run."
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [
|
|
"pending",
|
|
"running",
|
|
"redacting",
|
|
"completed",
|
|
"failed",
|
|
"cancelled",
|
|
"paused",
|
|
"queued"
|
|
],
|
|
"description": "Current or terminal run status. `redacting` is transient, reported while the output of a finished run is being scrubbed."
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Trigger type, or null before the run is recorded."
|
|
},
|
|
"startedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "ISO 8601 start timestamp, or null while queued.",
|
|
"format": "date-time"
|
|
},
|
|
"endedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "ISO 8601 end timestamp, or null while nonterminal.",
|
|
"format": "date-time"
|
|
},
|
|
"durationMs": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Run duration in milliseconds, or null while active."
|
|
},
|
|
"paused": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"contextId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Resume context identifier, or null while every pause point is mid-resume."
|
|
},
|
|
"pausedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"description": "ISO 8601 timestamp when the execution entered the paused state."
|
|
},
|
|
"resumeAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "ISO 8601 scheduled automatic-resume timestamp, or null when no resume time is set."
|
|
},
|
|
"pauseKind": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": ["time", "human"]
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Whether the pause waits for time or human input, or null when unspecified."
|
|
},
|
|
"blockedOnBlockId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow block awaiting resume, or null when no block is identified."
|
|
},
|
|
"automaticResumeWaitingReason": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Reason automatic resume is waiting, or null when it is not waiting."
|
|
},
|
|
"pausePointCount": {
|
|
"type": "number",
|
|
"description": "Number of pause points tracked for the execution."
|
|
},
|
|
"resumedCount": {
|
|
"type": "number",
|
|
"description": "Number of pause points that have resumed."
|
|
}
|
|
},
|
|
"required": [
|
|
"contextId",
|
|
"pausedAt",
|
|
"resumeAt",
|
|
"pauseKind",
|
|
"blockedOnBlockId",
|
|
"automaticResumeWaitingReason",
|
|
"pausePointCount",
|
|
"resumedCount"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Current pause details, or null when the run is not paused."
|
|
},
|
|
"cost": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "number",
|
|
"description": "Total credits consumed by the run."
|
|
}
|
|
},
|
|
"required": ["total"],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Credit cost, or null when unavailable."
|
|
},
|
|
"error": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ExecutionError"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Structured execution failure, or null when none occurred."
|
|
},
|
|
"output": {
|
|
"anyOf": [
|
|
{
|
|
"description": "Final workflow output value."
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Final workflow output when requested, otherwise null."
|
|
},
|
|
"blockOutputs": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"propertyNames": {
|
|
"type": "string"
|
|
},
|
|
"additionalProperties": {
|
|
"description": "Output value produced by one workflow block."
|
|
}
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Selected block outputs when requested, otherwise null."
|
|
}
|
|
},
|
|
"required": [
|
|
"runId",
|
|
"workflowId",
|
|
"status",
|
|
"trigger",
|
|
"startedAt",
|
|
"endedAt",
|
|
"durationMs",
|
|
"paused",
|
|
"cost",
|
|
"error",
|
|
"output",
|
|
"blockOutputs"
|
|
],
|
|
"additionalProperties": false,
|
|
"title": "Workflow run status",
|
|
"description": "Detailed current state of a workflow run."
|
|
},
|
|
"WorkflowRunStatusResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/WorkflowRunStatus"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Workflow run status response",
|
|
"description": "Detailed current state of a workflow run.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"runId": "run_8f14e45f-ceea-467f-a",
|
|
"workflowId": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
|
|
"status": "completed",
|
|
"trigger": "api",
|
|
"startedAt": "2026-08-09T18:04:10.000Z",
|
|
"endedAt": "2026-08-09T18:04:11.000Z",
|
|
"durationMs": 1000,
|
|
"paused": null,
|
|
"cost": {
|
|
"total": 12
|
|
},
|
|
"error": null,
|
|
"output": {
|
|
"result": "Ticket routed to Support"
|
|
},
|
|
"blockOutputs": null
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"ResumeWorkflowSyncResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/WorkflowRunResult"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Synchronous workflow resume response",
|
|
"description": "Completed, failed, paused, or cancelled resumed workflow run.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"runId": "run_8f14e45f-ceea-467f-a",
|
|
"workflowId": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
|
|
"status": "completed",
|
|
"output": {
|
|
"result": "Ticket routed to Support"
|
|
},
|
|
"error": null,
|
|
"startedAt": "2026-08-09T18:04:10.000Z",
|
|
"endedAt": "2026-08-09T18:04:11.000Z",
|
|
"durationMs": 1000
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"QueuedWorkflowResume": {
|
|
"type": "object",
|
|
"properties": {
|
|
"runId": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 128,
|
|
"pattern": "^[A-Za-z0-9._:-]+$",
|
|
"description": "Unique workflow run identifier.",
|
|
"examples": ["run_8f14e45f-ceea-467f-a"]
|
|
},
|
|
"statusUrl": {
|
|
"type": "string",
|
|
"format": "uri",
|
|
"description": "Absolute URL of the workflow run resource."
|
|
},
|
|
"queuePosition": {
|
|
"description": "Current queue position, when available.",
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991
|
|
}
|
|
},
|
|
"required": ["runId", "statusUrl"],
|
|
"additionalProperties": false,
|
|
"title": "Queued workflow resume",
|
|
"description": "Receipt returned when a resumed workflow attempt is queued."
|
|
},
|
|
"ResumeWorkflowQueuedResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/QueuedWorkflowResume"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Queued workflow resume response",
|
|
"description": "Receipt returned when a resumed workflow attempt is queued.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"runId": "run_8f14e45f-ceea-467f-a",
|
|
"statusUrl": "https://www.sim.ai/api/v2/workflows/3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36/runs/run_8f14e45f-ceea-467f-a"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"ResumeWorkflowRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"contextId": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Human-in-the-loop pause-context identifier."
|
|
},
|
|
"input": {
|
|
"description": "Input supplied to the paused workflow block."
|
|
}
|
|
},
|
|
"required": ["contextId"],
|
|
"additionalProperties": false,
|
|
"title": "Resume workflow request",
|
|
"description": "Pause context and optional input used to resume a workflow run.",
|
|
"examples": [
|
|
{
|
|
"contextId": "ctx_123",
|
|
"input": {
|
|
"approved": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"CancelWorkflowRunResult": {
|
|
"type": "object",
|
|
"properties": {
|
|
"success": {
|
|
"type": "boolean",
|
|
"description": "Whether cancellation was accepted."
|
|
},
|
|
"runId": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 128,
|
|
"pattern": "^[A-Za-z0-9._:-]+$",
|
|
"description": "Unique workflow run identifier.",
|
|
"examples": ["run_8f14e45f-ceea-467f-a"]
|
|
},
|
|
"redisAvailable": {
|
|
"type": "boolean",
|
|
"description": "Whether the distributed cancellation channel was available."
|
|
},
|
|
"durablyRecorded": {
|
|
"type": "boolean",
|
|
"description": "Whether cancellation was recorded durably."
|
|
},
|
|
"locallyAborted": {
|
|
"type": "boolean",
|
|
"description": "Whether an in-process execution was aborted."
|
|
},
|
|
"pausedCancelled": {
|
|
"type": "boolean",
|
|
"description": "Whether a paused execution was cancelled."
|
|
},
|
|
"reason": {
|
|
"description": "Machine-readable cancellation outcome. Present on every cancellation, including full successes — it is not a partial-failure marker. `recorded` means cancellation was durably recorded (the normal success value). `redis_unavailable` and `redis_write_failed` mean the distributed cancellation signal could not be written, so an already-running execution may not observe the cancellation. `paused_event_publish_failed` and `paused_database_cancel_failed` name the failing step when cancelling a paused human-in-the-loop run.",
|
|
"type": "string",
|
|
"enum": [
|
|
"recorded",
|
|
"redis_unavailable",
|
|
"redis_write_failed",
|
|
"paused_event_publish_failed",
|
|
"paused_database_cancel_failed"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"success",
|
|
"runId",
|
|
"redisAvailable",
|
|
"durablyRecorded",
|
|
"locallyAborted",
|
|
"pausedCancelled"
|
|
],
|
|
"additionalProperties": false,
|
|
"title": "Cancel workflow run result",
|
|
"description": "Outcome of a workflow run cancellation request. Cancelling a run that has already reached a terminal state (completed, failed, or cancelled) succeeds with no effect rather than returning an error — treat this endpoint as best-effort and poll the run to observe the final state."
|
|
},
|
|
"CancelWorkflowRunResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/CancelWorkflowRunResult"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Cancel workflow run response",
|
|
"description": "Outcome of the cancellation request.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"success": true,
|
|
"runId": "run_8f14e45f-ceea-467f-a",
|
|
"redisAvailable": true,
|
|
"durablyRecorded": true,
|
|
"locallyAborted": true,
|
|
"pausedCancelled": false,
|
|
"reason": "recorded"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"WorkflowFolder": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Folder name."
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"description": "Canonical folder path used as the public folder identifier."
|
|
},
|
|
"parentPath": {
|
|
"type": "string",
|
|
"description": "Canonical parent path; `/` is the root."
|
|
},
|
|
"createdAt": {
|
|
"type": "string",
|
|
"description": "ISO 8601 timestamp when the folder was created.",
|
|
"format": "date-time"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string",
|
|
"description": "ISO 8601 timestamp when the folder was last updated.",
|
|
"format": "date-time"
|
|
},
|
|
"locked": {
|
|
"type": "boolean",
|
|
"description": "Whether the folder is currently locked for mutation."
|
|
}
|
|
},
|
|
"required": ["name", "path", "parentPath", "createdAt", "updatedAt", "locked"],
|
|
"additionalProperties": false,
|
|
"title": "Workflow folder",
|
|
"description": "A canonical workflow folder and its mutation lock state."
|
|
},
|
|
"WorkflowFolderListResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/WorkflowFolder"
|
|
},
|
|
"description": "Items in the current page."
|
|
},
|
|
"nextCursor": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Opaque cursor for the next page: send it back as `cursor` to continue, and stop when it is null. Most v2 lists page, so null means the last page was reached. A few are full-set lists that return their whole bounded result in one response and therefore always report null; those say so in the operation description. Either way, null means there is nothing further to fetch — never construct a cursor yourself."
|
|
}
|
|
},
|
|
"required": ["data", "nextCursor"],
|
|
"additionalProperties": false,
|
|
"title": "Workflow folder list response",
|
|
"description": "A list of canonical workflow folders.",
|
|
"examples": [
|
|
{
|
|
"data": [
|
|
{
|
|
"name": "Operations",
|
|
"path": "/Operations",
|
|
"parentPath": "/",
|
|
"createdAt": "2026-05-01T09:00:00.000Z",
|
|
"updatedAt": "2026-05-01T09:00:00.000Z",
|
|
"locked": false
|
|
}
|
|
],
|
|
"nextCursor": null
|
|
}
|
|
]
|
|
},
|
|
"CreateWorkflowFolderResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/WorkflowFolder"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Create workflow folder response",
|
|
"description": "The created workflow folder.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"name": "Operations",
|
|
"path": "/Operations",
|
|
"parentPath": "/",
|
|
"createdAt": "2026-05-01T09:00:00.000Z",
|
|
"updatedAt": "2026-05-01T09:00:00.000Z",
|
|
"locked": false
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"CreateWorkflowFolderRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"workspaceId": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Workspace in which to create the folder."
|
|
},
|
|
"path": {
|
|
"description": "Path of the folder to create.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["workspaceId", "path"],
|
|
"additionalProperties": false,
|
|
"title": "Create workflow folder request",
|
|
"description": "Workspace and canonical path for a new workflow folder."
|
|
},
|
|
"RelocateWorkflowFolderResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/WorkflowFolder"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Relocate workflow folder response",
|
|
"description": "The relocated workflow folder.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"name": "Support",
|
|
"path": "/Support",
|
|
"parentPath": "/",
|
|
"createdAt": "2026-05-01T09:00:00.000Z",
|
|
"updatedAt": "2026-05-01T09:00:00.000Z",
|
|
"locked": false
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"RelocateWorkflowFolderRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"workspaceId": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Workspace containing the folder."
|
|
},
|
|
"path": {
|
|
"description": "Current folder path.",
|
|
"type": "string"
|
|
},
|
|
"destinationPath": {
|
|
"description": "New full path for the folder and its descendants.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["workspaceId", "path", "destinationPath"],
|
|
"additionalProperties": false,
|
|
"title": "Relocate workflow folder request",
|
|
"description": "Current and destination paths for a workflow folder."
|
|
},
|
|
"DeleteWorkflowFolderResult": {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"description": "Path of the deleted workflow folder."
|
|
},
|
|
"deleted": {
|
|
"type": "boolean",
|
|
"const": true,
|
|
"description": "Confirms that the folder was deleted."
|
|
},
|
|
"deletedItems": {
|
|
"type": "object",
|
|
"properties": {
|
|
"folders": {
|
|
"type": "integer",
|
|
"minimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"description": "Number of folders deleted."
|
|
},
|
|
"workflows": {
|
|
"type": "integer",
|
|
"minimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"description": "Number of workflows deleted."
|
|
}
|
|
},
|
|
"required": ["folders", "workflows"],
|
|
"additionalProperties": false,
|
|
"description": "Resources removed by the deletion."
|
|
}
|
|
},
|
|
"required": ["path", "deleted", "deletedItems"],
|
|
"additionalProperties": false,
|
|
"title": "Delete workflow folder result",
|
|
"description": "Confirmation and deletion counts for a workflow folder."
|
|
},
|
|
"DeleteWorkflowFolderResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Response data.",
|
|
"$ref": "#/components/schemas/DeleteWorkflowFolderResult"
|
|
}
|
|
},
|
|
"required": ["data"],
|
|
"additionalProperties": false,
|
|
"title": "Delete workflow folder response",
|
|
"description": "Confirmation and counts for the deleted folder.",
|
|
"examples": [
|
|
{
|
|
"data": {
|
|
"path": "/Operations",
|
|
"deleted": true,
|
|
"deletedItems": {
|
|
"folders": 1,
|
|
"workflows": 0
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"x-generated-by": "scripts/generate-openapi.ts"
|
|
}
|