v1
sweeps

Patch Sweep V1

patch/v1/sweeps/{public_id}

Request

  • Base URL: https://thrustlab.com
  • URL: https://thrustlab.com/v1/sweeps/{public_id}
  • Auth: HTTP bearer

Path parameters

public_idstring required

Request body

is_starredboolean nullable
namestring nullable
plot_config_jsonobject[] nullable
project_idstring nullable

Move this sweep into another project (raw UUID or proj_<ksuid>). The project must belong to the caller.

Response

Successful Response

analysis_typestring required
battery_component_idstring required
cancel_requested_atstring nullable

When a cancel was requested for a RUNNING sweep. The status stays running until the worker honours it at its next point, keeping the points already solved. Null when no cancel was requested; a QUEUED sweep cancels immediately instead and never sets this.

completed_atstring nullable

When the sweep reached a terminal state — completed, failed or canceled. Null until then.

completed_pointsinteger required
created_atstring nullable

When the sweep was submitted.

credits_costinteger required
dispatched_atstring nullable

When the sweep was handed to the worker queue. Null while it is parked and has never been dispatched. NOT the start of execution: launch_intent=run dispatches at submit, so this can equal created_at while the sweep waits for a slot.

errorobject nullable required
idstring required
input_snapshotobject nullable
is_starredboolean required
namestring nullable required
object'sweep' required
plot_config_jsonobject[] nullable required
progressnumber nullable required
project_idstring required
propeller_modelstring
snapshot_versioninteger
solver_enginestring
started_atstring nullable

When a worker claimed the sweep and solving began. Null until then. started_at - dispatched_at is the wait for a slot; completed_at - started_at is the solve itself.

status'draft' | 'queued' | 'running' | 'completed' | 'failed' | 'canceled' required
summaryobject nullable required
sweep_configobject nullable required
total_pointsinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.