Back to Trigger

Run Object

docs/snippets/realtime/run-object.mdx

4.4.54.3 KB
Original Source
<ParamField path="id" type="string" required> The run ID. </ParamField> <ParamField path="taskIdentifier" type="string" required> The task identifier. </ParamField> <ParamField path="payload" type="object" required> The input payload for the run. </ParamField> <ParamField path="output" type="object"> The output result of the run. </ParamField> <ParamField path="createdAt" type="Date" required> Timestamp when the run was created. </ParamField> <ParamField path="updatedAt" type="Date" required> Timestamp when the run was last updated. </ParamField> <ParamField path="number" type="number" required> Sequential number assigned to the run. </ParamField> <ParamField path="status" type="RunStatus" required> Current status of the run. <Accordion title="RunStatus enum">
StatusDescription
WAITING_FOR_DEPLOYTask hasn't been deployed yet but is waiting to be executed
QUEUEDRun is waiting to be executed by a worker
EXECUTINGRun is currently being executed by a worker
REATTEMPTINGRun has failed and is waiting to be retried
FROZENRun has been paused by the system, and will be resumed by the system
COMPLETEDRun has been completed successfully
CANCELEDRun has been canceled by the user
FAILEDRun has been completed with errors
CRASHEDRun has crashed and won't be retried, most likely the worker ran out of resources, e.g. memory or storage
INTERRUPTEDRun was interrupted during execution, mostly this happens in development environments
SYSTEM_FAILURERun has failed to complete, due to an error in the system
DELAYEDRun has been scheduled to run at a specific time
EXPIREDRun has expired and won't be executed
TIMED_OUTRun has reached it's maxDuration and has been stopped
</Accordion> </ParamField> <ParamField path="durationMs" type="number" required> Duration of the run in milliseconds. </ParamField> <ParamField path="costInCents" type="number" required> Total cost of the run in cents. </ParamField> <ParamField path="baseCostInCents" type="number" required> Base cost of the run in cents before any additional charges. </ParamField> <ParamField path="tags" type="string[]" required> Array of tags associated with the run. </ParamField> <ParamField path="idempotencyKey" type="string"> Key used to ensure idempotent execution. </ParamField> <ParamField path="expiredAt" type="Date"> Timestamp when the run expired. </ParamField> <ParamField path="ttl" type="string"> Time-to-live duration for the run. </ParamField> <ParamField path="finishedAt" type="Date"> Timestamp when the run finished. </ParamField> <ParamField path="startedAt" type="Date"> Timestamp when the run started. </ParamField> <ParamField path="delayedUntil" type="Date"> Timestamp until which the run is delayed. </ParamField> <ParamField path="queuedAt" type="Date"> Timestamp when the run was queued. </ParamField> <ParamField path="metadata" type="Record<string, DeserializedJson>"> Additional metadata associated with the run. </ParamField> <ParamField path="error" type="SerializedError"> Error information if the run failed. </ParamField> <ParamField path="isTest" type="boolean" required> Indicates whether this is a test run. </ParamField>