Skip to content
Kindgi

Fetch the latest version of a flow

GET
/v1/flows/{flowId}
curl --request GET \
  --url https://example.com/v1/flows/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
flowId
required
string

FlowId — dotted namespace (acme.ingest-invoice).

Responses

Section titled “Responses”

200

Section titled “200”

Flow.

Media typeapplication/json
object
id
required

FlowId — dotted namespace (e.g. ingest.contract-pdf).

string
version
required

Semver.

string
name
string
description
string
nodes
required
Array<object>
object
id
required
string
kind
required
string
Allowed values: tool agent loop fanout subgraph
ref

Handler reference for leaf nodes.

string
config
object
key
additional properties
any
key
additional properties
any
edges
required
Array<object>
object
id
required
string
from
required

Source node id or $start sentinel.

string
to
required

Destination node id or $end sentinel.

string
when

Optional predicate expression evaluated at edge dispatch time (see @kindgi/flow).

object
key
additional properties
any
policy

Optional per-edge runtime policy (retry, timeoutMs, …).

object
key
additional properties
any
maxParallelism
integer
>= 1
metadata
object
key
additional properties
any
Example
{
  "nodes": [
    {
      "kind": "tool"
    }
  ]
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No flow with that id under this tenant.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}