Create Definition

POST /v2/workflow/definitions/create

Create Definition

cURL

curl --request POST \
  --url https://api.velt.dev/v2/workflow/definitions/create \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "definitionId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "scope": {},
    "nodes": [
      {}
    ],
    "edges": [
      {}
    ],
    "groups": [
      {}
    ],
    "triggers": [
      {}
    ],
    "tags": [
      "<string>"
    ],
    "custom": {},
    "organizationId": "<string>",
    "documentId": "<string>"
  }
}
'

import requests

url = "https://api.velt.dev/v2/workflow/definitions/create"

payload = { "data": {
        "definitionId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "scope": {},
        "nodes": [{}],
        "edges": [{}],
        "groups": [{}],
        "triggers": [{}],
        "tags": ["<string>"],
        "custom": {},
        "organizationId": "<string>",
        "documentId": "<string>"
    } }
headers = {
    "x-velt-api-key": "<x-velt-api-key>",
    "x-velt-auth-token": "<x-velt-auth-token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-velt-api-key': '<x-velt-api-key>',
    'x-velt-auth-token': '<x-velt-auth-token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data: {
      definitionId: '<string>',
      name: '<string>',
      description: '<string>',
      scope: {},
      nodes: [{}],
      edges: [{}],
      groups: [{}],
      triggers: [{}],
      tags: ['<string>'],
      custom: {},
      organizationId: '<string>',
      documentId: '<string>'
    }
  })
};

