Research workspaces

Change settings for the next workspace session

Changed on

Requires stopped compute with confirmed release and no active file transfer. Send the complete configuration and its observed configuration_revision. Allows editor, SSH public key, GPU resources, session duration changes. Name, environment, project capacity and repository bootstrap remain fixed. Saved files and previous workloads are preserved. An exact retry of already applied settings succeeds. Conflicting changes require reloading and reviewing the current configuration.

patch/v1/research-workspaces/{id}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    HTTP bearer

Path parameters

idstring required

Saved workspace identifier.

Request body

configuration_revisionstring required

Response

Current workspace with saved settings

idstring required
namestring required
size_gbnumber required
holder_idstring nullable required
saved_atstring date-time nullable required
expired_atstring date-time nullable

Time the tenant retention policy expired saved workspace state. The namespace remains listed.

cleanup_pendingboolean

Expired workspace objects still require cleanup. An empty namespace can be reused after cleanup settles.

stored_bytesinteger nullable required
last_errorstring required
saving_for_terminationboolean required
billing_status'disabled_no_approved_storage_rate' | 'metered_subject_to_account_limits' | 'included_workspace_storage' | 'account_workspace_storage' | 'ephemeral_instance' required

Storage billing policy for this record. ephemeral_instance has no saved storage or storage charge. Its compute session is billed separately.

configuration_revisionstring required

Saved configuration identity. Send this observed value when editing settings. Independent from the saved-file revision.

storage_revisioninteger required

Current saved-file revision used to guard a stopped-workspace replacement.

storage_policy_versionstring required

Storage policy recorded for this workspace. Transfer endpoints require a compatible versioned storage policy on the workspace and deployment.

state'stopped' | 'creating' | 'ready' | 'running' | 'idle' | 'suspended' | 'resuming' | 'recovering' | 'stopping' | 'failed' | 'freezing' | 'frozen' required

Workspace lifecycle view. stopping includes a pending final save or unconfirmed compute release. Tool access also requires its connections flag.

status_messagestring required

Changes

    • info

      added the optional property ////// to the response with the status

    • breaking

      added subschema #1 to the request property allOf list

    • breaking

      added 'else' subschema to the request property

    • breaking

      added 'if' subschema to the request property

    • breaking

      added 'then' subschema to the request property

    • breaking

      the response property // became optional for the status

    • breaking

      the // response property's min was decreased from 0.00 to 0.00 for the response status

    • breaking

      the // response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      removed the required property // from the response with the status

    • warning

      the / request property's min was set to 0.00

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new 0.00 enum value to the // response property for the response status

    • warning

      added the new custom-cpu enum value to the // response property for the response status

    • warning

      added the new custom-cuda enum value to the // response property for the response status

    • warning

      added the new custom-rocm enum value to the // response property for the response status

    • warning

      added the new ephemeral_instance enum value to the //// response property for the response status

    • warning

      added the new pytorch-cpu enum value to the // response property for the response status

    • warning

      added the new pytorch-rocm enum value to the // response property for the response status

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      the request property / became optional

    • info

      added the new 0.00 enum value to the request property /

    • info

      added the new custom-cpu enum value to the request property /

    • info

      added the new custom-cuda enum value to the request property /

    • info

      added the new custom-rocm enum value to the request property /

    • info

      added the new pytorch-cpu enum value to the request property /

    • info

      added the new pytorch-rocm enum value to the request property /

    • info

      the / request property's min was decreased from 0.00 to 0.00

    • info

      the / request property's minLength was decreased from 1 to 0

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added subschema #1 to the / response property allOf list for the response status

    • info

      response property allOf[subschema #2]/session/oneOf[Sandbox]/envelope/outcome/max_cost_usd deprecated

    • info

      added 'else' subschema to the / response property for the status

    • info

      added 'if' subschema to the / response property for the status

    • info

      added 'then' subschema to the / response property for the status