CreateRunPayload
POST /runs.
Parameters
Maximum execution time in seconds, measured from when the
workload starts running. Time spent queued or starting infrastructure does
not count.
CreateTaskRunPayload
POST /tasks/{taskName}/runs. inputs must match the task’s
input_schema.
Parameters
DataValue
Parameters
DirectoryPage
Parameters
DownloadUrlResponse
Parameters
ErrorBody
Parameters
ErrorInfo
Parameters
Machine-readable facts about the error a client can act on, when there are
any
FileDependency
Parameters
FileEntry
Parameters
is_dir
True for a folder.
FileUploadUrl
Parameters
InstantMetric
Parameters
InstantMetricDetails
Parameters
KubeAppCreationMeta
event_meta shape for EventCode.APP_START_CREATION.
Parameters
KubeAppEvent
Parameters
LogItem
Parameters
LogsResponse
GET /runs/{id}/logs.
Parameters
NodeSchedulingMeta
Parameters
OffsetPage
Parameters
next_offset
offset of the next page, or None on the last page.
OrganizationCustomer
Parameters
PyPiDependency
Parameters
ResolvedFileDependency
Parameters
ResolvedRunEnvironment
Parameters
RunAppMeta
Parameters
RunEnvironment
Parameters
RunEventMeta
Parameters
RunJarPayload
Parameters
RunKubeApp
Parameters
RunListPage
GET /runs.
Parameters
cursor
next_page, kept for backward compatibility.
RunMetricsResponse
GET /runs/{id}/metrics.
Parameters
instant_value()
Parameters
Returns
RunPayload
Parameters
Maximum execution time in seconds, measured from when the
workload starts running. Time spent queued or starting infrastructure does
not count.
RunPythonPayload
Parameters
RunView
GET /runs/{id}.
Parameters
app_meta
completed_at
complete_time, kept for backward compatibility.
created_at
create_time, kept for backward compatibility.
environment
is_terminal
True once the run has finished, by the server’s word when it gives one.
region
run_jar
run_python
runtime
started_at
start_time, kept for backward compatibility.
timeout_seconds
version
SeriesMetric
Parameters
SeriesMetricDetails
Parameters
StorageCredentialsRequest
Parameters
Access mode for the credentials. ‘read’ returns read-only
credentials; ‘read_write’ returns credentials that also allow writing.
Minimal preserves requested-path scoping. Default opts into
credentials for a server-selected authorized scope, returned as
matchedGrantTarget. Underlying IAM restrictions still apply within that
scope.
StorageCredentialsResponse
Parameters
Returned for Default privilege when the scope has no
competing credential sources. If absent, cache only for the exact request. A
trailing slash denotes descendants only; otherwise match the exact path or
slash-delimited descendants. Reuse requires the same access mode and
unexpired credentials.
StorageIntegration
Parameters
is_managed
True if Wherobots manages this storage source.
Task
GET /tasks/{taskName}.
Parameters
TaskExample
Parameters
TaskRun
GET /task-runs/{taskRunId}.
Parameters
Named outputs of a succeeded platform task run. Null for script task
runs (including all scheduled runs), runs that did not succeed, and when
outputs are temporarily unavailable.
What batchTime means: tick for a scheduled time, gap for a pause or
schedule edit. Null when batchTime is null.
Whether the run returned a result stored by an earlier run of the same
task with the same inputs, instead of executing. Only a run that succeeded
stores its result; one that failed or was cancelled is never reused. False
until the run has ended.
How long the run executed, from its start to its end (or to
now, while running). 0 if it never started. A cached run executes nothing,
so this is the moment it took to return the stored result, not how long the
result took to produce.
Why a failed or timed-out run failed, when more is known than its
failureClass: a short, user-safe reason the caller can act on (for example a
configuration rejection such as an unavailable runtime), or, for a run that
could not be started, a task run ID to quote to support. Null for cancelled
runs and when nothing beyond failureClass is known. REJECTED runs explain
their input problems on getTaskRun; their summaries in run lists and
schedule history remain null.
The job run request the run launched, or the request it was
about to launch if it never started. Files it references may have changed
since.
Workload execution start time, after queueing and infrastructure
startup.
is_active
True while the run may still change state.
output
Returns
Raises
WherobotsTaskRunError: The run has not succeeded, has no results, or has several outputs (readresultsfor those).
TaskRunCost
Parameters
TaskRunLogEntry
Parameters
A UTC instant carried to the nanosecond, e.g.
‘2026-06-04T18:01:12.680610267Z’. A string, not a date-time: log timestamps
are nanoseconds, and most date-time parsers round them off to microseconds.
Emitted with as many fractional digits as the value needs, up to 9; 0 to 9
are accepted.
TaskRunLogs
Parameters
TaskRunSummary
Parameters
What batchTime means: tick for a scheduled time, gap for a pause or
schedule edit. Null when batchTime is null.
How long the run executed, from its start to its end (or to
now, while running). 0 if it never started. A cached run executes nothing,
so this is the moment it took to return the stored result, not how long the
result took to produce.
Why a failed or timed-out run failed, when more is known than its
failureClass: a short, user-safe reason the caller can act on (for example a
configuration rejection such as an unavailable runtime), or, for a run that
could not be started, a task run ID to quote to support. Null for cancelled
runs and when nothing beyond failureClass is known. REJECTED runs explain
their input problems on getTaskRun; their summaries in run lists and
schedule history remain null.
Workload execution start time, after queueing and infrastructure
startup.
is_active
True while the run may still change state.
TaskRunSummaryPage
Parameters
next_offset
offset of the next page, or None on the last page.
TaskRunWorkload
Parameters
TaskSummary
organization_id marks a platform
task.
Parameters
TaskSummaryPage
Parameters
next_offset
offset of the next page, or None on the last page.
TemporaryAwsCredentials
POST /storage/credentials.
Scope is determined server-side from the requested S3 path: the
server picks the right backing bucket (managed / releases /
matching Storage Integration).
Security posture:
- Masked in repr/str.
repr(creds)(and thereforestr(creds)and any f-string interpolation) only show the last 4 characters of the access key ID. Secret + session token never appear. - Frozen. Attribute injection is rejected;
wipe()is the only mutator (viaobject.__setattr__internally). - No pickle / copy.
__reduce__,__copy__, and__deepcopy__raiseTypeErrorso creds cannot be silently serialized to disk, queues, or another process. - Local eviction via
wipe(). Zeros the secret fields and poisonsexpirationso any subsequentis_expiredcheck returnsTrue. Python strings are immutable so the original bytes may linger on the heap until garbage collection, but this drops our last live reference. AWS-side revocation is not possible via the SDK; rely on the short TTL (typically 1 h).
Parameters
from_response()
getStorageCredentials response.
Parameters
Returns
Raises
WherobotsAPIError: If a secret field is empty. The message names the field only, never a value.
is_expired()
Parameters
wipe()
access_key_id / secret_access_key /
session_token with empty strings and forces expiration
into the past so any post-wipe reuse is detected by
is_expired. Idempotent; safe to call multiple times.
UtilizationStats
series holds the (timestamp, value) points the server reported. latest,
max and avg are derived from it. All fields are None or empty when the
metric was not present in the response.

