Skip to main content

Launch SDK

Agent launch flows.

Operations

Generated Reference

Overview

Available Operations

lucidLaunchAgent

Launch an agent via one of two modes:
  • image: Deploy a pre-built Docker image (Path A — Bring Your Own Image).
  • base-runtime: Deploy a pre-configured base runtime with model, prompt, and optional tools (Path B — No-Code).
Both modes create a passport, deploy to the target provider, and inject Lucid env vars. Returns the passport_id, deployment_id, and deployment URL.

Example Usage: base_runtime_mode

Standalone function

The standalone function version of this method:

Example Usage: image_mode

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.LaunchResponse>

Errors

lucidDeployBlueGreen

Start a blue-green rollout for an agent. Deploys a new version into the blue slot while the current primary continues serving traffic. Use promote or rollback to finalize.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidDeployBlueGreenResponse>

Errors

lucidPromoteBlue

Promote the blue deployment to primary. The current primary is terminated and the blue slot becomes the new primary. Fails if no healthy blue deployment exists.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidPromoteBlueResponse>

Errors

lucidRollbackDeployment

Rollback to the previous primary deployment. Terminates the current primary and restores the prior version. Fails if no rollback target exists.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidRollbackDeploymentResponse>

Errors

lucidGetBlueDeployment

Retrieve the current blue-slot deployment status for an agent, including health state, URL, and promotion eligibility.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidGetBlueDeploymentResponse>

Errors

lucidCancelBlueDeployment

Cancel and terminate the blue-slot deployment without affecting the current primary. Useful when the blue deployment fails health checks or is no longer needed.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidCancelBlueDeploymentResponse>

Errors