Open a session - Zite Platform
Skip to main content
POST
Open a session
A build session is an isolated checkout of a workspace’s monorepo, the same concept as the Zite MCP sandbox. You create apps and edit files inside a session, then commit to build and version your changes. The response includes the workspace’s file tree, its apps, and the framework guide: the same spec agents receive, describing the project layout and conventions.
  • Every file and commit call takes the sessionId returned here.
  • Use one session per concurrent build so parallel jobs don’t clobber each other.
  • Sessions auto-stop when idle and re-boot transparently on the next call.
  • If the workspace pins an older zitejs than the current release, the response includes zitejsUpdate with the command to update it.

Authorizations

Authorization
string
header
required

Enter your Zite API key. Format: Bearer <api_key>

Path Parameters

workspaceId
string
required

The workspace ID.

Response

The open session

sessionId
string

Pass this in the path of every session call. Opaque; encodes the workspace and an isolated checkout.

Example:

"sbx:8bce4d1edc51710f:2f0c9a1e-77f4-4b3e-9f2a-1c7b40e8d316"

workspaceId
string
Example:

"8bce4d1edc51710f"

apps
object[]
files
string[]

The workspace file tree, relative to the workspace root.

integrations
object[]

Integrations already connected to the workspace.

connectableServiceTypes
string[]

Integration types your organization can connect.

docs
object

Index of fetchable framework guides and recipes.

guide
string

The zitejs framework guide. Read it before writing app code.

notice
string

Present only on the call that starts your free trial of the build tools. Says when the trial ends.

zitejsUpdate
object

Present when the workspace pins an older zitejs than the current release. Run command with POST /sessions/{sessionId}/bash, then commit. Safe to skip for a read-only session.