# CloudCruise

## Docs

- [Builder Agent](https://docs.cloudcruise.com/concepts/builder-agent.md): Generates a workflow through chat
- [Citrix Virtual Desktops](https://docs.cloudcruise.com/concepts/citrix.md): Automate workflows inside Citrix VDI environments via HTML5 browser access
- [Maintenance Agent](https://docs.cloudcruise.com/concepts/maintenance-agent.md): Classifies workflow failures and triggers appropriate recovery actions
- [Rate Limits](https://docs.cloudcruise.com/concepts/rate-limits.md): API rate limits and best practices
- [Two-Factor Authentication](https://docs.cloudcruise.com/concepts/twofactor.md): Seamless 2FA handling for autonomous browser agents
- [Vault](https://docs.cloudcruise.com/concepts/vault.md): Where your credentials are stored
- [Webhooks](https://docs.cloudcruise.com/concepts/webhooks.md): Register webhooks to receive updates on the workflow execution
- [Bool Condition](https://docs.cloudcruise.com/concepts/workflow-dsl/bool-condition.md): Add conditional branching logic to workflows
- [Click](https://docs.cloudcruise.com/concepts/workflow-dsl/click.md): Click on elements in the page
- [Delay](https://docs.cloudcruise.com/concepts/workflow-dsl/delay.md): Wait for a specified duration
- [Extract Datamodel](https://docs.cloudcruise.com/concepts/workflow-dsl/extract-datamodel.md): Extract structured data from the page
- [Extract Network](https://docs.cloudcruise.com/concepts/workflow-dsl/extract-network.md): Capture and extract data from network requests
- [File Download](https://docs.cloudcruise.com/concepts/workflow-dsl/file-download.md): Capture and store downloaded files
- [File Upload](https://docs.cloudcruise.com/concepts/workflow-dsl/file-upload.md): Upload files to web forms
- [Input Select](https://docs.cloudcruise.com/concepts/workflow-dsl/input-select.md): Select options from dropdown menus
- [Input Text](https://docs.cloudcruise.com/concepts/workflow-dsl/input-text.md): Type text into input fields
- [Loop](https://docs.cloudcruise.com/concepts/workflow-dsl/loop.md): Iterate over arrays or repeat operations
- [Navigate](https://docs.cloudcruise.com/concepts/workflow-dsl/navigate.md): Navigate the browser to a URL
- [Overview](https://docs.cloudcruise.com/concepts/workflow-dsl/overview.md): Change input variables, edit the workflow graph and more
- [Screenshot](https://docs.cloudcruise.com/concepts/workflow-dsl/screenshot.md): Capture screenshots of the page or elements
- [Scroll](https://docs.cloudcruise.com/concepts/workflow-dsl/scroll.md): Scroll the page or specific containers
- [Tab Management](https://docs.cloudcruise.com/concepts/workflow-dsl/tab-management.md): Open, close, and switch between browser tabs
- [Two-Factor Authentication](https://docs.cloudcruise.com/concepts/workflow-dsl/tfa.md): Handle two-factor authentication challenges
- [User Interaction](https://docs.cloudcruise.com/concepts/workflow-dsl/user-interaction.md): Request human input during workflow execution
- [Workflow Settings](https://docs.cloudcruise.com/concepts/workflow-dsl/workflow-settings.md): Configure workflow-level settings that apply to every run
- [Workflows](https://docs.cloudcruise.com/concepts/workflows.md): A context container for your business process
- [Sentry](https://docs.cloudcruise.com/integrations/sentry.md): Push workflow run results to Sentry for monitoring and alerting
- [Slack](https://docs.cloudcruise.com/integrations/slack.md): Set up Slack notifications for your CloudCruise workflows
- [Quickstart](https://docs.cloudcruise.com/introduction.md): Build & Run
- [Get debug snapshots](https://docs.cloudcruise.com/run-api/get-debug-snapshots.md): Retrieves debug snapshots for a specific node in a workflow run. This endpoint is only available for runs started with `debug: true`. It returns: - An HTML page snapshot captured at the time the node was executed - Any screenshots taken at that node
- [Get workflow error analytics](https://docs.cloudcruise.com/run-api/get-workflow-error-report.md): Retrieves error analytics for a specific workflow within a time range. This endpoint provides: - Aggregated error counts grouped by error code - Detailed error information including session IDs, timestamps, and descriptions - Support for filtering by time range to analyze error trends - Configurable…
- [Interrupt run](https://docs.cloudcruise.com/run-api/interrupt-run.md): Interrupts a running or queued run. If the run is queued, it will be cleared from the queue. If the run is running, it will be interrupted.
- [List runs](https://docs.cloudcruise.com/run-api/list-runs.md): Retrieves a filtered list of workflow execution runs. This endpoint provides: - Time-based filtering with custom start/end timestamps - Filtering by workflow, execution status, or vault credential - Configurable result limits up to 10,000 runs - Results sorted by creation time (newest first) - Curso…
- [Retrieve run results](https://docs.cloudcruise.com/run-api/retrieve-run-results.md): Retrieves comprehensive results and execution details for a specific browser agent run. This endpoint provides: - Current execution status and overall outcome - Detailed output data based on your defined data model - Run artifacts including screenshots, error logs, and authentication/input variable…
- [Start a run](https://docs.cloudcruise.com/run-api/start-a-run.md): Initiates a new browser agent run. This endpoint allows you to: - Start a run with input variables - Execute runs on behalf of authenticated users - Configure webhook notifications for run events - Perform dry runs to prevent writes in the target software
- [Submit new input variables](https://docs.cloudcruise.com/run-api/submit-new-input-variables.md): Sends corrected input variables to a session waiting for new data. When a workflow encounters an error with the `input_required` error action configured, execution pauses and an `execution.input_required` webhook is sent. Use this endpoint to respond with corrected values so the workflow can resume…
- [Submit user interaction data](https://docs.cloudcruise.com/run-api/submit-user-interaction-data.md): Submits user interaction data during an active run. This endpoint enables: - Real-time user input submission during run - Dynamic response handling for interactive runs - Support for various input types through flexible key-value pairs - Integration with run decision points and verification steps
- [Overview](https://docs.cloudcruise.com/sdk/cli/overview.md): Get started with the CloudCruise CLI
- [Overview](https://docs.cloudcruise.com/sdk/js/overview.md): Get started with the CloudCruise TypeScript/JavaScript SDK
- [Vault](https://docs.cloudcruise.com/sdk/js/vault.md): Manage encrypted credentials with the TypeScript/JavaScript SDK
- [Workflows](https://docs.cloudcruise.com/sdk/js/workflows.md): Explore and validate workflows with the TypeScript/JavaScript SDK
- [Python Overview](https://docs.cloudcruise.com/sdk/python/overview.md): Get started with the CloudCruise Python SDK
- [Vault](https://docs.cloudcruise.com/sdk/python/vault.md): Manage encrypted credentials with the Python SDK
- [Workflows](https://docs.cloudcruise.com/sdk/python/workflows.md): Explore and validate workflows with the Python SDK
- [Clear browser state](https://docs.cloudcruise.com/vault-api/clear-browser-state.md): Clears the stored browser state (cookies, localStorage, and sessionStorage) for a specific vault entry.
- [Create vault entry](https://docs.cloudcruise.com/vault-api/create-vault-entry.md): Registers a new vault entry in the CloudCruise Platform.
- [Delete vault entry](https://docs.cloudcruise.com/vault-api/delete-vault-entry.md): Deletes a vault entry from the CloudCruise Platform using domain and permissioned user ID.
- [Get vault entries](https://docs.cloudcruise.com/vault-api/get-vault-entries.md): Retrieves vault entries for users matching the specified criteria.
- [Update vault entry](https://docs.cloudcruise.com/vault-api/update-vault-entry.md): Updates a vault entry in the CloudCruise Platform.
- [Replay webhooks](https://docs.cloudcruise.com/webhooks-api/replay-webhooks.md): Replays all webhooks that were sent during a session.
- [Create workflow](https://docs.cloudcruise.com/workflow-api/create-workflow.md): Creates a new workflow in the workspace associated with your API key.
- [Get workflow metadata](https://docs.cloudcruise.com/workflow-api/get-metadata.md): Retrieves computed input and vault schemas for a specific workflow
- [Get workflow](https://docs.cloudcruise.com/workflow-api/get-workflow.md): Retrieves the full workflow definition including nodes, edges, and configuration
- [Get all workflows](https://docs.cloudcruise.com/workflow-api/get-workflows.md): Retrieves all workflows of the workspace the API key is associated with
- [Update workflow](https://docs.cloudcruise.com/workflow-api/update-workflow.md): Updates an existing workflow. The workflow must already exist and belong to the workspace associated with your API key.

## OpenAPI Specs

- [vault-api](https://docs.cloudcruise.com/vault-api/vault-api.yaml)
- [run-api](https://docs.cloudcruise.com/run-api/run-api.yaml)
- [workflow-api](https://docs.cloudcruise.com/workflow-api/workflow-api.yaml)
- [webhooks-api](https://docs.cloudcruise.com/webhooks-api/webhooks-api.yaml)
- [openapi](https://docs.cloudcruise.com/api-reference/openapi.json)

## Optional

- [Community](https://discord.com/invite/MHjbUqedZF)
- [Blog](https://cloudcruise.com/blog)


Built with [Mintlify](https://mintlify.com).