Skip to main content
POST
/
v2
/
workflow
/
definitions
/
create
Create Definition
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>"
  }
}
'
{
  "result": {
    "definitionId": "marketing-copy-approval",
    "name": "Marketing copy approval",
    "description": null,
    "version": 1,
    "scope": { "level": "apiKey", "organizationId": null, "documentId": null },
    "nodes": [],
    "edges": [],
    "groups": [],
    "triggers": null,
    "tags": null,
    "custom": null,
    "createdAt": 1731432000000,
    "updatedAt": 1731432000000,
    "status": "active"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.velt.dev/llms.txt

Use this file to discover all available pages before exploring further.

Use this API to register a new workflow definition (the static blueprint of nodes, edges, and optional parallel groups). Definitions are linted at write time — invalid graphs are rejected with an explicit linter code.

​
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

​
Node object example

{
  "nodeId": "brand-check",
  "type": "agent",
  "config": { "agentId": "brand-agent-v1", "blocking": false, "requireNonEmptyOutput": true },
  "slaMs": 3600000
}

​
Edge object example

{ "from": "brand-check", "to": "legal-review", "when": "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-legal",   "type": "human",  "config": { "reviewers": [{ "userId": "u_legal_01", "mandatory": true }] } },
      { "nodeId": "human-brand",   "type": "human",  "config": { "reviewers": [{ "userId": "u_brand_01", "mandatory": true }] } },
      { "nodeId": "agent-publish", "type": "agent",  "config": { "agentId": "publish-agent-v1" } }
    ],
    "edges": [
      { "from": "agent-draft",  "to": "human-legal" },
      { "from": "agent-draft",  "to": "human-brand" },
      { "from": "human-legal",  "to": "agent-publish" },
      { "from": "human-brand",  "to": "agent-publish" }
    ],
    "groups": [{
      "groupId": "parallel-review",
      "memberNodeIds": ["human-legal", "human-brand"],
      "expectedSteps": 2,
      "quorum": 2,
      "onQuorumMet": "joinOnQuorum"
    }]
  }
}

​
Response

​
Success Response

{
  "result": {
    "definitionId": "marketing-copy-approval",
    "name": "Marketing copy approval",
    "description": null,
    "version": 1,
    "scope": { "level": "apiKey", "organizationId": null, "documentId": null },
    "nodes": [ /* echoed back with resolved defaults */ ],
    "edges": [ /* echoed back with when: null for unset gates */ ],
    "groups": [ /* echoed back */ ],
    "triggers": null,
    "tags": null,
    "custom": null,
    "createdAt": 1731432000000,
    "updatedAt": 1731432000000,
    "status": "active"
  }
}

​
Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}
Errors: INVALID_ARGUMENT (schema or linter failure; message includes the linter code) / 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": [],
    "edges": [],
    "groups": [],
    "triggers": null,
    "tags": null,
    "custom": null,
    "createdAt": 1731432000000,
    "updatedAt": 1731432000000,
    "status": "active"
  }
}