Open a session - Zite Platform

POST

workspaces

{workspaceId}

sessions

Open a session

curl --request POST \
  --url https://api.zite.com/v1/workspaces/{workspaceId}/sessions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.zite.com/v1/workspaces/{workspaceId}/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.zite.com/v1/workspaces/{workspaceId}/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zite.com/v1/workspaces/{workspaceId}/sessions"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zite.com/v1/workspaces/{workspaceId}/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "sessionId": "ses_9f2a1c7b40e8",
  "apps": [
    {
      "id": "app_a1b2c3",
      "name": "Agent console",
      "dir": "apps/agent-console"
    }
  ],
  "files": [
    "apps/agent-console/src/App.tsx",
    "..."
  ],
  "guide": "# Building Zite apps — framework guide\n..."
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key."
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Workspace not found."
  }
}

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 after ~15 minutes idle and re-boot transparently on the next call.

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:wsp8bce4d1edc51710:2f0c9a1e-77f4-4b3e-9f2a-1c7b40e8d316"

workspaceId

string

Example:

"wsp8bce4d1edc51710"

apps

object[]

Show child attributes

files

string[]

The workspace file tree, relative to the workspace root.

integrations

object[]

Integrations already connected to the workspace.

docs

object[]

Index of fetchable framework guides and recipes.

guide

string

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

Open a session

curl --request POST \
  --url https://api.zite.com/v1/workspaces/{workspaceId}/sessions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.zite.com/v1/workspaces/{workspaceId}/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.zite.com/v1/workspaces/{workspaceId}/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zite.com/v1/workspaces/{workspaceId}/sessions"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zite.com/v1/workspaces/{workspaceId}/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "sessionId": "ses_9f2a1c7b40e8",
  "apps": [
    {
      "id": "app_a1b2c3",
      "name": "Agent console",
      "dir": "apps/agent-console"
    }
  ],
  "files": [
    "apps/agent-console/src/App.tsx",
    "..."
  ],
  "guide": "# Building Zite apps — framework guide\n..."
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key."
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Workspace not found."
  }
}