GET
/
clusters
/
{clusterId}
/
runs
/
{runId}

The /clusters/{clusterId}/runs/{runId} endpoint will return details for a single run, including its status and result (if available).

A run may take some time to complete. You can inspect the status to determine if it is finished:

StatusDescription
pendingThe Run has been created but not yet started processing.
runningThe Run is currently processing the agent loop.
pausedThe Run is paused (e.g., waiting for an approval).
doneThe Run has completed. A result and summary should have been produced.
failedThe Run failed. Please see failureReason for more information.

Please see OnStatusChange for details on an asynchronous alternative for receiving Run results.

Headers

​
authorization
string
required

Path Parameters

​
clusterId
string
required
​
runId
string
required

Response

200 - application/json
​
attachedFunctions
string[] | null
required
​
failureReason
string | null
required
​
feedbackComment
string | null
required
​
feedbackScore
number | null
required
​
id
string
required
​
result
object | null
required
​
status
enum<string> | null
required
Available options:
pending,
running,
paused,
done,
failed
​
tags
object | null
required
​
test
boolean
required
​
userId
string | null
required
​
authContext
any | null
​
context
any | null

Was this page helpful?

Suggest edits
List RunsCreate a Run