Skip to main content
GET
/
runs
/
{run_id}
Get a canonical durable run
curl --request GET \
  --url https://api.veryfront.com/runs/{run_id} \
  --header 'Authorization: Bearer <token>'
{
  "run_id": "<string>",
  "owner": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "parent_run_id": "<string>",
  "root_run_id": "<string>",
  "target": "<string>",
  "workflow_id": "<string>",
  "schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "runtime_target_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "runtime_target_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "error": {
    "message": "<string>",
    "code": "<string>"
  },
  "logs": "<string>",
  "artifacts": [
    null
  ],
  "duration_ms": 123,
  "exit_code": 123,
  "start_mode": "<string>",
  "timeout_seconds": 123,
  "backoff_limit": 123,
  "trigger_id": "<string>",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "<string>",
  "created_at": "<string>",
  "started_at": "<string>",
  "completed_at": "<string>",
  "metadata": null,
  "input": null,
  "config": null,
  "output": null
}

Authorizations

​
Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

​
run_id
string
required
Minimum string length: 1

Response

200 - application/json

Run summary

​
run_id
string
required
Minimum string length: 1
​
kind
enum<string>
required
Available options:
agent,
workflow,
task
​
status
enum<string>
required
Available options:
pending,
running,
waiting,
completed,
failed,
cancelled
​
owner
object
required
​
parent_run_id
string | null
required
Minimum string length: 1
​
root_run_id
string
required
Minimum string length: 1
​
waiting_reason
enum<string> | null
required
Available options:
tool,
approval,
event,
input
​
target
string | null
required
​
workflow_id
string | null
required
​
schedule_id
string<uuid> | null
required
​
batch_id
string<uuid> | null
required
​
runtime_target_kind
enum<string> | null
required

Provide the runtime target kind.

Available options:
main_branch,
environment,
preview_branch
​
runtime_target_environment_id
string<uuid> | null
required
​
runtime_target_branch_id
string<uuid> | null
required
​
error
object
required
​
logs
string | null
required
​
artifacts
null[]
required
​
duration_ms
integer | null
required
​
exit_code
integer | null
required
​
start_mode
string | null
required
​
timeout_seconds
integer | null
required
​
backoff_limit
integer | null
required
​
trigger_kind
enum<string> | null
required
Available options:
manual,
schedule,
webhook,
api
​
trigger_id
string | null
required
​
created_by
string<uuid> | null
required
​
updated_at
string
required
​
created_at
string
required
​
started_at
string | null
required
​
completed_at
string | null
required
​
metadata
unknown
​
input
unknown
​
config
unknown
​
output
unknown