Skip to content
Kindgi

Publish a flow definition

POST
/v1/flows
curl --request POST \
  --url https://example.com/v1/flows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "example", "version": "example", "name": "example", "description": "example", "projectId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "nodes": [ { "id": "example", "kind": "tool", "ref": "example", "config": {} } ], "edges": [ { "id": "example", "from": "example", "to": "example", "when": {}, "policy": {} } ], "maxParallelism": 1, "metadata": {} }'

Body is a full flow JSON. Server validates via @kindgi/flow.loadFlow before persisting. Node handler code is not uploaded through this route.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
>= 1 characters

Caller-supplied idempotency key. Retries with the same key return the original response byte-identical (per docs/API-ROUTE-CONVENTIONS.md §3.1).

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Full flow definition. Validated server-side via @kindgi/flow.loadFlow — validation failures return 400 validation-failed with the issue list under details.issues.

object
id
required
string
version
required
string
name
string
description
string
projectId
required

Project this belongs to (its content scope). Required: missing, or not a project in the caller’s tenant → 400 bad-input.

string format: uuid
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

Responses

Section titled “Responses”

201

Section titled “201”

Flow published.

Media typeapplication/json
object
flowId
required
string
version
required
string
Examplegenerated
{
  "flowId": "example",
  "version": "example"
}

400

Section titled “400”

Validation failed (see details.issues).

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

409

Section titled “409”

Flow already registered at that (id, version).

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

500

Section titled “500”

Server error (unmapped domain code or framework crash).

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