Get Definition

POST /v2/workflow/definitions/get

Get Definition

cURL

curl --request POST \
  --url https://api.velt.dev/v2/workflow/definitions/get \
  --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>",
    "organizationId": "<string>",
    "documentId": "<string>"
  }
}
'

import requests

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

payload = { "data": {
        "definitionId": "<string>",
        "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>', organizationId: '<string>', documentId: '<string>'}
  })
};

fetch('https://api.velt.dev/v2/workflow/definitions/get', 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/get",
  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>',
        '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/get"

	payload := strings.NewReader("{\n  \"data\": {\n    \"definitionId\": \"<string>\",\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/get")
  .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    \"organizationId\": \"<string>\",\n    \"documentId\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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    \"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 fetch a workflow definition. Returns the full DefinitionView. Filters out tombstoned definitions.

Endpoint

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

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

The definition to fetch.

organizationId · string

Required when scoped to an organization or document.

documentId · string

Required when scoped to a document.

Example Requests

Get a definition

{
  "data": {
    "definitionId": "marketing-copy-approval"
  }
}

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 compiled block

compiled is a read-only block on every DefinitionView. The authored edges echo sourceEdges byte-for-byte; compiled is the server-derived runtime view used to drive execution. Both are additive — render a workflow graph directly from compiled.forwardEdges instead of re-implementing group expansion client-side.

compiled · object

Show properties

forwardEdges · array

The runtime forward-edge list. Group endpoints are expanded to per-member compiled edges and on roles are compiled to a predicate AST. Each entry:

Field	Type	Notes
from	string	Resolved node id.
to	string	Resolved node id.
role	approve / reject / always / exhausted / custom	The authored on role.
when	JsonAst | null	Deterministic predicate AST; null for always.
fromGroupId	string	Present when the authored from was a group.
toGroupId	string	Present when the authored to was a group.

loops · array

The server-derived loop regions. Each entry:

Field	Type	Notes
loopId	string	Stable identifier for the derived loop.
entryNodeId	string	Node re-entered on each iteration.
bodyNodeIds	string[]	Nodes inside the loop’s iteration scope.
maxIterations	number	Hard cap per execution (from the reject edge’s loop).
onExhausted	{ routeToNodeId: string } | null	Sibling on:"exhausted" target, or null.

Failure Response

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

Errors: NOT_FOUND (definition does not exist or is tombstoned) / INVALID_ARGUMENT.

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