curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/workers/runs/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/workers/runs/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/workers/runs/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Successful request"
},
"data": {
"id": "9f2c4e7a1b3d4f6a8c0e2b4d6f8a0c1e",
"status": "awaiting_approval",
"trigger": {
"type": "chat"
},
"startedAt": "2026-11-05T10:12:02.000Z",
"endedAt": null,
"threadId": "3fa9c2d17b4e",
"taskId": null,
"steps": [
{
"seq": 1,
"type": "worker",
"title": "Account researcher",
"status": "completed",
"startedAt": "2026-11-05T10:12:05.000Z",
"endedAt": "2026-11-05T10:12:31.000Z",
"summary": "Contoso moved to Negotiation on Tuesday. Procurement asked for a security review."
},
{
"seq": 2,
"type": "approval",
"title": "send_email",
"status": "pending",
"startedAt": "2026-11-05T10:12:38.000Z",
"endedAt": null,
"summary": null
}
],
"reviews": [
{
"id": "6729d2f0a1b2c3d4e5f6a7b8",
"status": "PENDING",
"type": "email_draft"
}
],
"usage": {
"credits": 5,
"requests": 7,
"inputTokens": 40120,
"outputTokens": 1210,
"totalTokens": 41330
},
"title": "Contoso follow-up",
"agentName": "Heliyos",
"surface": "chat",
"error": null,
"workers": [
{
"nodeId": "w1",
"agentId": "6720f3a1b2c3d4e5f6a7b8c9",
"agentName": "Account researcher",
"status": "completed"
}
],
"toolCalls": 4,
"createdAt": "2026-11-05T10:12:02.000Z"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}Get a run
Returns one run: its status, what set it off, every step with a one-line summary, the reviews it raised, its credit and model usage, and its final reply once it has one.
Send wait to long-poll: the call holds for up to that many seconds while the run is queued or
running, and returns as soon as it finishes or starts waiting on a person or a schedule. A run
that is already in one of those states returns at once.
include=detail adds the title, error, the workers that took part and the tool-call count.
include=step_payloads adds each step’s raw input, output and error, and the execution graph;
these can be large.
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/workers/runs/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/workers/runs/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/workers/runs/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Successful request"
},
"data": {
"id": "9f2c4e7a1b3d4f6a8c0e2b4d6f8a0c1e",
"status": "awaiting_approval",
"trigger": {
"type": "chat"
},
"startedAt": "2026-11-05T10:12:02.000Z",
"endedAt": null,
"threadId": "3fa9c2d17b4e",
"taskId": null,
"steps": [
{
"seq": 1,
"type": "worker",
"title": "Account researcher",
"status": "completed",
"startedAt": "2026-11-05T10:12:05.000Z",
"endedAt": "2026-11-05T10:12:31.000Z",
"summary": "Contoso moved to Negotiation on Tuesday. Procurement asked for a security review."
},
{
"seq": 2,
"type": "approval",
"title": "send_email",
"status": "pending",
"startedAt": "2026-11-05T10:12:38.000Z",
"endedAt": null,
"summary": null
}
],
"reviews": [
{
"id": "6729d2f0a1b2c3d4e5f6a7b8",
"status": "PENDING",
"type": "email_draft"
}
],
"usage": {
"credits": 5,
"requests": 7,
"inputTokens": 40120,
"outputTokens": 1210,
"totalTokens": 41330
},
"title": "Contoso follow-up",
"agentName": "Heliyos",
"surface": "chat",
"error": null,
"workers": [
{
"nodeId": "w1",
"agentId": "6720f3a1b2c3d4e5f6a7b8c9",
"agentName": "Account researcher",
"status": "completed"
}
],
"toolCalls": 4,
"createdAt": "2026-11-05T10:12:02.000Z"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}heliyos_runs_get.Authorizations
A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.
Path Parameters
The run id (runId from Ask Heliyos, or orchestratorRunId from List runs).
1 - 128^[A-Za-z0-9_.:@=+-]+$Query Parameters
Seconds to wait for the run to finish or stop on a person, 0 to 30. Defaults to 0 (answer at once). Seconds to long-poll until the run finishes or waits on a person (0 = answer at once).
0 <= x <= 30Comma-separated extras: detail, step_payloads, or both (detail,step_payloads).
Comma list. detail: title, surface, error, workers, toolCalls, createdAt (the run view). step_payloads: each step's raw input, output and error, and the execution graph.
^(detail|step_payloads)(,(detail|step_payloads))*$Was this page helpful?

