Get run

cURL

curl --request GET \
  --url https://api.staging.qyl.dev/api/v1/workflows/runs/{runId}

const options = {method: 'GET'};

fetch('https://api.staging.qyl.dev/api/v1/workflows/runs/{runId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.staging.qyl.dev/api/v1/workflows/runs/{runId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.qyl.dev/api/v1/workflows/runs/{runId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.staging.qyl.dev/api/v1/workflows/runs/{runId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "workflow_id": "<string>",
  "workflow_version": 123,
  "project_id": "<string>",
  "trigger_type": "manual",
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "trigger_source": "<string>",
  "input_json": "<string>",
  "output_json": "<string>",
  "error_message": "<string>",
  "parent_run_id": "<string>",
  "correlation_id": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "duration_ms": 123
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "resource_type": "<string>",
  "resource_id": "<string>"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "error_code": "<string>"
}

GET

api

workflows

runs

{runId}

cURL

curl --request GET \
  --url https://api.staging.qyl.dev/api/v1/workflows/runs/{runId}

const options = {method: 'GET'};

fetch('https://api.staging.qyl.dev/api/v1/workflows/runs/{runId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.staging.qyl.dev/api/v1/workflows/runs/{runId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.qyl.dev/api/v1/workflows/runs/{runId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.staging.qyl.dev/api/v1/workflows/runs/{runId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "workflow_id": "<string>",
  "workflow_version": 123,
  "project_id": "<string>",
  "trigger_type": "manual",
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "trigger_source": "<string>",
  "input_json": "<string>",
  "output_json": "<string>",
  "error_message": "<string>",
  "parent_run_id": "<string>",
  "correlation_id": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "duration_ms": 123
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "resource_type": "<string>",
  "resource_id": "<string>"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "error_code": "<string>"
}

Path Parameters

runId

string

required

Response

The request has succeeded.

Top-level workflow execution

string

required

Run ID

workflow_id

string

required

Workflow definition ID

workflow_version

integer<int32>

required

Workflow definition version

project_id

string

required

Owning project

trigger_type

enum<string>

required

Trigger type

Available options:

manual,

alert,

schedule,

event,

api,

mcp

status

enum<string>

required

Run status

Available options:

pending,

running,

paused,

completed,

failed,

cancelled,

timed_out

created_at

string<date-time>

required

Creation timestamp

trigger_source

string

Trigger source identifier

input_json

string

Run input data

output_json

string

Run output data

error_message

string

Error message if failed

parent_run_id

string

Parent run ID for sub-workflows

correlation_id

string

Correlation ID for tracing

started_at

string<date-time>

Start timestamp

completed_at

string<date-time>

Completion timestamp

duration_ms

integer<int32>

Duration in milliseconds

Getting Started

Features

API Reference

Alerts

Configurator

Deployments

Errors

Issues

Logs

Metrics

Onboarding

Search

Services

Sessions

Streaming

Traces

Workflows

Workspaces

Health

Path Parameters

Response