NOnodus-compute
Research workspaces

Save project files and stop the specified compute session

Changed on

Stops the original session_id, not whichever replacement session exists when a retry arrives. Preserve both session_id and Idempotency-Key for every retry. A new stop targeting a replacement requires a new pair. Returns the current workspace view, which may refer to a newer session during a delayed replay. Poll state and saving_for_termination to observe final-save and compute-release progress. A 200 response alone does not confirm supplier resource release. Retained storage is not deleted.

post/v1/research-workspaces/{id}/stop

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.

Headers

Idempotency-Keystring required

Stable retry key paired with the original session_id in the request body.

Request body

session_idstring required

Original session.id to stop, owned by this account and workspace. Retain this exact value with the Idempotency-Key when retrying. A retry never selects a newer replacement session.

Response

Stop handled or replayed without a pending final save. Inspect workspace state for compute-release progress.

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

  • 5805e96227f4Revision changes
    • info

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

    • info

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

  • ba84c74aeec8Revision changes
    • breaking

      the response property // became optional for the status

    • 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 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

      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

    • breaking

      removed the required 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

      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

      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 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-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-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 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 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-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

    • warning

      added the new pytorch-rocm enum value to the // response property for the response 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 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 the optional property ////// to the response with the status

    • info

      added subschema #1 to the / response property allOf list for the response 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

      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 'else' subschema to the / response property for the status

    • info

      added 'if' 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

    • info

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