fetch('https://api.velt.dev/v2/workflow/definitions/create', 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.velt.dev/v2/workflow/definitions/create",
  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([
    'data' => [
        'definitionId' => '<string>',
        'name' => '<string>',
        'description' => '<string>',
        'scope' => [
                
        ],
        'nodes' => [
                [
                                
                ]
        ],
        'edges' => [
                [
                                
                ]
        ],
        'groups' => [
                [
                                
                ]
        ],
        'triggers' => [
                [
                                
                ]
        ],
        'tags' => [
                '<string>'
        ],
        'custom' => [
                
        ],
        'organizationId' => '<string>',
        'documentId' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-velt-api-key: <x-velt-api-key>",
    "x-velt-auth-token: <x-velt-auth-token>"
  ],
]);

$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 := "https://api.velt.dev/v2/workflow/definitions/create"

	payload := strings.NewReader("{\n  \"data\": {\n    \"definitionId\": \"<string>\",\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"scope\": {},\n    \"nodes\": [\n      {}\n    ],\n    \"edges\": [\n      {}\n    ],\n    \"groups\": [\n      {}\n    ],\n    \"triggers\": [\n      {}\n    ],\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"custom\": {},\n    \"organizationId\": \"<string>\",\n    \"documentId\": \"<string>\"\n  }\n}")

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

	req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
	req.Header.Add("x-velt-auth-token", "<x-velt-auth-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("https://api.velt.dev/v2/workflow/definitions/create")
  .header("x-velt-api-key", "<x-velt-api-key>")
  .header("x-velt-auth-token", "<x-velt-auth-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"definitionId\": \"<string>\",\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"scope\": {},\n    \"nodes\": [\n      {}\n    ],\n    \"edges\": [\n      {}\n    ],\n    \"groups\": [\n      {}\n    ],\n    \"triggers\": [\n      {}\n    ],\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"custom\": {},\n    \"organizationId\": \"<string>\",\n    \"documentId\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.velt.dev/v2/workflow/definitions/create")

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

request = Net::HTTP::Post.new(url)
request["x-velt-api-key"] = '<x-velt-api-key>'
request["x-velt-auth-token"] = '<x-velt-auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"definitionId\": \"<string>\",\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"scope\": {},\n    \"nodes\": [\n      {}\n    ],\n    \"edges\": [\n      {}\n    ],\n    \"groups\": [\n      {}\n    ],\n    \"triggers\": [\n      {}\n    ],\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"custom\": {},\n    \"organizationId\": \"<string>\",\n    \"documentId\": \"<string>\"\n  }\n}"

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

{
  "result": {
    "definitionId": "marketing-copy-approval",
    "name": "Marketing copy approval",
    "description": null,
    "version": 1,
    "scope": { "level": "apiKey", "organizationId": null, "documentId": null },
    "nodes": [
      { "nodeId": "agent-draft", "type": "agent", "config": { "agentId": "copy-agent-v1" } }
    ],
    "edges": [],
    "groups": null,
    "compiled": { "forwardEdges": [], "loops": [] },
    "triggers": null,
    "tags": null,
    "custom": null,
    "createdAt": 1731432000000,
    "updatedAt": 1731432000000,
    "status": "active"
  }
}

Use this API to register a new workflow definition (the static blueprint of nodes, edges, and optional parallel groups). Definitions are validated at write time — schema errors, compileGraph edge-contract errors, and linter graph-shape errors are rejected with explicit validation keys.

Endpoint

POST https://api.velt.dev/v2/workflow/definitions/create

Headers

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

definitionId · string · required

^[a-z0-9][a-z0-9-]{2,63}$. Stable identifier for this definition.

name · string · required

1–200 chars. Human-readable label.

description · string

0–2000 chars.

scope · object

Defaults to { level: "apiKey" }. Options:

• { level: "apiKey" } — workspace-wide.
• { level: "organization", organizationId: "<id>" } — bound to one organization. organizationId is required (returns INVALID_ARGUMENT if omitted).
• { level: "document", organizationId: "<id>", documentId: "<id>" } — bound to one document under an organization. Both fields required.

When the response echoes scope.organizationId / scope.documentId, the values are the engine’s server-namespaced ids (hashed from your client ids), not the literal strings you sent. Don’t try to use them as your own identifiers — keep your client ids on your side.

nodes · array · required

1–100 nodes. Each node has nodeId, type (agent / human / webhook — webhook validates but its runtime is deferred in v1), and a config block. See node configuration details in Customize Behavior. Each node also accepts an optional slaMs (integer, ms) — SLA deadline for the step — and optional cosmetic name (1–200 chars) and description (≤ 2000 chars) labels echoed verbatim in the response.

edges · array · required

0–500 edges. Each edge: { from, to, on?, when?, loop? }. from / to are EdgeEndpoints — a bare node-id string, { kind: "node", nodeId }, or { kind: "group", groupId }.

Field	Type	Required	Notes
from	EdgeEndpoint	yes	Source node or group.
to	EdgeEndpoint	yes	Target node or group.
on	enum	no (default "always")	approve / reject / always / exhausted / custom. approve and reject auto-compile their predicates.
when	JSON-AST string	only when on:"custom"	Custom predicate over the source step’s output. Invalid on any other on role. See custom predicates.
loop	{ maxIterations }	only on an on:"reject" back-edge	maxIterations 1–20. Marks the reject edge as a loop-back; the server derives the loop region. A sibling on:"exhausted" edge handles cap exhaustion.

A human node must have an outgoing on:"reject" edge or the definition is rejected with APPROVAL_HUMAN_NODE_REQUIRES_REJECT_PATH. See the edge model for the full role and loop semantics.

groups · array

0–100 parallel-group definitions. See parallel groups and quorum policies.

A group can be an edge source (from: { kind: "group", groupId }): a waitAll group fans out a collective approve/reject decision by unanimity (every member approved → approve, else reject), and a cancelOnQuorum group fans out a collective approve successor on quorum. A forward on:"reject" from a joinOnQuorum / cancelOnQuorum group is a rejected dead edge. Edge-to-group fan-out (to: { kind: "group", groupId }) is accepted for all quorum policies.

triggers · array

0–50 trigger declarations. Each trigger has the shape { triggerId, eventName?, filters? }:

Field	Type	Required	Description
triggerId	string	yes	1–128 chars. Stable identifier for this trigger.
eventName	string	no	≤ 128 chars. The event name your application emits when the workflow should dispatch.
filters	object	no	Free-form filter map; consumed by your dispatch wrapper to decide whether to fire this trigger.

Triggers are descriptive metadata in v1 — the engine does not auto-dispatch from them. Use them to label which definition belongs to which application event so your own dispatcher can resolve eventName → definitionId.

tags · string[]

0–20 tags, each ≤ 64 chars.

custom · object

Free-form metadata.

organizationId · string

Required when scope.level is organization or document.

documentId · string

Required when scope.level is document.

Node object example

{
  "nodeId": "brand-check",
  "type": "agent",
  "name": "Brand check",
  "description": "Verifies copy against brand guidelines.",
  "config": { "agentId": "brand-agent-v1", "blocking": false, "requireNonEmptyOutput": true },
  "slaMs": 3600000
}

Edge object examples

{ "from": "brand-check", "to": "legal-review", "on": "approve" }
{ "from": "human-review", "to": "rework-notice", "on": "reject" }
{ "from": "human-review", "to": "agent-draft", "on": "reject", "loop": { "maxIterations": 3 } }
{ "from": "human-review", "to": "escalate", "on": "exhausted" }
{ "from": "brand-check", "to": "legal-review", "on": "custom", "when": "{\"op\":\"eq\",\"args\":[{\"var\":\"output.passesBrandCheck\"},true]}" }

Example Requests

Create a marketing-copy approval workflow

{
  "data": {
    "definitionId": "marketing-copy-approval",
    "name": "Marketing copy approval",
    "scope": { "level": "apiKey" },
    "nodes": [
      { "nodeId": "agent-draft",   "type": "agent", "config": { "agentId": "copy-agent-v1" } },
      { "nodeId": "human-review",  "type": "human", "config": { "reviewers": [{ "userId": "u_reviewer_01", "mandatory": true }] } },
      { "nodeId": "agent-publish", "type": "agent", "config": { "agentId": "publish-agent-v1" } },
      { "nodeId": "agent-rework",  "type": "agent", "config": { "agentId": "rework-agent-v1" } }
    ],
    "edges": [
      { "from": "agent-draft", "to": "human-review" },
      { "from": "human-review", "to": "agent-publish", "on": "approve" },
      { "from": "human-review", "to": "agent-rework", "on": "reject" }
    ]
  }
}

Response

Success Response

{
  "result": {
    "definitionId": "marketing-copy-approval",
    "name": "Marketing copy approval",
    "description": null,
    "version": 1,
    "scope": { "level": "apiKey", "organizationId": null, "documentId": null },
    "nodes": [
      { "nodeId": "agent-draft", "type": "agent", "config": { "agentId": "copy-agent-v1" } },
      { "nodeId": "human-review", "type": "human", "config": { "reviewers": [{ "userId": "u_reviewer_01", "mandatory": true }] } },
      { "nodeId": "agent-publish", "type": "agent", "config": { "agentId": "publish-agent-v1" } },
      { "nodeId": "agent-rework", "type": "agent", "config": { "agentId": "rework-agent-v1" } }
    ],
    "edges": [
      { "from": "agent-draft", "to": "human-review" },
      { "from": "human-review", "to": "agent-publish", "on": "approve" },
      { "from": "human-review", "to": "agent-rework", "on": "reject" }
    ],
    "groups": null,
    "compiled": {
      "forwardEdges": [
        { "from": "agent-draft", "to": "human-review", "role": "always", "when": null },
        { "from": "human-review", "to": "agent-publish", "role": "approve", "when": { "op": "eq", "args": [{ "var": "output.decision" }, "approve"] } },
        { "from": "human-review", "to": "agent-rework", "role": "reject", "when": { "op": "eq", "args": [{ "var": "output.decision" }, "reject"] } }
      ],
      "loops": []
    },
    "triggers": null,
    "tags": null,
    "custom": null,
    "createdAt": 1731432000000,
    "updatedAt": 1731432000000,
    "status": "active"
  }
}

The read-only compiled block is added to every DefinitionView (create / get / list). compiled.forwardEdges is the runtime forward-edge list the engine drives execution from; compiled.loops is the derived loop region list. The authored edges still echo sourceEdges byte-for-byte. See Get Definition for the full compiled schema.

Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

Errors: INVALID_ARGUMENT (schema, compileGraph, or linter failure; message includes the validation key) / ALREADY_EXISTS (definitionId already in use).

{
  "result": {
    "definitionId": "marketing-copy-approval",
    "name": "Marketing copy approval",
    "description": null,
    "version": 1,
    "scope": { "level": "apiKey", "organizationId": null, "documentId": null },
    "nodes": [
      { "nodeId": "agent-draft", "type": "agent", "config": { "agentId": "copy-agent-v1" } }
    ],
    "edges": [],
    "groups": null,
    "compiled": { "forwardEdges": [], "loops": [] },
    "triggers": null,
    "tags": null,
    "custom": null,
    "createdAt": 1731432000000,
    "updatedAt": 1731432000000,
    "status": "active"
  }
}