Skip to main content
POST
Start live environment (external)

Authorizations

X-Asteroid-Agents-Api-Key
string
header
required

Path Parameters

agentId
string<uuid>
required

The agent the environment belongs to.

Body

application/json

Request to start a standalone live environment via the external (agents-API-key) API. Unlike the internal StartEnvironmentRequest there is no owner field — the env is stamped with an external owner for the path agent, and takes the agent's own organisation (not the caller's). Provisioning reads no workflow unless a workflow source is passed.

agentProfileId
string<uuid>

Optional agent profile to attach. When supplied, the profile's decrypted credentials are returned as the ##NAME## placeholder map and the profile id is stamped onto the env row for the session's lifetime.

source
object

Where the environment spec comes from. Omit for the server default (a browser env at the computer-use resolution).

Response

The request has succeeded.

Response from starting a live environment. Shape mirrors the legacy POST /agents/{id}/workflows/{wid}/live-environment response so callers can share rendering code; environmentId is the new wire handle astro stores for stop / attach.

environmentId
string<uuid>
required

The newly-provisioned environment.

environmentType
enum<string>
required

The environment type the workflow is configured for.

Available options:
browser,
os
cdpUrl
string

Chrome DevTools Protocol websocket URL. Present only for browser environments.

credentials
object

Decrypted credential placeholders for the attached agent profile, keyed by ##NAME## placeholder. Present only when agentProfileId was supplied and the profile has credentials.

cua
object

Provider-specific CUA connection details. Present for Anchor browsers and Daytona OS environments.