Skip to content
Kindgi

List flows

GET
/v1/flows
curl --request GET \
  --url 'https://example.com/v1/flows?limit=25&scopeKind=tenant&inherit=true' \
  --header 'Authorization: Bearer <token>'

Cursor-paginated list of the latest version per flow id. Optional ?name= filters by prefix on flow id.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 25 >= 1 <= 100

1..100. Default 25.

cursor
string

Opaque cursor from a prior response. Absent → first page.

name
string

Prefix match on flow id.

scopeKind

Discriminator for the ?scopeKind + ?scopeId + ?inherit triplet. Tenant carries no id (implicit from session); org/project require scopeId.

string
Allowed values: tenant org project

Optional scope discriminator. If absent, no scope filter is applied.

scopeId
string
>= 1 characters

Required IF scopeKind is org or project. MUST be absent if scopeKind=tenant (tenant is implicit from the session). Malformed combinations return 400 scope-invalid.

inherit
boolean
default: true

Default true. false = literal-at-this-scope only (admin/audit view). Load-bearing for policy/config-scoped resources (mcp-endpoints); documented no-op for content-scoped resources (agents/flows/tools/…).

Responses

Section titled “Responses”

200

Section titled “200”

Page of flows.

Media typeapplication/json
object
data
required
Array<object>
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
nextCursor

Opaque cursor for the next page. Absent when hasMore: false.

string
hasMore
required
boolean
Example
{
  "data": [
    {
      "nodes": [
        {
          "kind": "tool"
        }
      ]
    }
  ]
}

400

Section titled “400”

Malformed query parameter.

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"
  }
}

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"
  }
}