Restart the workspace pod

POST

/workspaces/{id}/restart

const url = 'https://your-org.evershell.ai/v1/workspaces/example/restart?force=false';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url 'https://your-org.evershell.ai/v1/workspaces/example/restart?force=false' \
  --header 'Authorization: Bearer <token>'

Permissions: workspace:write or workspace:write:own (creator-match on :own).

Tears down the current pod and provisions a fresh one, carrying state via snapshot. Use to pick up role / pack changes without losing conversation history.

Busy workspaces require ?force=true to confirm interrupting the in-flight task; without it the handler returns 409 workspace_busy so the UI can prompt.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

Query Parameters

force

boolean

Pass true to restart a busy workspace and interrupt its in-flight task.

Responses

202

Restart initiated

application/json

object

status

string

Example

{
  "status": "restarting"
}

404

Resource not found in the caller’s org

application/json

object

error

required

object

code

required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string

message

required

Human-readable summary

string

request_id

required

Server-generated request id for correlating logs

string

details

Optional structured context. Validation errors land at details.fields as a per-field map.

object

key

additional properties

any

Example

{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}

409

workspace_archived — unarchive first; invalid_state — workspace isn’t idle/busy; workspace_busy — busy workspace + ?force=true wasn’t supplied.

application/json

object

error

required

object

code

required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string

message

required

Human-readable summary

string

request_id

required

Server-generated request id for correlating logs

string

details

Optional structured context. Validation errors land at details.fields as a per-field map.

object

key

additional properties

any

Example

{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}

423

Tenant is past_due, decommissioning, or trial-expired

application/json

object

error

required

object

code

required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string

message

required

Human-readable summary

string

request_id

required

Server-generated request id for correlating logs

string

details

Optional structured context. Validation errors land at details.fields as a per-field map.

object

key

additional properties

any

Example

{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}