Viewport daemon, relay, and hosted runtime are available in alpha. Surfaces may change.
VIEWPORT
ReferenceAPI reference

Workflows

11 operations in the Workflows group.

11 of 11 operations on this page are generated contract stubs: the routes are real, the schemas are placeholders pending the owning subsystem's contract pass.

GET /api/workflows

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkflows

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workflows

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkflows

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workflows/{workflow}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkflowsWorkflow

Parameters

NameInRequiredTypeDescription
workflowpathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workflows/{workflow}/attach

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkflowsWorkflowAttach

Parameters

NameInRequiredTypeDescription
workflowpathyesstring

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

DELETE /api/workflows/{workflow}/attach

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: deleteApiWorkflowsWorkflowAttach

Parameters

NameInRequiredTypeDescription
workflowpathyesstring

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
204No content—
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workflows/{workflow}/audit-events

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkflowsWorkflowAuditEvents

Parameters

NameInRequiredTypeDescription
workflowpathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workflows/{workflow}/fork

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkflowsWorkflowFork

Parameters

NameInRequiredTypeDescription
workflowpathyesstring

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workflows/{workflow}/shares

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkflowsWorkflowShares

Parameters

NameInRequiredTypeDescription
workflowpathyesstring

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

DELETE /api/workflows/{workflow}/shares/{share}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: deleteApiWorkflowsWorkflowSharesShare

Parameters

NameInRequiredTypeDescription
workflowpathyesstring
sharepathyesstring

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
204No content—
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workflows/{workflow}/versions

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkflowsWorkflowVersions

Parameters

NameInRequiredTypeDescription
workflowpathyesstring

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workflows/by-name/{workflowName}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkflowsByNameWorkflowName

Parameters

NameInRequiredTypeDescription
workflowNamepathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

Workflow Setup Readiness

1 operation in the Workflow Setup Readiness group.

Workspace Invitations

1 operation in the Workspace Invitations group.

On this page

GET /api/workflowsPOST /api/workflowsGET /api/workflows/{workflow}POST /api/workflows/{workflow}/attachDELETE /api/workflows/{workflow}/attachGET /api/workflows/{workflow}/audit-eventsPOST /api/workflows/{workflow}/forkPOST /api/workflows/{workflow}/sharesDELETE /api/workflows/{workflow}/shares/{share}POST /api/workflows/{workflow}/versionsGET /api/workflows/by-name/{workflowName}