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

Automations

29 operations in the Automations group.

18 of 29 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/automations

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

Operation ID: getApiAutomations

Responses

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

GET /api/automations/{automation}

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

Operation ID: getApiAutomationsAutomation

Parameters

NameInRequiredTypeDescription
automationpathyesstring

Responses

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

GET /api/automations/{automation}/drift

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

Operation ID: getApiAutomationsAutomationDrift

Parameters

NameInRequiredTypeDescription
automationpathyesstring

Responses

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

GET /api/automations/{automation}/effective-policy

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

Operation ID: getApiAutomationsAutomationEffectivePolicy

Parameters

NameInRequiredTypeDescription
automationpathyesstring

Responses

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

POST /api/automations/{automation}/escalation-preview

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

Operation ID: postApiAutomationsAutomationEscalationPreview

Parameters

NameInRequiredTypeDescription
automationpathyesstring

Request body — application/json · object

Responses

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

GET /api/automations/{automation}/insights

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

Operation ID: getApiAutomationsAutomationInsights

Parameters

NameInRequiredTypeDescription
automationpathyesstring

Responses

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

GET /api/automations/{automation}/readiness

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

Operation ID: getApiAutomationsAutomationReadiness

Parameters

NameInRequiredTypeDescription
automationpathyesstring

Responses

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

POST /api/automations/{automation}/repair-pr

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

Operation ID: postApiAutomationsAutomationRepairPr

Parameters

NameInRequiredTypeDescription
automationpathyesstring

Request body — application/json · object

Responses

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

GET /api/automations/{automation}/run-plan

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

Operation ID: getApiAutomationsAutomationRunPlan

Parameters

NameInRequiredTypeDescription
automationpathyesstring

Responses

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

POST /api/automations/{automation}/runs

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

Operation ID: postApiAutomationsAutomationRuns

Parameters

NameInRequiredTypeDescription
automationpathyesstring

Request body — application/json · object

Responses

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

GET /api/automations/{automation}/runs/{run}/story

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

Operation ID: getApiAutomationsAutomationRunsRunStory

Parameters

NameInRequiredTypeDescription
automationpathyesstring
runpathyesstring

Responses

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

GET /api/automations/{automation}/support-packet

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

Operation ID: getApiAutomationsAutomationSupportPacket

Parameters

NameInRequiredTypeDescription
automationpathyesstring

Responses

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

GET /api/automations/agents

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

Operation ID: getApiAutomationsAgents

Responses

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

GET /api/automations/capabilities

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

Operation ID: getApiAutomationsCapabilities

Responses

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

GET /api/automations/insights

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

Operation ID: getApiAutomationsInsights

Responses

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

GET /api/automations/mcp-tools

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

Operation ID: getApiAutomationsMcpTools

Responses

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

POST /api/automations/proposals

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

Operation ID: postApiAutomationsProposals

Request body — application/json · object

Responses

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

POST /api/automations/proposals/open-pr

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

Operation ID: postApiAutomationsProposalsOpenPr

Request body — application/json · object

Responses

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

GET /api/resources/{workspace}/automations

Operation ID: listAutomations

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Automation collection.AutomationCollectionResponse

GET /api/resources/{workspace}/automations/{automation}

Operation ID: getAutomation

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
automationpathyesstring

Responses

StatusDescriptionSchema
200Automation detail.—

GET /api/resources/{workspace}/automations/{automation}/readiness

Operation ID: getAutomationReadiness

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
automationpathyesstring

Responses

StatusDescriptionSchema
200Automation readiness.—

GET /api/resources/{workspace}/automations/{automation}/run-plan

Operation ID: getAutomationRunPlan

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
automationpathyesstring

Responses

StatusDescriptionSchema
200Automation run plan.—

POST /api/resources/{workspace}/automations/{automation}/runs

Operation ID: queueAutomationRun

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
automationpathyesstring

Responses

StatusDescriptionSchema
202Queued automation run.—

GET /api/resources/{workspace}/automations/{automation}/runs/{run}/story

Operation ID: getAutomationRunStory

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
automationpathyesstring
runpathyesstring

Responses

StatusDescriptionSchema
200Governed run story with trigger, routing, policy, context, sandbox, verification, output, tool, observability, and guardrail receipts.AutomationRunStoryResponse

GET /api/resources/{workspace}/automations/agents

Operation ID: listAutomationAgents

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200First-class agent catalog for automation creation. Agent selection changes execution adapter only; policy, gates, context, budgets, and receipts stay in Viewport.AgentCollectionResponse

GET /api/resources/{workspace}/automations/capabilities

Operation ID: getAutomationCapabilities

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Automation execution, runner, side-effect, and agent-neutrality capabilities.AutomationCapabilityMatrixResponse

GET /api/resources/{workspace}/automations/mcp-tools

Operation ID: listAutomationMcpTools

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Governed MCP tool catalog for automations. Credential refs and secret material are never returned.McpToolCatalogResponse

POST /api/resources/{workspace}/automations/proposals

Operation ID: createAutomationProposal

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200PR-ready automation proposal packet.—

POST /api/resources/{workspace}/automations/proposals/open-pr

Operation ID: openAutomationConfigPullRequest

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Opened automation config pull request.—

Auth

3 operations in the Auth group.

Billing

18 operations in the Billing group.

On this page

GET /api/automationsGET /api/automations/{automation}GET /api/automations/{automation}/driftGET /api/automations/{automation}/effective-policyPOST /api/automations/{automation}/escalation-previewGET /api/automations/{automation}/insightsGET /api/automations/{automation}/readinessPOST /api/automations/{automation}/repair-prGET /api/automations/{automation}/run-planPOST /api/automations/{automation}/runsGET /api/automations/{automation}/runs/{run}/storyGET /api/automations/{automation}/support-packetGET /api/automations/agentsGET /api/automations/capabilitiesGET /api/automations/insightsGET /api/automations/mcp-toolsPOST /api/automations/proposalsPOST /api/automations/proposals/open-prGET /api/resources/{workspace}/automationsGET /api/resources/{workspace}/automations/{automation}GET /api/resources/{workspace}/automations/{automation}/readinessGET /api/resources/{workspace}/automations/{automation}/run-planPOST /api/resources/{workspace}/automations/{automation}/runsGET /api/resources/{workspace}/automations/{automation}/runs/{run}/storyGET /api/resources/{workspace}/automations/agentsGET /api/resources/{workspace}/automations/capabilitiesGET /api/resources/{workspace}/automations/mcp-toolsPOST /api/resources/{workspace}/automations/proposalsPOST /api/resources/{workspace}/automations/proposals/open-pr