Research workspaces

Submit an independent workload from this project

Changed on

Captures current project files from ready compute, or pins the last successful saved revision while stopped. The command uses that immutable project revision and the workspace environment image. Optional GPU overrides apply only to the submitted workload. Running workspace capture returns 409 workspace_save_pending until saving finishes. Source preparation returns 409 workspace_source_pending until its verified copy is ready. Saving has a 45-minute deadline. Each source preparation attempt has a 45-minute deadline, with up to three automatic attempts. Cleanup waits may extend total preparation. Console and SDK waiting pause local observation after 95 minutes by default while retaining the submission intent. Reuse the exact body and Idempotency-Key to check progress or retry an uncertain reply. Identical captured revisions reuse a source copy within the included account source pool. Exports exclude .nodus and .git. Regular files, empty directories and safe relative symbolic links within the project are preserved. Unsafe links and unsupported file types are rejected before admission. A 202 response means ordinary workload admission succeeded. It does not establish execution or completion. Later edits and stopping workspace compute do not stop an admitted workload. Both incur charges while running.

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

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

Workspace identifier owned by this account.

Headers

Idempotency-Keystring required

Stable key for this logical submission and its captured source revision. Reuse the same body and key after saving is pending or the reply is uncertain.

Request body

commandstring required

Command run from the captured project directory through the environment shell. Whitespace-only commands, NUL characters and commands longer than 8192 UTF-8 bytes are rejected.

budget_usdnumber

Deprecated compatibility field. Customer spending limits are not enforced.

gpustring

Optional GPU model override. Omit or send an empty string to inherit the workspace configuration.

gpu_count0 | 1 | 2 | 4 | 8

Exact GPUs on one machine. Omitted or zero inherits the workspace configuration.

gpu_memory_gbnumber

Memory per GPU in GB. Omitted or zero inherits the workspace configuration.

Response

Independent workload admitted or replayed

idstring required
workload_idstring required
statusstring required
revisioninteger required

Changes