> For the complete documentation index, see [llms.txt](https://agpt.co/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://agpt.co/docs/integrations/block-integrations/get_workspace.md). # 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](https://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. *** --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://agpt.co/docs/integrations/block-integrations/get_workspace.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.