POST
/
flows
/
{name}
/
runs
Start a run
curl --request POST \
  --url http://localhost:8080/flows/{name}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "wireless headphones",
  "threshold": 80
}
'
import requests

url = "http://localhost:8080/flows/{name}/runs"

payload = {
"query": "wireless headphones",
"threshold": 80
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: 'wireless headphones', threshold: 80})
};

fetch('http://localhost:8080/flows/{name}/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/flows/{name}/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => 'wireless headphones',
'threshold' => 80
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "http://localhost:8080/flows/{name}/runs"

payload := strings.NewReader("{\n \"query\": \"wireless headphones\",\n \"threshold\": 80\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("http://localhost:8080/flows/{name}/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"wireless headphones\",\n \"threshold\": 80\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:8080/flows/{name}/runs")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"wireless headphones\",\n \"threshold\": 80\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "flow_digest": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "journal": [
    {
      "event": "<string>",
      "at": "2023-11-07T05:31:56Z",
      "flow_digest": "<string>",
      "inputs_digest": "<string>"
    }
  ],
  "finished_at": "2023-11-07T05:31:56Z",
  "output": "<unknown>"
}
{
"id": "<string>",
"flow_digest": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"journal": [
{
"event": "<string>",
"at": "2023-11-07T05:31:56Z",
"flow_digest": "<string>",
"inputs_digest": "<string>"
}
],
"finished_at": "2023-11-07T05:31:56Z",
"output": "<unknown>"
}
{
"code": "<string>",
"message": "<string>"
}
{
"code": "<string>",
"message": "<string>"
}

承認

Authorization
string
header
必須

A bearer token issued by the control plane. RBAC scopes which flows a token may run or read; secret values are never exposed regardless of role.

パスパラメータ

name
string
必須

The deployed flow name.

クエリパラメータ

wait
boolean
デフォルト:true

Block until the run finishes (synchronous). Defaults to true; set false for fire-and-poll.

ボディ

application/json

The flow's typed inputs as a JSON object (keys are the flow's input names).

The flow's typed inputs as a JSON object keyed by input name.

レスポンス

Synchronous run completed.

One execution of a FlowSpec, with its append-only Journal.

id
string
必須

uuidv4.

flow_digest
string
必須

Exactly which FlowSpec ran.

status
enum<string>
必須
利用可能なオプション:
pending,
running,
succeeded,
failed,
canceled
started_at
string<date-time>
必須
journal
(run_started · object | step_started · object | step_succeeded · object | step_failed · object | step_skipped · object | effect_recorded · object | run_finished · object)[]
必須

One append-only, content-addressed step-lifecycle event. Discriminated by event.

finished_at
string<date-time>
output
any

The flow's output projection (any JSON value). Absent until the run succeeds.