For the complete documentation index, see llms.txt. This page is also available as Markdown.

Conductor Get Workspace

Everything about one Conductor workspace: details, status, shared preview URL and its agent sessions. Requires your own Conductor API key, created at app.conductor.build/users/api-keys and added through AutoGPT’s credentials UI. Select that credential for each Conductor block; no server-wide default key is used.

Conductor Get Workspace

What it is

Get everything about one Conductor workspace: details, current status, shared preview URL and its agent sessions.

How it works

The block calls GET /v0/workspaces/{id} and GET /v0/workspaces/{id}/status, then best-effort GET /v0/workspaces/{id}/preview and GET /v0/workspaces/{id}/sessions (a workspace that is still initializing may not serve those yet, in which case preview_url is empty and sessions is empty). The session listing is paged in requests of up to 100 rows until session_limit sessions have been collected starting at session_offset; sessions_has_more and next_session_offset let a graph read the following page. status is one of initializing, ready, sleeping, archived, deleted, updating or unstarted; lifecycle_step and error_message explain an initializing or failed workspace. base_branch is filled from the workspace record when Conductor reports the branch it was cut from; the API currently omits it, so the output is empty and the base_branch output of Create Workspace is the record to keep.

Inputs

Input
Description
Type
Required

workspace_id

Workspace ID

str

Yes

include_archived_sessions

Include archived sessions in the session list

bool

No

session_limit

Maximum number of sessions to return

int

No

session_offset

Number of sessions to skip; use next_session_offset to read the following page

int

No

Outputs

Output
Description
Type

error

Error message if the operation failed

str

workspace

Workspace: id, projectId, name, state, repoUrl, deepLink, creatorName, lastActivityAt

Dict[str, Any]

status

initializing, ready, sleeping, archived, deleted, updating or unstarted

str

lifecycle_step

Setup step while initializing: building_snapshot, preparing, setting_up or updating

str

error_message

Workspace error, if any

str

preview_url

Public preview URL when a port is shared, else empty

str

preview_port

Port being shared at the preview URL, 0 when none

int

sessions

Agent sessions in the workspace: id, name, model, effort, deepLink

List[Dict[str, Any]]

sessions_has_more

True when the workspace has more sessions than returned

bool

next_session_offset

session_offset to request the next page of sessions

int

deep_link

Link that opens the workspace

str

base_branch

Branch the workspace was created from, when Conductor reports it. The API currently omits it, so this is empty; keep the base_branch output of Create Workspace instead. Verify it matches the PR target before opening a PR.

str

Possible use case

Wait for readiness: Poll this block after Create Workspace until status is ready before opening a second session.

Grab the preview link: Read preview_url after Manage Workspace shared a port, and post it to Slack for review.

Pick a session: Use sessions[].id to choose which chat to send a follow-up prompt to.


Last updated

Was this helpful?